Skip to content

Commit a6e4830

Browse files
author
Chuyang Deng
committed
update docstring
1 parent 5f030dd commit a6e4830

File tree

5 files changed

+25
-25
lines changed

5 files changed

+25
-25
lines changed

doc/frameworks/tensorflow/using_tf.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@ If your TFRecords are compressed, you can train on Gzipped TF Records by passing
329329

330330
.. code:: python
331331
332-
from sagemaker.session import TrainingInput
332+
from sagemaker.inputs import TrainingInput
333333
334334
train_s3_input = TrainingInput('s3://bucket/path/to/training/data', compression='Gzip')
335335
tf_estimator.fit(train_s3_input)

src/sagemaker/algorithm.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ def __init__(
8585
the container via a Unix-named pipe.
8686
8787
This argument can be overriden on a per-channel basis using
88-
``sagemaker.session.TrainingInput.input_mode``.
88+
``sagemaker.inputs.TrainingInput.input_mode``.
8989
9090
output_path (str): S3 location for saving the training result (model artifacts and
9191
output files). If not specified, results are stored to a default bucket. If

src/sagemaker/estimator.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ def __init__(
127127
'Pipe' - Amazon SageMaker streams data directly from S3 to the
128128
container via a Unix-named pipe. This argument can be overriden
129129
on a per-channel basis using
130-
``sagemaker.session.TrainingInput.input_mode``.
130+
``sagemaker.inputs.TrainingInput.input_mode``.
131131
output_path (str): S3 location for saving the training result (model
132132
artifacts and output files). If not specified, results are
133133
stored to a default bucket. If the bucket with the specific name
@@ -472,18 +472,18 @@ def fit(self, inputs=None, wait=True, logs="All", job_name=None, experiment_conf
472472
model using the Amazon SageMaker hosting services.
473473
474474
Args:
475-
inputs (str or dict or sagemaker.session.TrainingInput): Information
475+
inputs (str or dict or sagemaker.inputs.TrainingInput): Information
476476
about the training data. This can be one of three types:
477477
478478
* (str) the S3 location where training data is saved, or a file:// path in
479479
local mode.
480-
* (dict[str, str] or dict[str, sagemaker.session.TrainingInput]) If using multiple
480+
* (dict[str, str] or dict[str, sagemaker.inputs.TrainingInput]) If using multiple
481481
channels for training data, you can specify a dict mapping channel names to
482-
strings or :func:`~sagemaker.session.TrainingInput` objects.
483-
* (sagemaker.session.TrainingInput) - channel configuration for S3 data sources
482+
strings or :func:`~sagemaker.inputs.TrainingInput` objects.
483+
* (sagemaker.inputs.TrainingInput) - channel configuration for S3 data sources
484484
that can provide additional information as well as the path to the training
485485
dataset.
486-
See :func:`sagemaker.session.TrainingInput` for full details.
486+
See :func:`sagemaker.inputs.TrainingInput` for full details.
487487
* (sagemaker.session.FileSystemInput) - channel configuration for
488488
a file system data source that can provide additional information as well as
489489
the path to the training dataset.
@@ -1192,7 +1192,7 @@ def __init__(
11921192
container via a Unix-named pipe.
11931193
11941194
This argument can be overriden on a per-channel basis using
1195-
``sagemaker.session.TrainingInput.input_mode``.
1195+
``sagemaker.inputs.TrainingInput.input_mode``.
11961196
output_path (str): S3 location for saving the training result (model
11971197
artifacts and output files). If not specified, results are
11981198
stored to a default bucket. If the bucket with the specific name

src/sagemaker/tuner.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -377,13 +377,13 @@ def fit(
377377
any of the following forms:
378378
379379
* (str) - The S3 location where training data is saved.
380-
* (dict[str, str] or dict[str, sagemaker.session.TrainingInput]) -
380+
* (dict[str, str] or dict[str, sagemaker.inputs.TrainingInput]) -
381381
If using multiple channels for training data, you can specify
382382
a dict mapping channel names to strings or
383-
:func:`~sagemaker.session.TrainingInput` objects.
384-
* (sagemaker.session.TrainingInput) - Channel configuration for S3 data sources
383+
:func:`~sagemaker.inputs.TrainingInput` objects.
384+
* (sagemaker.inputs.TrainingInput) - Channel configuration for S3 data sources
385385
that can provide additional information about the training dataset.
386-
See :func:`sagemaker.session.TrainingInput` for full details.
386+
See :func:`sagemaker.inputs.TrainingInput` for full details.
387387
* (sagemaker.session.FileSystemInput) - channel configuration for
388388
a file system data source that can provide additional information as well as
389389
the path to the training dataset.

src/sagemaker/workflow/airflow.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -115,13 +115,13 @@ def training_base_config(estimator, inputs=None, job_name=None, mini_batch_size=
115115
116116
* (str) - The S3 location where training data is saved.
117117
118-
* (dict[str, str] or dict[str, sagemaker.session.TrainingInput]) - If using multiple
118+
* (dict[str, str] or dict[str, sagemaker.inputs.TrainingInput]) - If using multiple
119119
channels for training data, you can specify a dict mapping channel names to
120-
strings or :func:`~sagemaker.session.TrainingInput` objects.
120+
strings or :func:`~sagemaker.inputs.TrainingInput` objects.
121121
122-
* (sagemaker.session.TrainingInput) - Channel configuration for S3 data sources that can
122+
* (sagemaker.inputs.TrainingInput) - Channel configuration for S3 data sources that can
123123
provide additional information about the training dataset. See
124-
:func:`sagemaker.session.TrainingInput` for full details.
124+
:func:`sagemaker.inputs.TrainingInput` for full details.
125125
126126
* (sagemaker.amazon.amazon_estimator.RecordSet) - A collection of
127127
Amazon :class:~`Record` objects serialized and stored in S3.
@@ -208,13 +208,13 @@ def training_config(estimator, inputs=None, job_name=None, mini_batch_size=None)
208208
method of the associated estimator, as this can take any of the following forms:
209209
* (str) - The S3 location where training data is saved.
210210
211-
* (dict[str, str] or dict[str, sagemaker.session.TrainingInput]) - If using multiple
211+
* (dict[str, str] or dict[str, sagemaker.inputs.TrainingInput]) - If using multiple
212212
channels for training data, you can specify a dict mapping channel names to
213-
strings or :func:`~sagemaker.session.TrainingInput` objects.
213+
strings or :func:`~sagemaker.inputs.TrainingInput` objects.
214214
215-
* (sagemaker.session.TrainingInput) - Channel configuration for S3 data sources that can
215+
* (sagemaker.inputs.TrainingInput) - Channel configuration for S3 data sources that can
216216
provide additional information about the training dataset. See
217-
:func:`sagemaker.session.TrainingInput` for full details.
217+
:func:`sagemaker.inputs.TrainingInput` for full details.
218218
219219
* (sagemaker.amazon.amazon_estimator.RecordSet) - A collection of
220220
Amazon :class:~`Record` objects serialized and stored in S3.
@@ -258,13 +258,13 @@ def tuning_config(tuner, inputs, job_name=None, include_cls_metadata=False, mini
258258
259259
* (str) - The S3 location where training data is saved.
260260
261-
* (dict[str, str] or dict[str, sagemaker.session.TrainingInput]) - If using multiple
261+
* (dict[str, str] or dict[str, sagemaker.inputs.TrainingInput]) - If using multiple
262262
channels for training data, you can specify a dict mapping channel names to
263-
strings or :func:`~sagemaker.session.TrainingInput` objects.
263+
strings or :func:`~sagemaker.inputs.TrainingInput` objects.
264264
265-
* (sagemaker.session.TrainingInput) - Channel configuration for S3 data sources that can
265+
* (sagemaker.inputs.TrainingInput) - Channel configuration for S3 data sources that can
266266
provide additional information about the training dataset. See
267-
:func:`sagemaker.session.TrainingInput` for full details.
267+
:func:`sagemaker.inputs.TrainingInput` for full details.
268268
269269
* (sagemaker.amazon.amazon_estimator.RecordSet) - A collection of
270270
Amazon :class:~`Record` objects serialized and stored in S3.

0 commit comments

Comments
 (0)