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 data validation and preprocessing #323

Merged
merged 12 commits into from Nov 15, 2021

Conversation

ravinkohli
Copy link
Contributor

Addresses #319 .
Also, fixes formatting issues which were caused by improper indentation.

@codecov
Copy link

codecov bot commented Nov 11, 2021

Codecov Report

Merging #323 (cca30f7) into development (e493d99) will decrease coverage by 0.03%.
The diff coverage is n/a.

Impacted file tree graph

@@               Coverage Diff               @@
##           development     #323      +/-   ##
===============================================
- Coverage        82.01%   81.98%   -0.04%     
===============================================
  Files              151      152       +1     
  Lines             8652     8669      +17     
  Branches          1322     1325       +3     
===============================================
+ Hits              7096     7107      +11     
- Misses            1088     1094       +6     
  Partials           468      468              
Impacted Files Coverage Δ
autoPyTorch/api/base_task.py 84.63% <ø> (ø)
autoPyTorch/api/tabular_classification.py 87.50% <ø> (ø)
autoPyTorch/api/tabular_regression.py 96.87% <ø> (ø)
autoPyTorch/datasets/base_dataset.py 80.00% <ø> (ø)
autoPyTorch/datasets/image_dataset.py 31.25% <ø> (ø)
autoPyTorch/datasets/tabular_dataset.py 85.29% <ø> (ø)
autoPyTorch/optimizer/smbo.py 83.19% <ø> (ø)
...ml/traditional_learner/base_traditional_learner.py 94.80% <ø> (ø)
...Torch/pipeline/components/training/metrics/base.py 65.67% <ø> (ø)
autoPyTorch/utils/pipeline.py 72.72% <ø> (ø)
... and 6 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 e493d99...cca30f7. Read the comment docs.

Copy link
Contributor

@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.
I put comments except docs/manual.rst .

autoPyTorch/api/base_task.py Outdated Show resolved Hide resolved
autoPyTorch/api/base_task.py Outdated Show resolved Hide resolved
autoPyTorch/api/base_task.py Outdated Show resolved Hide resolved
autoPyTorch/api/base_task.py Outdated Show resolved Hide resolved
@nabenabe0928
Copy link
Contributor

docs/manual.rst looks good to me, so I will wait for your commits.

Co-authored-by: nabenabe0928 <47781922+nabenabe0928@users.noreply.github.com>
Copy link
Contributor

@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.

I think we can delete default?

You can check which file has (xxx), (default=xxx) by find -name "*.py" -exec grep ", (default" {} \; -print | grep "./".

I also found out that some of them have the default value of None while the typing says xxx, but not Optional[xxx].

autoPyTorch/api/base_task.py Outdated Show resolved Hide resolved
autoPyTorch/api/base_task.py Outdated Show resolved Hide resolved
autoPyTorch/api/base_task.py Outdated Show resolved Hide resolved
autoPyTorch/api/tabular_classification.py Outdated Show resolved Hide resolved
autoPyTorch/api/tabular_classification.py Outdated Show resolved Hide resolved
autoPyTorch/api/tabular_classification.py Outdated Show resolved Hide resolved
autoPyTorch/api/tabular_classification.py Outdated Show resolved Hide resolved
autoPyTorch/api/tabular_classification.py Outdated Show resolved Hide resolved
autoPyTorch/api/tabular_classification.py Outdated Show resolved Hide resolved
autoPyTorch/api/tabular_classification.py Outdated Show resolved Hide resolved
Co-authored-by: nabenabe0928 <47781922+nabenabe0928@users.noreply.github.com>
@ravinkohli
Copy link
Contributor Author

I think we can delete default?

You can check which file has (xxx), (default=xxx) by find -name "*.py" -exec grep ", (default" {} \; -print | grep "./".

I also found out that some of them have the default value of None while the typing says xxx, but not Optional[xxx].

I have unified the way we document types throughout the project. I have also fixed type information to Optional[type] where previously we had default=None. I think if there is any further change required, lets raise an issue for this and fix it in a different PR.

@nabenabe0928 nabenabe0928 merged commit f6af46f into automl:development Nov 15, 2021
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 about data validation and preprocessing steps in AutoPyTorch
2 participants