@@ -26,6 +26,36 @@ def get_dataset_requirements(info: Dict[str, Any],
2626 exclude : Optional [Dict ] = None ,
2727 search_space_updates : Optional [HyperparameterSearchSpaceUpdates ] = None
2828 ) -> List [FitRequirement ]:
29+ """
30+
31+ This function is used to return the dataset
32+ property requirements which are needed to fit
33+ a pipeline created based on the constraints
34+ specified using include, exclude and
35+ search_space_updates
36+
37+ Args:
38+ info (Dict[str, Any]):
39+ A dictionary that specifies the required information
40+ about the dataset to instantiate a pipeline. For more
41+ info check the get_required_dataset_info of the
42+ appropriate dataset in autoPyTorch/datasets
43+ include (Optional[Dict]), (default=None):
44+ If None, all possible components are used.
45+ Otherwise specifies set of components to use.
46+ exclude (Optional[Dict]), (default=None):
47+ If None, all possible components are used.
48+ Otherwise specifies set of components not to use.
49+ Incompatible with include.
50+ search_space_updates (Optional[HyperparameterSearchSpaceUpdates]):
51+ search space updates that can be used to modify the search
52+ space of particular components or choice modules of the pipeline
53+
54+ Returns:
55+ List[FitRequirement]:
56+ List of requirements that should be in the fit
57+ dictionary used to fit the pipeline.
58+ """
2959 task_type : int = STRING_TO_TASK_TYPES [info ['task_type' ]]
3060 if task_type in REGRESSION_TASKS :
3161 return _get_regression_dataset_requirements (info ,
@@ -87,6 +117,33 @@ def get_configuration_space(info: Dict[str, Any],
87117 exclude : Optional [Dict ] = None ,
88118 search_space_updates : Optional [HyperparameterSearchSpaceUpdates ] = None
89119 ) -> ConfigurationSpace :
120+ """
121+
122+ This function is used to return the configuration
123+ space of the pipeline created based on the constraints
124+ specified using include, exclude and search_space_updates
125+
126+ Args:
127+ info (Dict[str, Any]):
128+ A dictionary that specifies the required information
129+ about the dataset to instantiate a pipeline. For more
130+ info check the get_required_dataset_info of the
131+ appropriate dataset in autoPyTorch/datasets
132+ include (Optional[Dict]), (default=None):
133+ If None, all possible components are used.
134+ Otherwise specifies set of components to use.
135+ exclude (Optional[Dict]), (default=None):
136+ If None, all possible components are used.
137+ Otherwise specifies set of components not to use.
138+ Incompatible with include.
139+ search_space_updates (Optional[HyperparameterSearchSpaceUpdates]):
140+ search space updates that can be used to modify the search
141+ space of particular components or choice modules of the pipeline
142+
143+ Returns:
144+ ConfigurationSpace
145+
146+ """
90147 task_type : int = STRING_TO_TASK_TYPES [info ['task_type' ]]
91148
92149 if task_type in REGRESSION_TASKS :
0 commit comments