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

Minor Documentation Changes for the API #1323

Merged
merged 2 commits into from Oct 21, 2020
Merged

Conversation

bchen1116
Copy link
Contributor

@bchen1116 bchen1116 commented Oct 20, 2020

Make minor documentation changes based on issues I found during the blitz

Reordered preprocessing API calls here
AutoMLSearch data_check_results docs here
number_of_features docs here

@bchen1116 bchen1116 self-assigned this Oct 20, 2020
@codecov
Copy link

codecov bot commented Oct 20, 2020

Codecov Report

Merging #1323 into main will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1323   +/-   ##
=======================================
  Coverage   99.94%   99.94%           
=======================================
  Files         213      213           
  Lines       13387    13387           
=======================================
  Hits        13379    13379           
  Misses          8        8           
Impacted Files Coverage Δ
evalml/automl/automl_search.py 99.59% <ø> (ø)
evalml/preprocessing/utils.py 100.00% <ø> (ø)

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 32a8b0c...9a03119. Read the comment docs.

@@ -238,13 +238,14 @@ def _validate_objective(self, objective):
if isinstance(objective, type):
if objective in non_core_objectives:
raise ValueError(f"{objective.name.lower()} is not allowed in AutoML! "
"Use evalml.objectives.utils.get_core_objective_names()"
"Use evalml.objectives.utils.get_core_objective_names() "
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed the spacing in this message

@@ -73,11 +73,10 @@ def split_data(X, y, regression=False, test_size=.2, random_state=None):


def number_of_features(dtypes):
"""Get the number of features for specific dtypes.
"""Get the number of features of each specific dtype in a DataFrame.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Wanted to clear up this description so users know that it takes in pd.DataFrame().dtypes

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.

Thanks! LGTM :)

Copy link
Contributor

@freddyaboulton freddyaboulton left a comment

Choose a reason for hiding this comment

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

Thanks @bchen1116 !

@bchen1116 bchen1116 merged commit d66d21a into main Oct 21, 2020
2 checks passed
@dsherry dsherry mentioned this pull request Oct 29, 2020
@freddyaboulton freddyaboulton deleted the bc_update_documentation branch May 13, 2022 14:58
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

3 participants