Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Function summarize test suite #25

Open
HrayrMuradyan opened this issue Jan 14, 2025 · 1 comment
Open

Function summarize test suite #25

HrayrMuradyan opened this issue Jan 14, 2025 · 1 comment
Assignees
Labels
planning Includes tasks related to brainstorming, deciding project scope, and high-level planning
Milestone

Comments

@HrayrMuradyan
Copy link
Collaborator

Plan the summarize function test suite.

@HrayrMuradyan HrayrMuradyan added the planning Includes tasks related to brainstorming, deciding project scope, and high-level planning label Jan 14, 2025
@HrayrMuradyan HrayrMuradyan self-assigned this Jan 14, 2025
@HrayrMuradyan HrayrMuradyan added this to the Milesone 2 milestone Jan 14, 2025
@HrayrMuradyan HrayrMuradyan moved this from Ready to In progress in @summarease-project-board Jan 14, 2025
@HrayrMuradyan
Copy link
Collaborator Author

HrayrMuradyan commented Jan 14, 2025

Input tests:

dataset:

  • Should be a valid dataframe (pd.Dataframe object).
  • dataset should not be empty
  • dataset shouldn't contain too many observations and too many columns (There should a limit for both)

dataset_name:

  • should be text
  • shouldn't be too long (a threshold should be assigned)

description:

  • should be text

show_observations:

  • should be string. Either "random", "head" or "tail".

show_n_observations:

  • should be an integer. Bounded between 0 and the dataset length.

show_warnings:

  • should be boolean

summarize_by:

  • string with the following values: "table", "plot", "mix"

auto_cleaning:

  • boolean

target_variable:

  • string, should be present in the dataset.

output_file:

  • string. Can contain .pdf and can omit it.

output_dir:

  • string. If doesn't exist, create it.

Output tests:

  • Check if the output was created
  • Check if the output has .pdf format
  • Check if the output was generated in the correct path
  • Check if the output is readable

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
planning Includes tasks related to brainstorming, deciding project scope, and high-level planning
Projects
Status: In progress
Development

No branches or pull requests

1 participant