Skip to content

Commit 74775e4

Browse files
author
Ignacio Quintero
committed
Fix doc formatting
1 parent 17d14d1 commit 74775e4

File tree

6 files changed

+27
-21
lines changed

6 files changed

+27
-21
lines changed

src/sagemaker/chainer/README.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -176,11 +176,11 @@ The following are optional arguments. When you create a ``Chainer`` object, you
176176
method launches. If not specified, the estimator generates a default
177177
job name, based on the training image name and current timestamp
178178
- ``image_name`` An alternative docker image to use for training and
179-
serving. If specified, the estimator will use this image for training and
180-
hosting, instead of selecting the appropriate SageMaker official image based on
181-
framework_version and py_version. Refer to: `SageMaker Chainer Docker Containers
182-
<#sagemaker-chainer-docker-containers>`_ for details on what the Official images support
183-
and where to find the source code to build your custom image.
179+
serving. If specified, the estimator will use this image for training and
180+
hosting, instead of selecting the appropriate SageMaker official image based on
181+
framework_version and py_version. Refer to: `SageMaker Chainer Docker Containers
182+
<#sagemaker-chainer-docker-containers>`_ for details on what the Official images support
183+
and where to find the source code to build your custom image.
184184

185185

186186
Distributed Chainer Training

src/sagemaker/chainer/estimator.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,10 @@ def __init__(self, entry_point, use_mpi=None, num_processes=None, process_slots_
6969
List of supported versions https://github.com/aws/sagemaker-python-sdk#chainer-sagemaker-estimators
7070
image_name (str): If specified, the estimator will use this image for training and hosting, instead of
7171
selecting the appropriate SageMaker official image based on framework_version and py_version. It can
72-
be an ECR url or dockerhub image and tag: 123.dkr.ecr.us-west-2.amazonaws.com/my-custom-image:1.0,
73-
custom-image:latest.
72+
be an ECR url or dockerhub image and tag.
73+
Examples:
74+
123.dkr.ecr.us-west-2.amazonaws.com/my-custom-image:1.0
75+
custom-image:latest.
7476
**kwargs: Additional kwargs passed to the :class:`~sagemaker.estimator.Framework` constructor.
7577
"""
7678
super(Chainer, self).__init__(entry_point, source_dir, hyperparameters,

src/sagemaker/mxnet/README.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -154,11 +154,11 @@ The following are optional arguments. When you create an ``MXNet`` object, you c
154154
method launches. If not specified, the estimator generates a default
155155
job name, based on the training image name and current timestamp
156156
- ``image_name`` An alternative docker image to use for training and
157-
serving. If specified, the estimator will use this image for training and
158-
hosting, instead of selecting the appropriate SageMaker official image based on
159-
framework_version and py_version. Refer to: `SageMaker MXNet Docker Containers
160-
<#sagemaker-mxnet-docker-containers>`_ for details on what the Official images support
161-
and where to find the source code to build your custom image.
157+
serving. If specified, the estimator will use this image for training and
158+
hosting, instead of selecting the appropriate SageMaker official image based on
159+
framework_version and py_version. Refer to: `SageMaker MXNet Docker Containers
160+
<#sagemaker-mxnet-docker-containers>`_ for details on what the Official images support
161+
and where to find the source code to build your custom image.
162162

163163
Calling fit
164164
^^^^^^^^^^^

src/sagemaker/mxnet/estimator.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,10 @@ def __init__(self, entry_point, source_dir=None, hyperparameters=None, py_versio
5454
List of supported versions https://github.com/aws/sagemaker-python-sdk#mxnet-sagemaker-estimators
5555
image_name (str): If specified, the estimator will use this image for training and hosting, instead of
5656
selecting the appropriate SageMaker official image based on framework_version and py_version. It can
57-
be an ECR url or dockerhub image and tag: 123.dkr.ecr.us-west-2.amazonaws.com/my-custom-image:1.0,
58-
custom-image:latest.
57+
be an ECR url or dockerhub image and tag.
58+
Examples:
59+
123.dkr.ecr.us-west-2.amazonaws.com/my-custom-image:1.0
60+
custom-image:latest.
5961
**kwargs: Additional kwargs passed to the :class:`~sagemaker.estimator.Framework` constructor.
6062
"""
6163
super(MXNet, self).__init__(entry_point, source_dir, hyperparameters,

src/sagemaker/tensorflow/README.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -434,11 +434,11 @@ you can specify these as keyword arguments.
434434
method launches. If not specified, the estimator generates a default
435435
job name, based on the training image name and current timestamp.
436436
- ``image_name`` An alternative docker image to use for training and
437-
serving. If specified, the estimator will use this image for training and
438-
hosting, instead of selecting the appropriate SageMaker official image based on
439-
framework_version and py_version. Refer to: `SageMaker TensorFlow Docker Containers
440-
<#sagemaker-tensorflow-docker-containers>`_ for details on what the Official images support
441-
and where to find the source code to build your custom image.
437+
serving. If specified, the estimator will use this image for training and
438+
hosting, instead of selecting the appropriate SageMaker official image based on
439+
framework_version and py_version. Refer to: `SageMaker TensorFlow Docker Containers
440+
<#sagemaker-tensorflow-docker-containers>`_ for details on what the Official images support
441+
and where to find the source code to build your custom image.
442442

443443

444444
Optional Hyperparameters

src/sagemaker/tensorflow/estimator.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,8 +173,10 @@ def __init__(self, training_steps=None, evaluation_steps=None, checkpoint_path=N
173173
`Pip User Guide <https://pip.pypa.io/en/stable/reference/pip_install/#requirements-file-format>`_.
174174
image_name (str): If specified, the estimator will use this image for training and hosting, instead of
175175
selecting the appropriate SageMaker official image based on framework_version and py_version. It can
176-
be an ECR url or dockerhub image and tag: 123.dkr.ecr.us-west-2.amazonaws.com/my-custom-image:1.0,
177-
custom-image:latest.
176+
be an ECR url or dockerhub image and tag.
177+
Examples:
178+
123.dkr.ecr.us-west-2.amazonaws.com/my-custom-image:1.0
179+
custom-image:latest.
178180
**kwargs: Additional kwargs passed to the Framework constructor.
179181
"""
180182
super(TensorFlow, self).__init__(image_name=image_name, **kwargs)

0 commit comments

Comments
 (0)