Skip to content

Commit 6fcef34

Browse files
Dipankar Patrodpatro
authored andcommitted
Address PR feedback
1 parent 11cfd6f commit 6fcef34

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

doc/overview.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2448,7 +2448,7 @@ specifically the contents of ``'body': b'{...}`` .
24482448
Run Machine Learning code on SageMaker using remote function
24492449
************************************************************
24502450
2451-
You can seamlessly integrate your local machine language (ML) code to run in a Amazon SageMaker Training job by wrapping
2451+
You can integrate your local machine language (ML) code to run in a Amazon SageMaker Training job by wrapping
24522452
your code inside a @remote decorator as shown in the following code example.
24532453
24542454
.. code-block:: python

src/sagemaker/remote_function/client.py

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ def remote(
132132
in the system path.
133133
134134
* 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
136136
snapshot. You do not need to provide a dependencies file. The following conditions
137137
apply:
138138
@@ -173,9 +173,9 @@ def remote(
173173
Amazon Elastic Container Registry (ECR). Defaults to the following based on where the SDK
174174
is running:
175175
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
177177
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
179179
as the environment running the local code.
180180
181181
If no compatible image is found, a ValueError is thrown.
@@ -184,7 +184,7 @@ def remote(
184184
local directories. Set to ``True`` if the remote function code imports local modules and
185185
methods that are not available via PyPI or conda. Default value is ``False``.
186186
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.
188188
189189
instance_type (str): The Amazon Elastic Compute Cloud (EC2) instance type to use to run
190190
the SageMaker job. e.g. ml.c4.xlarge. If not provided, ValueError is thrown.
@@ -199,7 +199,7 @@ def remote(
199199
warm pools. The use of warmpools reduces the latency time spent to provision new
200200
resources. The default value for ``keep_alive_period_in_seconds`` is 0.
201201
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
203203
latency than over using SageMaker managed warm pools alone by caching the package source
204204
downloaded in the previous runs.
205205
@@ -521,7 +521,7 @@ def __init__(
521521
in the system path.
522522
523523
* 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
525525
snapshot. You do not need to provide a dependencies file. The following conditions
526526
apply:
527527
@@ -562,9 +562,9 @@ def __init__(
562562
Amazon Elastic Container Registry (ECR). Defaults to the following based on where the
563563
SDK is running:
564564
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
568568
version as the environment running the local code.
569569
570570
If no compatible image is found, a ValueError is thrown.
@@ -573,7 +573,7 @@ def __init__(
573573
local directories. Set to ``True`` if the remote function code imports local modules
574574
and methods that are not available via PyPI or conda. Default value is ``False``.
575575
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.
577577
578578
instance_type (str): The Amazon Elastic Compute Cloud (EC2) instance type to use to run
579579
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):
820820
class Future(object):
821821
"""Class representing a reference to a SageMaker job result.
822822
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
824824
or may not have finished running.
825825
"""
826826

@@ -931,7 +931,7 @@ def result(self, timeout: float = None) -> Any:
931931
default.
932932
933933
Returns:
934-
The Python object returned by the remote function execution.
934+
The Python object returned by the remote function.
935935
"""
936936
try:
937937
self.wait(timeout)
@@ -1004,12 +1004,12 @@ def wait(
10041004
) -> None:
10051005
"""Wait for the underlying SageMaker job to complete.
10061006
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
10081008
to complete for up to the timeout value (if specified). If timeout is ``None``, this method
10091009
will block until the job is completed.
10101010
10111011
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
10131013
stopped. Defaults to ``None``.
10141014
10151015
Returns: None
@@ -1029,7 +1029,7 @@ def cancel(self):
10291029
early if it is already in progress.
10301030
10311031
Returns: ``True`` if the underlying SageMaker job created as a result of the remote function
1032-
execution is cancelled.
1032+
run is cancelled.
10331033
"""
10341034
with self._condition:
10351035
if self._state == _FINISHED:
@@ -1073,9 +1073,9 @@ def get_future(job_name, sagemaker_session=None):
10731073
10741074
Args:
10751075
job_name (str): name of the underlying SageMaker job created as a result of the remote
1076-
function execution.
1076+
function run.
10771077
1078-
sagemaker_session (sagemaker.session.Session): A session object which manages interactions
1078+
sagemaker_session (sagemaker.session.Session): A session object that manages interactions
10791079
with Amazon SageMaker APIs and any other AWS services needed.
10801080
10811081
Returns:
@@ -1094,8 +1094,8 @@ def list_futures(job_name_prefix, sagemaker_session=None):
10941094
10951095
Args:
10961096
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
10991099
with Amazon SageMaker APIs and any other AWS services needed.
11001100
11011101
Yields:

0 commit comments

Comments
 (0)