@@ -84,7 +84,7 @@ def remote(
8484):
8585 """Decorator for running the annotated function as a SageMaker training job.
8686
87- This decorator wraps the annotated code and runs it is a new SageMaker job synchronously
87+ This decorator wraps the annotated code and runs it as a new SageMaker job synchronously
8888 with the provided runtime settings.
8989
9090 Unless mentioned otherwise, the decorator first looks up the value from the SageMaker
@@ -187,8 +187,7 @@ def remote(
187187 instance_count (int): The number of instance to use. Defaults to 1.
188188
189189 instance_type (str): The Amazon Elastic Compute Cloud (EC2) instance type to use to run
190- the SageMaker job. Valid values include ml.c4.xlarge. If not provided, ValueError is
191- thrown.
190+ the SageMaker job. e.g. ml.c4.xlarge. If not provided, ValueError is thrown.
192191
193192 job_conda_env (str): The name of the conda environment to activate during job's runtime.
194193 Defaults to ``None``.
@@ -204,12 +203,12 @@ def remote(
204203 latency than over using SageMaker managed warm pools alone by caching the package source
205204 downloaded in the previous runs.
206205
207- max_retry_attempts (int): The max number of times the job is retried after an on
208- ```InternalServerFailure``` Error. Defaults to 1.
206+ max_retry_attempts (int): The max number of times the job is retried on
207+ ```InternalServerFailure``` Error from SageMaker service . Defaults to 1.
209208
210209 max_runtime_in_seconds (int): The upper limit in seconds to be used for training. After
211210 this specified amount of time, SageMaker terminates the job regardless of its current
212- status. The max_run_duration time defaults to 1 day or (86400 seconds).
211+ status. Defaults to 1 day or (86400 seconds).
213212
214213 role (str): The IAM role (either name or full ARN) used to run your SageMaker training
215214 job. Defaults to:
@@ -220,7 +219,7 @@ def remote(
220219
221220 s3_kms_key (str): The key used to encrypt the input and output data. Default to ``None``.
222221
223- s3_root_uri (str): The root S3 folder to which where the code archives and data are
222+ s3_root_uri (str): The root S3 folder to which the code archives and data are
224223 uploaded to. Defaults to ``s3://<sagemaker-default-bucket>``.
225224
226225 sagemaker_session (sagemaker.session.Session): The underlying SageMaker session to which
@@ -577,8 +576,7 @@ def __init__(
577576 instance_count (int): The number of instance to use. Defaults to 1.
578577
579578 instance_type (str): The Amazon Elastic Compute Cloud (EC2) instance type to use to run
580- the SageMaker job. Valid values include ml.c4.xlarge. If not provided, ValueError is
581- thrown.
579+ the SageMaker job. e.g. ml.c4.xlarge. If not provided, ValueError is thrown.
582580
583581 job_conda_env (str): The name of the conda environment to activate during job's runtime.
584582 Defaults to ``None``.
@@ -596,12 +594,12 @@ def __init__(
596594
597595 max_parallel_jobs (int): Maximum number of jobs that run in parallel. Defaults to 1.
598596
599- max_retry_attempts (int): The max number of times the job is retried after an on
600- ```InternalServerFailure``` Error. Defaults to 1.
597+ max_retry_attempts (int): The max number of times the job is retried on
598+ ```InternalServerFailure``` Error from SageMaker service . Defaults to 1.
601599
602600 max_runtime_in_seconds (int): The upper limit in seconds to be used for training. After
603601 this specified amount of time, SageMaker terminates the job regardless of its current
604- status. The max_run_duration time defaults to 1 day or (86400 seconds).
602+ status. Defaults to 1 day or (86400 seconds).
605603
606604 role (str): The IAM role (either name or full ARN) used to run your SageMaker training
607605 job. Defaults to:
@@ -613,7 +611,7 @@ def __init__(
613611 s3_kms_key (str): The key used to encrypt the input and output data.
614612 Default to ``None``.
615613
616- s3_root_uri (str): The root S3 folder to which where the code archives and data are
614+ s3_root_uri (str): The root S3 folder to which the code archives and data are
617615 uploaded to. Defaults to ``s3://<sagemaker-default-bucket>``.
618616
619617 sagemaker_session (sagemaker.session.Session): The underlying SageMaker session to which
@@ -1011,7 +1009,7 @@ def wait(
10111009 will block until the job is completed.
10121010
10131011 Args:
1014- timeout (int): Timeout in seconds to wait for until the job is to completed before it is
1012+ timeout (int): Timeout in seconds to wait for until the job is completed before it is
10151013 stopped. Defaults to ``None``.
10161014
10171015 Returns: None
0 commit comments