Skip to content

Commit

Permalink
Fix description of an argument of sagemaker.session.train (#69)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
Shotaro Kohama authored and laurenyu committed Feb 7, 2018
1 parent 8a054f0 commit b400fa4
Showing 1 changed file with 3 additions and 11 deletions.
14 changes: 3 additions & 11 deletions src/sagemaker/session.py
Original file line number Diff line number Diff line change
Expand Up @@ -195,17 +195,9 @@ def train(self, image, input_mode, input_config, role, job_name, output_config,
a directory in the Docker container.
* 'Pipe' - Amazon SageMaker streams data directly from S3 to the container via a Unix-named pipe.
input_config (str or dict or sagemaker.session.s3_input): Information about the training data.
This can be one of three types:
* (str) - the S3 location where training data is saved.
* (dict[str, str] or dict[str, sagemaker.session.s3_input]) - If using multiple channels for
training data, you can specify a dict mapping channel names
to strings or :func:`~sagemaker.session.s3_input` objects.
* (sagemaker.session.s3_input) - channel configuration for S3 data sources that can provide
additional information about the training dataset. See :func:`sagemaker.session.s3_input`
for full details.
input_config (list): A list of Channel objects. Each channel is a named input source. Please refer to
the format details described:
https://botocore.readthedocs.io/en/latest/reference/services/sagemaker.html#SageMaker.Client.create_training_job
role (str): An AWS IAM role (either name or full ARN). The Amazon SageMaker training jobs and APIs
that create Amazon SageMaker endpoints use this role to access training data and model artifacts.
You must grant sufficient permissions to this role.
Expand Down

0 comments on commit b400fa4

Please sign in to comment.