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

Update docs to include AutoMLSearch callbacks #1577

Merged
merged 11 commits into from Dec 30, 2020
Merged

Conversation

angela97lin
Copy link
Contributor

@angela97lin angela97lin commented Dec 17, 2020

@angela97lin angela97lin added this to the December 2020 milestone Dec 17, 2020
@angela97lin angela97lin self-assigned this Dec 17, 2020
@codecov
Copy link

codecov bot commented Dec 17, 2020

Codecov Report

Merging #1577 (4ab7bfb) into main (171942e) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1577   +/-   ##
=======================================
  Coverage   100.0%   100.0%           
=======================================
  Files         240      240           
  Lines       18177    18177           
=======================================
  Hits        18169    18169           
  Misses          8        8           
Impacted Files Coverage Δ
evalml/automl/automl_search.py 99.7% <ø> (ø)

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 171942e...4ab7bfb. Read the comment docs.

Copy link
Contributor

@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.

Looks good! Can you add examples for these callbacks? I think it would be helpful for users since they need to define methods that take in certain dictionary formats etc.

Copy link
Contributor

@bchen1116 bchen1116 left a comment

Choose a reason for hiding this comment

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

LGTM! Agreed with Jeremy, it would be really helpful if you can include short examples for each so that users know what the expected format (and potentially expected output) looks like.

@angela97lin angela97lin merged commit bafd56d into main Dec 30, 2020
@angela97lin angela97lin deleted the 1407_callback_docs branch December 30, 2020 22:35
Copy link
Contributor

@dsherry dsherry left a comment

Choose a reason for hiding this comment

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

Looks great!

@bchen1116 bchen1116 mentioned this pull request Jan 26, 2021
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.

Update docs to include AutoMLSearch callbacks
4 participants