Skip to content

Commit b400fa4

Browse files
Shotaro Kohamalaurenyu
Shotaro Kohama
authored andcommitted
Fix description of an argument of sagemaker.session.train (#69)
* Fix description of an argument of sagemaker.session.train 'input_config' should be an array which has channel objects. * Add a link to the botocore docs * Use 'list' instead of 'array' in the description
1 parent 8a054f0 commit b400fa4

File tree

1 file changed

+3
-11
lines changed

1 file changed

+3
-11
lines changed

src/sagemaker/session.py

+3-11
Original file line numberDiff line numberDiff line change
@@ -195,17 +195,9 @@ def train(self, image, input_mode, input_config, role, job_name, output_config,
195195
a directory in the Docker container.
196196
* 'Pipe' - Amazon SageMaker streams data directly from S3 to the container via a Unix-named pipe.
197197
198-
input_config (str or dict or sagemaker.session.s3_input): Information about the training data.
199-
This can be one of three types:
200-
201-
* (str) - the S3 location where training data is saved.
202-
* (dict[str, str] or dict[str, sagemaker.session.s3_input]) - If using multiple channels for
203-
training data, you can specify a dict mapping channel names
204-
to strings or :func:`~sagemaker.session.s3_input` objects.
205-
* (sagemaker.session.s3_input) - channel configuration for S3 data sources that can provide
206-
additional information about the training dataset. See :func:`sagemaker.session.s3_input`
207-
for full details.
208-
198+
input_config (list): A list of Channel objects. Each channel is a named input source. Please refer to
199+
the format details described:
200+
https://botocore.readthedocs.io/en/latest/reference/services/sagemaker.html#SageMaker.Client.create_training_job
209201
role (str): An AWS IAM role (either name or full ARN). The Amazon SageMaker training jobs and APIs
210202
that create Amazon SageMaker endpoints use this role to access training data and model artifacts.
211203
You must grant sufficient permissions to this role.

0 commit comments

Comments
 (0)