From 5a92eda6e68371fdb878282adcfe3bd3d0aa0f33 Mon Sep 17 00:00:00 2001 From: Karim Nakad Date: Thu, 5 Mar 2020 17:28:14 -0800 Subject: [PATCH 1/5] doc: improve docstring for tuner.best_estimator() --- src/sagemaker/tuner.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/src/sagemaker/tuner.py b/src/sagemaker/tuner.py index 825ac60b02..4f0d1d80ec 100644 --- a/src/sagemaker/tuner.py +++ b/src/sagemaker/tuner.py @@ -760,6 +760,19 @@ def best_estimator(self, best_training_job=None): be deployed to an Amazon SageMaker endpoint and return a ``sagemaker.RealTimePredictor`` object. + Args: + best_training_job (dict): dict: Dictionary containing "TrainingJobName" and + "TrainingJobDefinitionName". + Example: + { + "TrainingJobName": "my_training_job_name", + "TrainingJobDefinitionName": "my_training_job_definition_name" + } + + Returns: + sagemaker.estimator.EstimatorBase: The estimator that has the best training job + attached. + Raises: Exception: If there is no best training job available for the hyperparameter tuning job. """ From 8acb75c9c67d7261674a8cd0eca7f52d480c5b4a Mon Sep 17 00:00:00 2001 From: Karim Nakad Date: Thu, 5 Mar 2020 17:29:28 -0800 Subject: [PATCH 2/5] fix typo --- src/sagemaker/tuner.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/sagemaker/tuner.py b/src/sagemaker/tuner.py index 4f0d1d80ec..23cfc7e99b 100644 --- a/src/sagemaker/tuner.py +++ b/src/sagemaker/tuner.py @@ -761,7 +761,7 @@ def best_estimator(self, best_training_job=None): object. Args: - best_training_job (dict): dict: Dictionary containing "TrainingJobName" and + best_training_job (dict): Dictionary containing "TrainingJobName" and "TrainingJobDefinitionName". Example: { From e1f3f66e74a58dc74b78872e2e636015efc968b8 Mon Sep 17 00:00:00 2001 From: Karim Nakad Date: Fri, 6 Mar 2020 09:27:48 -0800 Subject: [PATCH 3/5] fix docstring layout --- src/sagemaker/tuner.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/sagemaker/tuner.py b/src/sagemaker/tuner.py index 23cfc7e99b..be379142d0 100644 --- a/src/sagemaker/tuner.py +++ b/src/sagemaker/tuner.py @@ -763,10 +763,15 @@ def best_estimator(self, best_training_job=None): Args: best_training_job (dict): Dictionary containing "TrainingJobName" and "TrainingJobDefinitionName". + Example: + { + "TrainingJobName": "my_training_job_name", + "TrainingJobDefinitionName": "my_training_job_definition_name" + } Returns: From e68938dce43c4f65368b3f95cd0ae8ae2c2c835c Mon Sep 17 00:00:00 2001 From: Karim Nakad Date: Fri, 6 Mar 2020 09:41:37 -0800 Subject: [PATCH 4/5] fix docstring layout. take 2 --- src/sagemaker/tuner.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/sagemaker/tuner.py b/src/sagemaker/tuner.py index be379142d0..40baac69a8 100644 --- a/src/sagemaker/tuner.py +++ b/src/sagemaker/tuner.py @@ -766,13 +766,15 @@ def best_estimator(self, best_training_job=None): Example: - { + .. code:: python - "TrainingJobName": "my_training_job_name", + { - "TrainingJobDefinitionName": "my_training_job_definition_name" + "TrainingJobName": "my_training_job_name", - } + "TrainingJobDefinitionName": "my_training_job_definition_name" + + } Returns: sagemaker.estimator.EstimatorBase: The estimator that has the best training job From d6e941353fb0d148ad06cf203739b9286040e1c7 Mon Sep 17 00:00:00 2001 From: Karim Nakad Date: Fri, 6 Mar 2020 09:52:40 -0800 Subject: [PATCH 5/5] fix docstring layout. take 3 --- src/sagemaker/tuner.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/sagemaker/tuner.py b/src/sagemaker/tuner.py index 40baac69a8..164b06ae71 100644 --- a/src/sagemaker/tuner.py +++ b/src/sagemaker/tuner.py @@ -769,11 +769,8 @@ def best_estimator(self, best_training_job=None): .. code:: python { - "TrainingJobName": "my_training_job_name", - "TrainingJobDefinitionName": "my_training_job_definition_name" - } Returns: