[doc] Add module descriptions and ToDos #289
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
|
ravinkohli
reviewed
Nov 11, 2021
| @@ -1,3 +1,18 @@ | |||
| """Base class for tasks to solve | |||
| * The shared components among all the tasks | |||
There was a problem hiding this comment.
I think this is quite obvious, we don't need to mention it
ravinkohli
suggested changes
Nov 11, 2021
| @@ -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.
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.
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.
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.
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 |
| TODO: | ||
| * SUPPORTED_FEAT_TYPES --> Enumerator | ||
| * Describe the shape of X | ||
| * typing.<type> --> <type> |
| @@ -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 | |||
| TODO: | ||
| * typing.<type> --> <type> | ||
| * logging.Logger --> Logger | ||
| * Inherit feature_validator and target_validator from a child class |
| @@ -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.
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. |
| @@ -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.
I think this is template text. Maybe you have to update this?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.