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.

Sign up for GitHub

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

Jump to bottom

Update Docs to Show Attributes #1673

Merged
merged 28 commits into from
Jan 20, 2021
Merged

Update Docs to Show Attributes #1673

merged 28 commits into from
Jan 20, 2021

Conversation

ParthivNaresh
Copy link
Contributor

@ParthivNaresh ParthivNaresh commented Jan 9, 2021 •
edited
Loading

Fixes #1653

@ParthivNaresh ParthivNaresh self-assigned this Jan 9, 2021
@ParthivNaresh ParthivNaresh changed the title 1653 update docs to show attributes Update Docs to Show Attributes Jan 9, 2021
@codecov
Copy link

codecov bot commented Jan 9, 2021 •
edited
Loading

Codecov Report

Merging #1673 (bc4cc41) into main (1a7244d) will increase coverage by 0.1%.
The diff coverage is 100.0%.

Impacted file tree graph

@@            Coverage Diff            @@
##             main    #1673     +/-   ##
=========================================
+ Coverage   100.0%   100.0%   +0.1%     
=========================================
  Files         242      242             
  Lines       19072    19075      +3     
=========================================
+ Hits        19064    19067      +3     
  Misses          8        8
Impacted Files Coverage Δ
...alml/objectives/binary_classification_objective.py 100.0% <ø> (ø)
.../objectives/multiclass_classification_objective.py 100.0% <ø> (ø)
evalml/objectives/regression_objective.py 100.0% <ø> (ø)
...lml/objectives/time_series_regression_objective.py 100.0% <ø> (ø)
evalml/objectives/objective_base.py 100.0% <100.0%> (ø)
evalml/objectives/standard_metrics.py 100.0% <100.0%> (ø)
...valml/pipelines/components/estimators/estimator.py 100.0% <100.0%> (ø)

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 1a7244d...bc4cc41. Read the comment docs.

@ParthivNaresh ParthivNaresh marked this pull request as ready for review January 14, 2021 17:14
bchen1116
bchen1116 approved these changes Jan 14, 2021
View reviewed changes
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.

This is what the objectiveBase docs look like, and componentBase is here

Docs definitely look better! Left a few comments on improvements, but otherwise looks good to me!

docs/source/api_reference.rst
PipelineNotFoundError
ObjectiveNotFoundError
IllFormattedClassNameError
MissingComponentError
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice! nit-pick: Is it possible to fix some of the formatting of the docstrings in these exceptions? Ie all_components() here:
image

docs/source/conf.py Show resolved Hide resolved
evalml/objectives/binary_classification_objective.py Show resolved Hide resolved
evalml/pipelines/components/estimators/estimator.py Show resolved Hide resolved
freddyaboulton
freddyaboulton approved these changes Jan 14, 2021
View reviewed changes
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.

@ParthivNaresh Looks great to me!

docs/source/_templates/objective_class.rst Outdated
.. currentmodule:: {{ module }}

.. autoclass:: {{ objname }}
{% set class_attributes = ['name', 'greater_is_better', 'perfect_score', 'positive_only', 'problem_types',
Copy link
Contributor

Choose a reason for hiding this comment

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

How come we need to set class_attributes here if we're going to manually add them one-by-one below?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You're right, it's absolutely unnecessary, let me remove it!

@ParthivNaresh ParthivNaresh linked an issue Jan 14, 2021 that may be closed by this pull request
API ref: Expose base objective class attributes #738
Closed
@ParthivNaresh ParthivNaresh merged commit 87d50ff into main Jan 20, 2021
@bchen1116 bchen1116 mentioned this pull request Jan 26, 2021
Merged
@freddyaboulton freddyaboulton deleted the 1653-Update-Docs-To-Show-Attributes branch May 13, 2022 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bchen1116 bchen1116 bchen1116 approved these changes

@freddyaboulton freddyaboulton freddyaboulton approved these changes

@chukarsten chukarsten chukarsten approved these changes

@dsherry dsherry Awaiting requested review from dsherry

@angela97lin angela97lin Awaiting requested review from angela97lin

Assignees

@ParthivNaresh ParthivNaresh

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs failing to reflect attributes API ref: Expose base objective class attributes
4 participants
@ParthivNaresh @bchen1116 @freddyaboulton @chukarsten