Skip to content

Fix docs about s3_input usage #258

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
Jun 28, 2018
Merged

Fix docs about s3_input usage #258

merged 4 commits into from
Jun 28, 2018

Conversation

laurenyu
Copy link
Contributor

Description of changes:
Added mention of the s3_input type for fit() with TF - we got contacted about there being confusion around that. Also fixed the description for compression type based on the AWS docs

Merge Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have updated the changelog with a description of my changes (if appropriate)
  • I have updated any necessary documentation (if appropriate)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@laurenyu laurenyu requested a review from nadiaya June 26, 2018 22:15
@@ -482,6 +482,7 @@ Required argument

- ``str``: An S3 URI, for example ``s3://my-bucket/my-training-data``, which indicates the dataset's location.
- ``dict[str, str]``: A dictionary mapping channel names to S3 locations, for example ``{'train': 's3://my-bucket/my-training-data/train', 'test': 's3://my-bucket/my-training-data/test'}``
- ``sagemaker.session.s3_input``: channel configuration for S3 data sources that can provide additional information about the training dataset. See `the API docs <https://sagemaker.readthedocs.io/en/latest/session.html#sagemaker.session.s3_input>`_ for full details.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't it also contain dataset (besides additional information about it)?

@laurenyu laurenyu merged commit 864c653 into aws:master Jun 28, 2018
@laurenyu laurenyu deleted the fix-docs branch June 28, 2018 16:10
apacker pushed a commit to apacker/sagemaker-python-sdk that referenced this pull request Nov 15, 2018
It will generate type error without int
knakad pushed a commit to knakad/sagemaker-python-sdk that referenced this pull request Nov 27, 2019
* change: add support for xgboost version 0.90-2

* fix: remove duplicate rule in test_debugger.py:test_mxnet_with_all_rules_and_configs
knakad pushed a commit to knakad/sagemaker-python-sdk that referenced this pull request Dec 4, 2019
* change: add support for xgboost version 0.90-2

* fix: remove duplicate rule in test_debugger.py:test_mxnet_with_all_rules_and_configs
knakad pushed a commit that referenced this pull request Dec 4, 2019
* change: add support for xgboost version 0.90-2

* fix: remove duplicate rule in test_debugger.py:test_mxnet_with_all_rules_and_configs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants