Updates to API doc #688
Updates to API doc #688
Conversation
dsherry
force-pushed
the
ds_update_pipeline_api_doc
branch
from
0951a8c
to
60140c5
Compare
| @@ -30,7 +30,7 @@ Preprocessing | |||
| split_data | |||
|
|
|||
|
|
|||
| .. currentmodule:: evalml | |||
| .. currentmodule:: evalml.automl | |||
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
All I changed was adding the word "Pipelines" here and for regression. Otherwise these changes should all be from moving
Codecov Report
@@ 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.
|
There was a problem hiding this 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)
docs/source/api_reference.rst
Outdated
| .. currentmodule:: evalml.objectives | ||
|
|
||
| Plot Metrics | ||
| ~~~~~~~~~~~~ |
There was a problem hiding this comment.
Should use "============"?
There was a problem hiding this comment.
Might not matter - we had that before as well.
There was a problem hiding this comment.
It matters in terms on how big the headings are; they have to be consistent!
There was a problem hiding this comment.
Yep, I see that now. Thanks!
|
@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... |
@angela97lin just added titles to the components and while reviewing that I thought of some other changes which would help.
Changes to API ref: