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] documentation for pipelines and steps #329

Merged
merged 4 commits into from
Nov 18, 2021

Conversation

ravinkohli
Copy link
Contributor

Addresses #327

@codecov
Copy link

codecov bot commented Nov 15, 2021

Codecov Report

Merging #329 (88f0f25) into development (f6af46f) will decrease coverage by 0.22%.
The diff coverage is 100.00%.

Impacted file tree graph

@@               Coverage Diff               @@
##           development     #329      +/-   ##
===============================================
- Coverage        82.01%   81.79%   -0.23%     
===============================================
  Files              152      152              
  Lines             8674     8677       +3     
  Branches          1325     1325              
===============================================
- Hits              7114     7097      -17     
- Misses            1093     1113      +20     
  Partials           467      467              
Impacted Files Coverage Δ
autoPyTorch/api/tabular_classification.py 87.50% <ø> (ø)
autoPyTorch/api/tabular_regression.py 96.87% <ø> (ø)
autoPyTorch/pipeline/base_pipeline.py 71.57% <ø> (ø)
autoPyTorch/pipeline/components/base_choice.py 83.33% <ø> (ø)
autoPyTorch/pipeline/components/base_component.py 80.95% <ø> (-1.91%) ⬇️
autoPyTorch/pipeline/tabular_classification.py 74.57% <ø> (ø)
autoPyTorch/pipeline/tabular_regression.py 82.65% <ø> (ø)
...rch/pipeline/traditional_tabular_classification.py 73.68% <100.00%> (+0.35%) ⬆️
...PyTorch/pipeline/traditional_tabular_regression.py 28.33% <100.00%> (+2.47%) ⬆️
...eline/components/setup/optimizer/base_optimizer.py 71.42% <0.00%> (-19.05%) ⬇️
... and 13 more

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 f6af46f...88f0f25. Read the comment docs.

Copy link
Collaborator

@nabenabe0928 nabenabe0928 left a comment

Choose a reason for hiding this comment

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

Thanks for the PR.
Your changes look mostly good to me.

@@ -23,4 +23,48 @@ Regression

Copy link
Collaborator

Choose a reason for hiding this comment

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

What is this file for? I mean how I should read this doc?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So this file basically contains the API documentation for AutoPyTorch. If you would like to take a look, you can make the docs locally on your laptop and then browse the HTML.

You need to do

pip install -e .[doc,examples]
cd docs
make html

autoPyTorch/pipeline/traditional_tabular_regression.py Outdated Show resolved Hide resolved
autoPyTorch/pipeline/traditional_tabular_regression.py Outdated Show resolved Hide resolved
autoPyTorch/pipeline/tabular_regression.py Show resolved Hide resolved
autoPyTorch/pipeline/tabular_regression.py Outdated Show resolved Hide resolved
autoPyTorch/pipeline/tabular_classification.py Outdated Show resolved Hide resolved
autoPyTorch/pipeline/components/base_choice.py Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[ADD] Documentation to show more about pipeline, i.e, steps, choices and components
2 participants