Edit components API to match other modules

[jeremyliweishih]

Fixes #742.

[codecov]

Codecov Report

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

@@           Coverage Diff           @@
##           master     #747   +/-   ##
=======================================
  Coverage   99.34%   99.34%           
=======================================
  Files         148      148           
  Lines        5175     5175           
=======================================
  Hits         5141     5141           
  Misses         34       34           

Impacted Files	Coverage Δ
evalml/pipelines/components/component_base.py	94.11% <ø> (ø)

---

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 c6f3858...e8a30b8. Read the comment docs.

[jeremyliweishih]

I removed all the subheadings because I thought they were unnecessary and cluttered the API reference.

[dsherry]

Got it. I know this was added recently; I could see both sides. But I think what you've got here is good. We don't offer any one-sentence summaries elsewhere in the API doc. And right now, we don't have a ton of components, so perhaps the extra level of organization is unnecessary as you said. If we add enough components to warrant further editing here, I'll be pretty excited! 😂

[kmax12]

i personally really liked the added info and structure, but we can add it back later once we have more components since it does feel a little empty with just one component per category.

I like it because it makes the api reference slightly more educational

[jeremyliweishih]

If we're thinking of adding them back later might be prudent just to keep them there so we don't have to recreate the work! Mainly just thought it looked weird cause there were a lot of text for one class and it wasn't done anywhere else.

[dsherry]

Hmm, good point @kmax12 . Perhaps we can find middle ground.

I'd advocate for deleting the categorization of components by type, but still keeping the high-level headings and one-sentence summaries.

So, to be specific:

• "Component Base Classes" section with ComponentBase, Transformer and Estimator, and with a one-sentence description of what components are.
• "Transformers" section with a one-sentence description of what transformers are.
• "Estimators" section with "Classifiers" and "Regressors" sub-sections, and a one-sentence description for each of those.

@jeremyliweishih does that sound good to you too?

[dsherry]

Can we list Transformer and Estimator here too?

[dsherry]

Nice

[dsherry]

LGTM! I do have one request: I think we should list Transformer and Estimatorunder theComponent Base Classes` heading.

[dsherry]

@jeremyliweishih : RTD failed with this:

Warning, treated as error:
/home/docs/checkouts/readthedocs.org/user_builds/feature-labs-inc-evalml/envs/js_742_api/lib/python3.7/site-packages/evalml/pipelines/components/estimators/estimator.py:docstring of evalml.pipelines.components.Estimator.name:12:Unexpected indentation.

Oh, and now I see build_docs failed too. Cool, lol

[jeremyliweishih]

@dsherry yeah! Trying to fix it.

[jeremyliweishih]

@dsherry I added to the descriptions. Lmk what you think!

[dsherry]

@jeremyliweishih looks great! I left some suggested tweaks.