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

Updates to API doc #688

Merged
merged 8 commits into from Apr 22, 2020
Merged

Updates to API doc #688

merged 8 commits into from Apr 22, 2020

Conversation

dsherry
Copy link
Collaborator

@dsherry dsherry commented Apr 22, 2020

@angela97lin just added titles to the components and while reviewing that I thought of some other changes which would help.

Changes to API ref:

  • Add the word "Pipelines" to the sub-headings in the pipeline section
  • Same for objectives
  • Reorder API ref: demo data, preprocessing, automl, pipelines, components, objectives, problem types, model family, tuners, guardrails, plot metrics, utils

@dsherry dsherry force-pushed the ds_update_pipeline_api_doc branch from 0951a8c to 60140c5 Compare Apr 22, 2020
@@ -30,7 +30,7 @@ Preprocessing
split_data


.. currentmodule:: evalml
.. currentmodule:: evalml.automl
Copy link
Collaborator Author

@dsherry dsherry Apr 22, 2020

Choose a reason for hiding this comment

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

I don't think this is necessary, since we import the automl classes in evalml/__init__.py, but it's nice to be consistent with the other usages in this file

MulticlassClassificationPipeline
RegressionPipeline

Classification Pipelines
Copy link
Collaborator Author

@dsherry dsherry Apr 22, 2020

Choose a reason for hiding this comment

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

All I changed was adding the word "Pipelines" here and for regression. Otherwise these changes should all be from moving

@dsherry dsherry changed the title Tweaking API doc Updates to API doc Apr 22, 2020
@codecov
Copy link

codecov bot commented Apr 22, 2020

Codecov Report

Merging #688 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #688   +/-   ##
=======================================
  Coverage   99.09%   99.09%           
=======================================
  Files         139      139           
  Lines        4953     4953           
=======================================
  Hits         4908     4908           
  Misses         45       45           

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 b9da0a4...2f63c2e. Read the comment docs.

@dsherry dsherry marked this pull request as ready for review Apr 22, 2020
Copy link
Contributor

@angela97lin angela97lin left a comment

LGTM here (https://evalml.featurelabs.com/en/ds_update_pipeline_api_doc/api_reference.html)! I'm not sure what the python 3.7 failure is about though, and the build docs seem to have failed (I triggered a build after)

.. currentmodule:: evalml.objectives

Plot Metrics
~~~~~~~~~~~~
Copy link
Contributor

@angela97lin angela97lin Apr 22, 2020

Choose a reason for hiding this comment

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

Should use "============"?

Copy link
Contributor

@jeremyliweishih jeremyliweishih Apr 22, 2020

Choose a reason for hiding this comment

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

Might not matter - we had that before as well.

Copy link
Contributor

@angela97lin angela97lin Apr 22, 2020

Choose a reason for hiding this comment

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

It matters in terms on how big the headings are; they have to be consistent!

image

Copy link
Contributor

@jeremyliweishih jeremyliweishih Apr 22, 2020

Choose a reason for hiding this comment

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

ooh - got it!

Copy link
Collaborator Author

@dsherry dsherry Apr 22, 2020

Choose a reason for hiding this comment

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

Yep, I see that now. Thanks!

Copy link
Contributor

@jeremyliweishih jeremyliweishih left a comment

LGTM. I retriggered the 3.7 test - I've seen this happen before and re running tests usually fixes it.

@dsherry
Copy link
Collaborator Author

dsherry commented Apr 22, 2020

@jeremyliweishih thanks. Yeah, something's been going on with the checkin jobs lately. I've noticed some random timeouts. I suspect it's a circleci issue...

@dsherry dsherry merged commit b3b2c42 into master Apr 22, 2020
2 checks passed
@dsherry dsherry deleted the ds_update_pipeline_api_doc branch Apr 22, 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.

None yet

3 participants