Skip to content

Fix description of an argument of sagemaker.session.train #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 7, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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