Skip to content

Commit 623c722

Browse files
committed
add documentation about parameter server
1 parent 7175165 commit 623c722

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

src/sagemaker/mxnet/README.rst

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Suppose that you already have an MXNet training script called
2424
framework_version='1.2.1')
2525
mxnet_estimator.fit('s3://bucket/path/to/training/data')
2626
27-
Where the s3 url is a path to your training data, within Amazon S3. The constructor keyword arguments define how SageMaker runs your training script and are discussed, in detail, in a later section.
27+
Where the S3 url is a path to your training data, within Amazon S3. The constructor keyword arguments define how SageMaker runs your training script and are discussed, in detail, in a later section.
2828

2929
In the following sections, we'll discuss how to prepare a training script for execution on SageMaker, then how to run that script on SageMaker using an ``MXNet`` Estimator.
3030

@@ -207,6 +207,16 @@ If you were previously relying on the default save method, you can now import on
207207
208208
save(args.model_dir, model)
209209
210+
Lastly, if you were relying on the container launching a parameter server for use with distributed training, you must now set ``launch_parameter_server`` to ``True`` when creating an MXNet estimator:
211+
212+
.. code:: python
213+
214+
from sagemaker.mxnet import MXNet
215+
216+
estimator = MXNet('path-to-distributed-training-script.py',
217+
...,
218+
launch_parameter_server=True)
219+
210220
211221
Using third-party libraries
212222
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -218,7 +228,9 @@ If there are other packages you want to use with your script, you can include a
218228
Running an MXNet training script in SageMaker
219229
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
220230

221-
You run MXNet training scripts on SageMaker by creating ``MXNet`` Estimators. SageMaker training of your script is invoked when you call ``fit`` on an ``MXNet`` Estimator. The following code sample shows how you train a custom MXNet script "train.py".
231+
You run MXNet training scripts on SageMaker by creating an ``MXNet`` estimators.
232+
When you call ``fit`` on an ``MXNet`` estimator, a SageMaker training job with your script is started.
233+
The following code sample shows how you train a custom MXNet script "train.py".
222234

223235
.. code:: python
224236
@@ -292,6 +304,8 @@ The following are optional arguments. When you create an ``MXNet`` object, you c
292304
framework_version and py_version. Refer to: `SageMaker MXNet Docker Containers
293305
<#sagemaker-mxnet-docker-containers>`_ for details on what the Official images support
294306
and where to find the source code to build your custom image.
307+
- ``launch_parameter_server`` For versions 1.3 and above only.
308+
This determines whether or not a parameter server is launched for use with distributed training.
295309

296310
Calling fit
297311
^^^^^^^^^^^

0 commit comments

Comments
 (0)