Skip to content

Commit 5a92eda

Browse files
committed
doc: improve docstring for tuner.best_estimator()
1 parent af09859 commit 5a92eda

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

src/sagemaker/tuner.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -760,6 +760,19 @@ def best_estimator(self, best_training_job=None):
760760
be deployed to an Amazon SageMaker endpoint and return a ``sagemaker.RealTimePredictor``
761761
object.
762762
763+
Args:
764+
best_training_job (dict): dict: Dictionary containing "TrainingJobName" and
765+
"TrainingJobDefinitionName".
766+
Example:
767+
{
768+
"TrainingJobName": "my_training_job_name",
769+
"TrainingJobDefinitionName": "my_training_job_definition_name"
770+
}
771+
772+
Returns:
773+
sagemaker.estimator.EstimatorBase: The estimator that has the best training job
774+
attached.
775+
763776
Raises:
764777
Exception: If there is no best training job available for the hyperparameter tuning job.
765778
"""

0 commit comments

Comments
 (0)