Skip to content

Commit 789ec37

Browse files
authored
Add missing arg to HyperparameterTuner docstring (aws#319)
1 parent 167ae8e commit 789ec37

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/sagemaker/tuner.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,10 @@ def fit(self, inputs, job_name=None, include_cls_metadata=True, **kwargs):
245245
246246
job_name (str): Tuning job name. If not specified, the tuner generates a default job name,
247247
based on the training image name and current timestamp.
248+
include_cls_metadata (bool): Whether or not the hyperparameter tuning job should include information about
249+
the estimator class (default: True). This information is passed as a hyperparameter, so if
250+
the algorithm you are using cannot handle unknown hyperparameters (e.g. an Amazon ML algorithm that
251+
does not have a custom estimator in the Python SDK), then set ``include_cls_metadata`` to ``False``.
248252
**kwargs: Other arguments needed for training. Please refer to the ``fit()`` method of the associated
249253
estimator to see what other arguments are needed.
250254
"""

0 commit comments

Comments
 (0)