Skip to content

Commit 6a8bb6d

Browse files
chuyang-dengChuyang Deng
and
Chuyang Deng
authored
doc: improve docstring and remove unavailable links (#1572)
* doc: improve docstring and remove unavailable links * remove unavailble links Co-authored-by: Chuyang Deng <[email protected]>
1 parent c531e8e commit 6a8bb6d

File tree

6 files changed

+10
-15
lines changed

6 files changed

+10
-15
lines changed

src/sagemaker/chainer/estimator.py

+2-3
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,8 @@ def __init__(
105105
py_version (str): Python version you want to use for executing your
106106
model training code (default: 'py2'). One of 'py2' or 'py3'.
107107
framework_version (str): Chainer version you want to use for
108-
executing your model training code. List of supported versions
109-
https://github.com/aws/sagemaker-python-sdk#chainer-sagemaker-estimators.
110-
If not specified, this will default to 4.1.
108+
executing your model training code. If not specified, this will
109+
default to 4.1.
111110
image_name (str): If specified, the estimator will use this image
112111
for training and hosting, instead of selecting the appropriate
113112
SageMaker official image based on framework_version and

src/sagemaker/pytorch/estimator.py

+2-3
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,8 @@ def __init__(
8383
py_version (str): Python version you want to use for executing your
8484
model training code (default: 'py3'). One of 'py2' or 'py3'.
8585
framework_version (str): PyTorch version you want to use for
86-
executing your model training code. List of supported versions
87-
https://github.com/aws/sagemaker-python-sdk#pytorch-sagemaker-estimators.
88-
If not specified, this will default to 0.4.
86+
executing your model training code. If not specified, this will default
87+
to 0.4.
8988
image_name (str): If specified, the estimator will use this image
9089
for training and hosting, instead of selecting the appropriate
9190
SageMaker official image based on framework_version and

src/sagemaker/s3.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,9 @@ def upload(local_path, desired_s3_uri, kms_key=None, session=None):
5757
"""Static method that uploads a given file or directory to S3.
5858
5959
Args:
60-
local_path (str): A local path to a file or directory.
61-
desired_s3_uri (str): The desired S3 uri to upload to.
60+
local_path (str): Path (absolute or relative) of local file or directory to upload.
61+
desired_s3_uri (str): The desired S3 location to upload to. It is the prefix to
62+
which the local filename will be added.
6263
kms_key (str): The KMS key to use to encrypt the files.
6364
session (sagemaker.session.Session): Session object which
6465
manages interactions with Amazon SageMaker APIs and any other

src/sagemaker/sklearn/estimator.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,7 @@ def __init__(
6868
If ``source_dir`` is specified, then ``entry_point``
6969
must point to a file located at the root of ``source_dir``.
7070
framework_version (str): Scikit-learn version you want to use for
71-
executing your model training code. List of supported versions
72-
https://github.com/aws/sagemaker-python-sdk#sklearn-sagemaker-estimators
71+
executing your model training code.
7372
source_dir (str): Path (absolute, relative or an S3 URI) to a directory
7473
with any other training source code dependencies aside from the entry
7574
point file (default: None). If ``source_dir`` is an S3 URI, it must

src/sagemaker/tensorflow/estimator.py

+1-3
Original file line numberDiff line numberDiff line change
@@ -237,9 +237,7 @@ def __init__(
237237
py_version (str): Python version you want to use for executing your model training
238238
code (default: 'py2').
239239
framework_version (str): TensorFlow version you want to use for executing your model
240-
training code. List of supported versions
241-
https://github.com/aws/sagemaker-python-sdk#tensorflow-sagemaker-estimators.
242-
If not specified, this will default to 1.11.
240+
training code. If not specified, this will default to 1.11.
243241
model_dir (str): S3 location where the checkpoint data and models can be exported to
244242
during training (default: None). It will be passed in the training script as one of
245243
the command line arguments. If not specified, one is provided based on

src/sagemaker/xgboost/estimator.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,7 @@ def __init__(
7373
be executed as the entry point to training. If ``source_dir`` is specified,
7474
then ``entry_point`` must point to a file located at the root of ``source_dir``.
7575
framework_version (str): XGBoost version you want to use for executing your model
76-
training code. List of supported versions
77-
https://github.com/aws/sagemaker-python-sdk#xgboost-sagemaker-estimators
76+
training code.
7877
source_dir (str): Path (absolute, relative or an S3 URI) to a directory
7978
with any other training source code dependencies aside from the entry
8079
point file (default: None). If ``source_dir`` is an S3 URI, it must

0 commit comments

Comments
 (0)