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

Add Class Imbalance data check to api docs #1190

Merged
merged 8 commits into from
Sep 18, 2020
Merged

Add Class Imbalance data check to api docs #1190

merged 8 commits into from
Sep 18, 2020

Conversation

bchen1116
Copy link
Contributor

Add class Imbalance Data check to the api documentation

@bchen1116 bchen1116 self-assigned this Sep 17, 2020
@codecov
Copy link

codecov bot commented Sep 17, 2020

Codecov Report

Merging #1190 into main will increase coverage by 0.18%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1190      +/-   ##
==========================================
+ Coverage   99.74%   99.92%   +0.18%     
==========================================
  Files         196      196              
  Lines       11977    11978       +1     
==========================================
+ Hits        11946    11969      +23     
+ Misses         31        9      -22     
Impacted Files Coverage Δ
evalml/data_checks/class_imbalance_data_check.py 100.00% <ø> (ø)
evalml/data_checks/__init__.py 100.00% <100.00%> (ø)
...lml/tests/model_understanding_tests/test_graphs.py 100.00% <0.00%> (+0.15%) ⬆️
evalml/automl/automl_search.py 99.58% <0.00%> (+0.41%) ⬆️
.../automl_tests/test_automl_search_classification.py 100.00% <0.00%> (+0.45%) ⬆️
evalml/tests/component_tests/test_components.py 100.00% <0.00%> (+0.69%) ⬆️
evalml/tests/pipeline_tests/test_pipelines.py 100.00% <0.00%> (+0.78%) ⬆️
...ests/automl_tests/test_automl_search_regression.py 100.00% <0.00%> (+1.06%) ⬆️
evalml/utils/gen_utils.py 99.02% <0.00%> (+1.94%) ⬆️
evalml/tests/component_tests/test_utils.py 100.00% <0.00%> (+3.57%) ⬆️
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f5c8bb2...ffad9e3. Read the comment docs.

Copy link
Collaborator

@jeremyliweishih jeremyliweishih left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM: you can view here.

Copy link
Contributor

@angela97lin angela97lin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but @bchen1116 can I make the suggestion that you update the docstring of the ClassImbalanceDataCheck to not start with "Classification problem," as to better match the other data checks?

@dsherry
Copy link
Contributor

dsherry commented Sep 17, 2020

@bchen1116 looks good! Please use a slightly more descriptive PR title, like "Add class imbalance data check to API ref". It makes it easier to understand what's in the PR quickly, and to search through old PRs / the logs.

@bchen1116 bchen1116 changed the title update api Add Class Imbalance data check to api docs Sep 18, 2020
@bchen1116 bchen1116 merged commit 1705370 into main Sep 18, 2020
@angela97lin angela97lin mentioned this pull request Sep 29, 2020
@freddyaboulton freddyaboulton deleted the bc_datacheck_api branch May 13, 2022 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants