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 pipeline properties to API reference #1209

Merged
merged 12 commits into from
Sep 23, 2020
Merged

Conversation

angela97lin
Copy link
Contributor

@angela97lin angela97lin commented Sep 22, 2020

Closes #1198

Updated docs here: https://evalml.alteryx.com/en/1198_classes_attr_docs/api_reference.html#pipelines

Specifically for #1198 here but I figured it would be good to expose some other attributes as well, so I made a new template for pipeline base classes. I also updated threshold for BinaryClassificationPipeline to be a property so that we can expose the docstring there.

@angela97lin angela97lin self-assigned this Sep 22, 2020
@codecov
Copy link

codecov bot commented Sep 22, 2020

Codecov Report

Merging #1209 into main will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1209   +/-   ##
=======================================
  Coverage   99.92%   99.92%           
=======================================
  Files         196      196           
  Lines       12007    12013    +6     
=======================================
+ Hits        11998    12004    +6     
  Misses          9        9           
Impacted Files Coverage Δ
evalml/pipelines/pipeline_base.py 100.00% <ø> (ø)
evalml/pipelines/binary_classification_pipeline.py 100.00% <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 49b9483...646fbd6. Read the comment docs.

@angela97lin angela97lin marked this pull request as ready for review September 22, 2020 22:11
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.

looks good to me!

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.

@angela97lin The new template looks awesome! The docstring for feature_importance is weird though:

image

I think we should fix in this PR or file an issue to fix it later.

@angela97lin
Copy link
Contributor Author

@freddyaboulton Woah, you're right, weird indeed. I've filed #1213 to track updating feature_importance :D

@angela97lin angela97lin merged commit d754a6a into main Sep 23, 2020
@angela97lin angela97lin deleted the 1198_classes_attr_docs branch September 23, 2020 17:33
@angela97lin angela97lin added this to the September 2020 milestone Sep 28, 2020
@angela97lin angela97lin mentioned this pull request Sep 29, 2020
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.

ClassificationPipeline.classes_ attribute doesn't appear in the API ref
3 participants