Skip to content

Commit ef0cc4e

Browse files
committed
Update docstrings and documentations
1 parent e684021 commit ef0cc4e

File tree

7 files changed

+25
-25
lines changed

7 files changed

+25
-25
lines changed

src/sagemaker/chainer/README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -145,10 +145,10 @@ Optional arguments
145145

146146
The following are optional arguments. When you create a ``Chainer`` object, you can specify these as keyword arguments.
147147

148-
- ``source_dir`` Path (absolute or relative) to a directory with any
149-
other training source code dependencies including the entry point
150-
file. Structure within this directory will be preserved when training
151-
on SageMaker.
148+
- ``source_dir`` Single path (absolute or relative) or a list of paths
149+
to directories with any other training source code dependencies
150+
aside from the entry point file (default: None). The structures
151+
within this directories are preserved when training on Amazon SageMaker.
152152
- ``hyperparameters`` Hyperparameters that will be used for training.
153153
Will be made accessible as a dict[str, str] to the training code on
154154
SageMaker. For convenience, accepts other types besides str, but

src/sagemaker/chainer/estimator.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ def __init__(self, entry_point, use_mpi=None, num_processes=None, process_slots_
6464
set to the number of GPUs on the instance (on GPU instances), or one (on CPU instances).
6565
additional_mpi_options (str): String of options to the 'mpirun' command used to run the entry point.
6666
For example, '-X NCCL_DEBUG=WARN' will pass that option string to the mpirun command.
67-
source_dir (str): Path (absolute or relative) to a directory with any other training
68-
source code dependencies aside from tne entry point file (default: None). Structure within this
69-
directory are preserved when training on Amazon SageMaker.
67+
source_dir (str or [str]): Single path (absolute or relative) or a list of paths to directories with
68+
any other training source code dependencies aside from the entry point file (default: None).
69+
The structures within this directories are preserved when training on Amazon SageMaker.
7070
hyperparameters (dict): Hyperparameters that will be used for training (default: None).
7171
The hyperparameters are made accessible as a dict[str, str] to the training code on SageMaker.
7272
For convenience, this accepts other types for keys and values, but ``str()`` will be called

src/sagemaker/mxnet/README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -267,10 +267,10 @@ Optional arguments
267267

268268
The following are optional arguments. When you create an ``MXNet`` object, you can specify these as keyword arguments.
269269

270-
- ``source_dir`` Path (absolute or relative) to a directory with any
271-
other training source code dependencies including the entry point
272-
file. Structure within this directory will be preserved when training
273-
on SageMaker.
270+
- ``source_dir`` Single path (absolute or relative) or a list of paths
271+
to directories with any other training source code dependencies
272+
aside from the entry point file (default: None). The structures
273+
within this directories are preserved when training on Amazon SageMaker.
274274
- ``hyperparameters`` Hyperparameters that will be used for training.
275275
Will be made accessible as a dict[str, str] to the training code on
276276
SageMaker. For convenience, accepts other types besides str, but

src/sagemaker/mxnet/estimator.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ def __init__(self, entry_point, source_dir=None, hyperparameters=None, py_versio
5050
Args:
5151
entry_point (str): Path (absolute or relative) to the Python source file which should be executed
5252
as the entry point to training. This should be compatible with either Python 2.7 or Python 3.5.
53-
source_dir (str): Path (absolute or relative) to a directory with any other training
54-
source code dependencies aside from tne entry point file (default: None). Structure within this
55-
directory are preserved when training on Amazon SageMaker.
53+
source_dir (str or [str]): Single path (absolute or relative) or a list of paths to directories with
54+
any other training source code dependencies aside from the entry point file (default: None).
55+
The structures within this directories are preserved when training on Amazon SageMaker.
5656
hyperparameters (dict): Hyperparameters that will be used for training (default: None).
5757
The hyperparameters are made accessible as a dict[str, str] to the training code on SageMaker.
5858
For convenience, this accepts other types for keys and values, but ``str()`` will be called

src/sagemaker/pytorch/README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -171,10 +171,10 @@ Optional arguments
171171

172172
The following are optional arguments. When you create a ``PyTorch`` object, you can specify these as keyword arguments.
173173

174-
- ``source_dir`` Path (absolute or relative) to a directory with any
175-
other training source code dependencies including the entry point
176-
file. Structure within this directory will be preserved when training
177-
on SageMaker.
174+
- ``source_dir`` Single path (absolute or relative) or a list of paths
175+
to directories with any other training source code dependencies
176+
aside from the entry point file (default: None). The structures
177+
within this directories are preserved when training on Amazon SageMaker.
178178
- ``hyperparameters`` Hyperparameters that will be used for training.
179179
Will be made accessible as a dict[str, str] to the training code on
180180
SageMaker. For convenience, accepts other types besides strings, but

src/sagemaker/pytorch/estimator.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ def __init__(self, entry_point, source_dir=None, hyperparameters=None, py_versio
4747
Args:
4848
entry_point (str): Path (absolute or relative) to the Python source file which should be executed
4949
as the entry point to training. This should be compatible with either Python 2.7 or Python 3.5.
50-
source_dir (str): Path (absolute or relative) to a directory with any other training
51-
source code dependencies aside from tne entry point file (default: None). Structure within this
52-
directory are preserved when training on Amazon SageMaker.
50+
source_dir (str or [str]): Single path (absolute or relative) or a list of paths to directories with
51+
any other training source code dependencies aside from the entry point file (default: None).
52+
The structures within this directories are preserved when training on Amazon SageMaker.
5353
hyperparameters (dict): Hyperparameters that will be used for training (default: None).
5454
The hyperparameters are made accessible as a dict[str, str] to the training code on SageMaker.
5555
For convenience, this accepts other types for keys and values, but ``str()`` will be called

src/sagemaker/tensorflow/README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -405,10 +405,10 @@ Optional Arguments
405405
The following are optional arguments. When you create a ``TensorFlow`` object,
406406
you can specify these as keyword arguments.
407407

408-
- ``source_dir (str)`` Path (absolute or relative) to a directory with any
409-
other training source code dependencies including the entry point
410-
file. Structure within this directory will be preserved when training
411-
on SageMaker.
408+
- ``source_dir (str)`` Single path (absolute or relative) or a list of paths
409+
to directories with any other training source code dependencies
410+
aside from the entry point file (default: None). The structures
411+
within this directories are preserved when training on Amazon SageMaker.
412412
- ``requirements_file (str)`` Path to a ``requirements.txt`` file. The path should
413413
be within and relative to ``source_dir``. This is a file containing a list of items to be
414414
installed using pip install. Details on the format can be found in the

0 commit comments

Comments
 (0)