Skip to content

Commit 0e10461

Browse files
authored
doc: improve docstring for tuner.best_estimator() (#1331)
1 parent af09859 commit 0e10461

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

src/sagemaker/tuner.py

+17
Original file line numberDiff line numberDiff line change
@@ -760,6 +760,23 @@ 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): Dictionary containing "TrainingJobName" and
765+
"TrainingJobDefinitionName".
766+
767+
Example:
768+
769+
.. code:: python
770+
771+
{
772+
"TrainingJobName": "my_training_job_name",
773+
"TrainingJobDefinitionName": "my_training_job_definition_name"
774+
}
775+
776+
Returns:
777+
sagemaker.estimator.EstimatorBase: The estimator that has the best training job
778+
attached.
779+
763780
Raises:
764781
Exception: If there is no best training job available for the hyperparameter tuning job.
765782
"""

0 commit comments

Comments
 (0)