doc: specify S3 source_dir needs to point to a tar file #1498
Conversation
update with aws/master
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
laurenyu
changed the title
src/sagemaker/estimator.py
Outdated
| source_dir (str): Path (absolute, relative, or an S3 URI points to a | ||
| tar.gz) to a directory with any other training source code | ||
| dependencies aside from the entry point file (default: None). | ||
| Structure within this directory are preserved when training on | ||
| Amazon SageMaker. If 'git_config' is provided, 'source_dir' | ||
| should be a relative location to a directory in the Git repo. | ||
| .. admonition:: Example |
There was a problem hiding this comment.
I worry the way you've worded it might be a bit ambiguous, i.e. one might think even the absolute/relative paths should point to a tar.gz file. How about adding another sentence after "Structure within...Amazon SageMaker." that's like, "If source_dir is an S3 URI, it must point to a tar.gz file"?
There was a problem hiding this comment.
This is better!
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
Issue #, if available:
#1494
Description of changes:
update documentation for source_dir
Testing done:
Merge Checklist
Put an
xin 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.General
Tests
unique_name_from_baseto create resource names in integ tests (if appropriate)By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.