@@ -132,7 +132,7 @@ def remote(
132
132
in the system path.
133
133
134
134
* The parameter dependencies is set to auto_capture. SageMaker will automatically
135
- generate a env_snapshot.yml corresponding to the current active conda environment’s
135
+ generate an env_snapshot.yml corresponding to the current active conda environment’s
136
136
snapshot. You do not need to provide a dependencies file. The following conditions
137
137
apply:
138
138
@@ -173,9 +173,9 @@ def remote(
173
173
Amazon Elastic Container Registry (ECR). Defaults to the following based on where the SDK
174
174
is running:
175
175
176
- * For SageMaker Studio notebook cases , the image used as the kernel image for the
176
+ * For users on SageMaker Studio notebooks , the image used as the kernel image for the
177
177
notebook is used.
178
- * For other cases , it is resolved to base python image with the same python version
178
+ * For other users , it is resolved to base python image with the same python version
179
179
as the environment running the local code.
180
180
181
181
If no compatible image is found, a ValueError is thrown.
@@ -184,7 +184,7 @@ def remote(
184
184
local directories. Set to ``True`` if the remote function code imports local modules and
185
185
methods that are not available via PyPI or conda. Default value is ``False``.
186
186
187
- instance_count (int): The number of instance to use. Defaults to 1.
187
+ instance_count (int): The number of instances to use. Defaults to 1.
188
188
189
189
instance_type (str): The Amazon Elastic Compute Cloud (EC2) instance type to use to run
190
190
the SageMaker job. e.g. ml.c4.xlarge. If not provided, ValueError is thrown.
@@ -199,7 +199,7 @@ def remote(
199
199
warm pools. The use of warmpools reduces the latency time spent to provision new
200
200
resources. The default value for ``keep_alive_period_in_seconds`` is 0.
201
201
NOTE: Additional charges associated with warm pools may apply. Using this parameter will
202
- also activate a new persistent cache feature, which will further reduce job start up
202
+ also activate a new Persistent Cache feature, which will further reduce job start up
203
203
latency than over using SageMaker managed warm pools alone by caching the package source
204
204
downloaded in the previous runs.
205
205
@@ -521,7 +521,7 @@ def __init__(
521
521
in the system path.
522
522
523
523
* The parameter dependencies is set to auto_capture. SageMaker will automatically
524
- generate a env_snapshot.yml corresponding to the current active conda environment’s
524
+ generate an env_snapshot.yml corresponding to the current active conda environment’s
525
525
snapshot. You do not need to provide a dependencies file. The following conditions
526
526
apply:
527
527
@@ -562,9 +562,9 @@ def __init__(
562
562
Amazon Elastic Container Registry (ECR). Defaults to the following based on where the
563
563
SDK is running:
564
564
565
- * For SageMaker Studio notebook cases , the image used as the kernel image for the
566
- notebook is used.
567
- * For other cases , it is resolved to base python image with the same python
565
+ * For users on SageMaker Studio notebooks , the image used as the kernel image for
566
+ the notebook is used.
567
+ * For other users , it is resolved to base python image with the same python
568
568
version as the environment running the local code.
569
569
570
570
If no compatible image is found, a ValueError is thrown.
@@ -573,7 +573,7 @@ def __init__(
573
573
local directories. Set to ``True`` if the remote function code imports local modules
574
574
and methods that are not available via PyPI or conda. Default value is ``False``.
575
575
576
- instance_count (int): The number of instance to use. Defaults to 1.
576
+ instance_count (int): The number of instances to use. Defaults to 1.
577
577
578
578
instance_type (str): The Amazon Elastic Compute Cloud (EC2) instance type to use to run
579
579
the SageMaker job. e.g. ml.c4.xlarge. If not provided, ValueError is thrown.
@@ -820,7 +820,7 @@ def _validate_submit_args(func, *args, **kwargs):
820
820
class Future (object ):
821
821
"""Class representing a reference to a SageMaker job result.
822
822
823
- Reference to the SageMaker job created as a result of the remote function execution . The job may
823
+ Reference to the SageMaker job created as a result of the remote function run . The job may
824
824
or may not have finished running.
825
825
"""
826
826
@@ -931,7 +931,7 @@ def result(self, timeout: float = None) -> Any:
931
931
default.
932
932
933
933
Returns:
934
- The Python object returned by the remote function execution .
934
+ The Python object returned by the remote function.
935
935
"""
936
936
try :
937
937
self .wait (timeout )
@@ -1004,12 +1004,12 @@ def wait(
1004
1004
) -> None :
1005
1005
"""Wait for the underlying SageMaker job to complete.
1006
1006
1007
- This method waits for the SageMaker job created as a result of the remote function execution
1007
+ This method waits for the SageMaker job created as a result of the remote function run
1008
1008
to complete for up to the timeout value (if specified). If timeout is ``None``, this method
1009
1009
will block until the job is completed.
1010
1010
1011
1011
Args:
1012
- timeout (int): Timeout in seconds to wait for until the job is completed before it is
1012
+ timeout (int): Timeout in seconds to wait until the job is completed before it is
1013
1013
stopped. Defaults to ``None``.
1014
1014
1015
1015
Returns: None
@@ -1029,7 +1029,7 @@ def cancel(self):
1029
1029
early if it is already in progress.
1030
1030
1031
1031
Returns: ``True`` if the underlying SageMaker job created as a result of the remote function
1032
- execution is cancelled.
1032
+ run is cancelled.
1033
1033
"""
1034
1034
with self ._condition :
1035
1035
if self ._state == _FINISHED :
@@ -1073,9 +1073,9 @@ def get_future(job_name, sagemaker_session=None):
1073
1073
1074
1074
Args:
1075
1075
job_name (str): name of the underlying SageMaker job created as a result of the remote
1076
- function execution .
1076
+ function run .
1077
1077
1078
- sagemaker_session (sagemaker.session.Session): A session object which manages interactions
1078
+ sagemaker_session (sagemaker.session.Session): A session object that manages interactions
1079
1079
with Amazon SageMaker APIs and any other AWS services needed.
1080
1080
1081
1081
Returns:
@@ -1094,8 +1094,8 @@ def list_futures(job_name_prefix, sagemaker_session=None):
1094
1094
1095
1095
Args:
1096
1096
job_name_prefix (str): A prefix used to identify the SageMaker jobs associated with remote
1097
- function execution .
1098
- sagemaker_session (sagemaker.session.Session): A session object which manages interactions
1097
+ function run .
1098
+ sagemaker_session (sagemaker.session.Session): A session object that manages interactions
1099
1099
with Amazon SageMaker APIs and any other AWS services needed.
1100
1100
1101
1101
Yields:
0 commit comments