Skip to content

Commit 1255be4

Browse files
zaeemnallalaurenyu
authored andcommitted
doc: Correct info on code_location parameter (#1129)
Corrected info on resulting S3 path if code_location is specified and added warning about trailing slash
1 parent 54c4336 commit 1255be4

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

src/sagemaker/estimator.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1280,11 +1280,10 @@ def __init__(
12801280
(default: logging.INFO). Valid values are defined in the Python
12811281
logging module.
12821282
code_location (str): The S3 prefix URI where custom code will be
1283-
uploaded (default: None). The code file uploaded in S3 is
1284-
'code_location/source/sourcedir.tar.gz'. If not specified, the
1285-
default code location is s3://default_bucket/job-name/. And code
1286-
file uploaded to S3 is
1287-
s3://default_bucket/job-name/source/sourcedir.tar.gz
1283+
uploaded (default: None) - don't include a trailing slash since
1284+
a string prepended with a "/" is appended to ``code_location``. The code
1285+
file uploaded to S3 is 'code_location/job-name/source/sourcedir.tar.gz'.
1286+
If not specified, the default ``code location`` is s3://default_bucket/job-name/.
12881287
image_name (str): An alternate image name to use instead of the
12891288
official Sagemaker image for the framework. This is useful to
12901289
run one of the Sagemaker supported frameworks with an image

0 commit comments

Comments
 (0)