- Notifications
You must be signed in to change notification settings - Fork302
[doc] Add module descriptions and ToDos#289
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:master
Are you sure you want to change the base?
Uh oh!
There was an error while loading.Please reload this page.
Conversation
codecovbot commentedSep 15, 2021 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Codecov Report
@@ 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
Continue to review full report at Codecov.
|
| @@ -1,3 +1,18 @@ | |||
| """Base class for tasks to solve | |||
| * The shared components among all the tasks | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I think this is quite obvious, we don't need to mention it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Thanks for this PR. I have suggested a few minor changes, other than that I think this can be merged.
| @@ -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 | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I think this line is a bit confusing. We can mention that it initiates HPO for the pipeline search space.
| * This module provides the optimization given a pipeline | ||
| * This module plays a role of communicating with | ||
| distributed clients | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
We can also mention that its the main API to interact with the user and fits the ensemble.
| @@ -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 | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I think its again redundant.
| """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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| *CheckiftheprovidedfeaturecanbeprocessedinAutoPytorch | |
| *CheckiftheprovidedtrainandtestfeaturescanbeprocessedinAutoPytorch |
| TODO: | ||
| * SUPPORTED_FEAT_TYPES --> Enumerator | ||
| * Describe the shape of X | ||
| * typing.<type> --> <type> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
this is not done.
| @@ -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 | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
again redundant.
| TODO: | ||
| * typing.<type> --> <type> | ||
| * logging.Logger --> Logger | ||
| * Inherit feature_validator and target_validator from a child class |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
what do you mean here?
| @@ -1,3 +1,19 @@ | |||
| """Base class of the provided dataset | |||
| * Provide data validation splits based on types of data | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| *Providedatavalidationsplitsbasedontypesofdata | |
| *Providedatavalidationsplitsbasedontypesofdataanduser'schoiceforexample,holdout. |
| @@ -1,3 +1,26 @@ | |||
| """The title of the module description # noqa | |||
| * Describe at the beginning of the source code. | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I think this is template text. Maybe you have to update this?
No description provided.