[doc] Add module descriptions and ToDos by nabenabe0928 · Pull Request #289 · automl/Auto-PyTorch

nabenabe0928 · 2021-09-15T11:19:55Z

No description provided.

…ilder.py

codecov · 2021-09-15T11:44:18Z

Codecov Report

Merging #289 (aeedc2f) into development (9002937) will not change coverage.
The diff coverage is n/a.

@@             Coverage Diff              @@
##           development     #289   +/-   ##
============================================
  Coverage        81.74%   81.74%           
============================================
  Files              151      151           
  Lines             8655     8655           
  Branches          1330     1330           
============================================
  Hits              7075     7075           
  Misses            1109     1109           
  Partials           471      471

Impacted Files	Coverage Δ
autoPyTorch/api/base_task.py	`84.46% <ø> (ø)`
autoPyTorch/constants.py	`100.00% <ø> (ø)`
autoPyTorch/data/base_feature_validator.py	`100.00% <ø> (ø)`
autoPyTorch/data/base_target_validator.py	`97.95% <ø> (ø)`
autoPyTorch/data/base_validator.py	`92.00% <ø> (ø)`
autoPyTorch/datasets/base_dataset.py	`80.00% <ø> (ø)`
autoPyTorch/datasets/resampling_strategy.py	`93.24% <ø> (ø)`
autoPyTorch/ensemble/abstract_ensemble.py	`88.88% <ø> (ø)`
autoPyTorch/ensemble/ensemble_builder.py	`73.16% <ø> (ø)`
autoPyTorch/ensemble/ensemble_selection.py	`95.78% <ø> (ø)`
... and 2 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 9002937...aeedc2f. Read the comment docs.

…bstract_evaluator.py

ravinkohli · 2021-11-11T10:58:53Z

autoPyTorch/api/base_task.py

@@ -1,3 +1,18 @@
+"""Base class for tasks to solve
+* The shared components among all the tasks


I think this is quite obvious, we don't need to mention it

ravinkohli

Thanks for this PR. I have suggested a few minor changes, other than that I think this can be merged.

ravinkohli · 2021-11-11T11:01:18Z

autoPyTorch/api/base_task.py

@@ -1,3 +1,18 @@
+"""Base class for tasks to solve
+* The shared components among all the tasks
+* This module provides the optimization given a pipeline


I think this line is a bit confusing. We can mention that it initiates HPO for the pipeline search space.

ravinkohli · 2021-11-11T11:01:40Z

autoPyTorch/api/base_task.py

+* This module provides the optimization given a pipeline
+* This module plays a role of communicating with
+  distributed clients
+


We can also mention that its the main API to interact with the user and fits the ensemble.

ravinkohli · 2021-11-11T11:02:48Z

autoPyTorch/data/base_feature_validator.py

@@ -1,3 +1,15 @@
+"""Base class for the feature validator given a task
+* A wrapper class of the sklearn.base.BaseEstimator
+* The feature validator for each task inherits this class


I think its again redundant.

ravinkohli · 2021-11-11T11:03:03Z

autoPyTorch/data/base_feature_validator.py

+"""Base class for the feature validator given a task
+* A wrapper class of the sklearn.base.BaseEstimator
+* The feature validator for each task inherits this class
+* Check if the provided feature can be processed in AutoPytorch


Suggested change

* Check if the provided feature can be processed in AutoPytorch

* Check if the provided train and test features can be processed in AutoPytorch

ravinkohli · 2021-11-11T11:03:17Z

autoPyTorch/data/base_feature_validator.py

+TODO:
+    * SUPPORTED_FEAT_TYPES --> Enumerator
+    * Describe the shape of X
+    * typing.<type> --> <type>


this is not done.

ravinkohli · 2021-11-11T11:03:37Z

autoPyTorch/data/base_target_validator.py

@@ -1,3 +1,19 @@
+"""Base class for the target (or label) validator given a task
+* A wrapper class of the sklearn.base.BaseEstimator
+* The target validator for each task inherits this class


again redundant.

ravinkohli · 2021-11-11T11:04:58Z

autoPyTorch/data/base_validator.py

+TODO:
+    * typing.<type> --> <type>
+    * logging.Logger --> Logger
+    * Inherit feature_validator and target_validator from a child class


what do you mean here?

ravinkohli · 2021-11-11T11:05:51Z

autoPyTorch/datasets/base_dataset.py

@@ -1,3 +1,19 @@
+"""Base class of the provided dataset
+* Provide data validation splits based on types of data


Suggested change

* Provide data validation splits based on types of data

* Provide data validation splits based on types of data and user's choice for example, holdout.

ravinkohli · 2021-11-11T11:08:28Z

autoPyTorch/ensemble/ensemble_selection.py

@@ -1,3 +1,26 @@
+"""The title of the module description  # noqa
+* Describe at the beginning of the source code.


I think this is template text. Maybe you have to update this?

nabenabe0928 added 7 commits September 14, 2021 09:28

[doc] Add module doc-string and TODOs to base_task.py

d5bdfd9

[doc] Add module doc-string and TODOs to base_feature_validator.py

13899df

[doc] Add module doc-string and TODOs to base_target_validator.py

f895745

[doc] Add module doc-string and TODOs to base_validator.py

f3282d9

[doc] Add module doc-string and TODOs to base_dataset.py

8f864e6

[doc] Add module doc-string and TODOs to resampling_strategy.py

f5765ba

[doc] Add module doc-string and TODOs to ensemble/ except ensemble_bu…

151055e

…ilder.py

nabenabe0928 added 2 commits September 16, 2021 09:54

[doc] Add module doc-string and TODOs to ensemble_builder.py

65bb672

[doc/WIP] Add module doc string and ToDos in autoPytorch/evaluation/a…

aeedc2f

…bstract_evaluator.py

ravinkohli self-requested a review November 11, 2021 10:57

ravinkohli reviewed Nov 11, 2021

View reviewed changes

ravinkohli suggested changes Nov 11, 2021

View reviewed changes

nabenabe0928 marked this pull request as draft November 11, 2021 15:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[doc] Add module descriptions and ToDos#289

[doc] Add module descriptions and ToDos#289
nabenabe0928 wants to merge 9 commits intoautoml:masterfrom
nabenabe0928:doc-add-module-descriptions

nabenabe0928 commented Sep 15, 2021

Uh oh!

codecov bot commented Sep 15, 2021 •

edited

Loading

Uh oh!

ravinkohli Nov 11, 2021

Uh oh!

ravinkohli left a comment

Uh oh!

ravinkohli Nov 11, 2021

Uh oh!

ravinkohli Nov 11, 2021

Uh oh!

ravinkohli Nov 11, 2021

Uh oh!

ravinkohli Nov 11, 2021

Uh oh!

ravinkohli Nov 11, 2021

Uh oh!

ravinkohli Nov 11, 2021

Uh oh!

ravinkohli Nov 11, 2021

Uh oh!

ravinkohli Nov 11, 2021

Uh oh!

ravinkohli Nov 11, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		@@ -1,3 +1,18 @@
		"""Base class for tasks to solve
		* The shared components among all the tasks

	* Check if the provided feature can be processed in AutoPytorch
	* Check if the provided train and test features can be processed in AutoPytorch

		@@ -1,3 +1,19 @@
		"""Base class of the provided dataset
		* Provide data validation splits based on types of data

		@@ -1,3 +1,26 @@
		"""The title of the module description # noqa
		* Describe at the beginning of the source code.

Conversation

nabenabe0928 commented Sep 15, 2021

Uh oh!

codecov bot commented Sep 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ravinkohli left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov bot commented Sep 15, 2021 •

edited

Loading