Skip to content

doc: improve docstring and remove unavailable links #1572

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 3 commits into from
Jun 11, 2020
Merged
Show file tree
Hide file tree
Changes from 2 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
5 changes: 2 additions & 3 deletions src/sagemaker/chainer/estimator.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,8 @@ def __init__(
py_version (str): Python version you want to use for executing your
model training code (default: 'py2'). One of 'py2' or 'py3'.
framework_version (str): Chainer version you want to use for
executing your model training code. List of supported versions
https://github.com/aws/sagemaker-python-sdk#chainer-sagemaker-estimators.
If not specified, this will default to 4.1.
executing your model training code. If not specified, this will
default to 4.1.
image_name (str): If specified, the estimator will use this image
for training and hosting, instead of selecting the appropriate
SageMaker official image based on framework_version and
Expand Down
5 changes: 2 additions & 3 deletions src/sagemaker/pytorch/estimator.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,8 @@ def __init__(
py_version (str): Python version you want to use for executing your
model training code (default: 'py3'). One of 'py2' or 'py3'.
framework_version (str): PyTorch version you want to use for
executing your model training code. List of supported versions
https://github.com/aws/sagemaker-python-sdk#pytorch-sagemaker-estimators.
If not specified, this will default to 0.4.
executing your model training code. If not specified, this will default
to 0.4.
image_name (str): If specified, the estimator will use this image
for training and hosting, instead of selecting the appropriate
SageMaker official image based on framework_version and
Expand Down
5 changes: 3 additions & 2 deletions src/sagemaker/s3.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,9 @@ def upload(local_path, desired_s3_uri, kms_key=None, session=None):
"""Static method that uploads a given file or directory to S3.

Args:
local_path (str): A local path to a file or directory.
desired_s3_uri (str): The desired S3 uri to upload to.
local_path (str): Path (absolute or relative) of local file or directory to upload.
desired_s3_uri (str): The desired S3 location to upload to. It is the prefix to
which the local filename will be added.
kms_key (str): The KMS key to use to encrypt the files.
session (sagemaker.session.Session): Session object which
manages interactions with Amazon SageMaker APIs and any other
Expand Down
3 changes: 1 addition & 2 deletions src/sagemaker/sklearn/estimator.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,7 @@ def __init__(
If ``source_dir`` is specified, then ``entry_point``
must point to a file located at the root of ``source_dir``.
framework_version (str): Scikit-learn version you want to use for
executing your model training code. List of supported versions
https://github.com/aws/sagemaker-python-sdk#sklearn-sagemaker-estimators
executing your model training code.
source_dir (str): Path (absolute, relative or an S3 URI) to a directory
with any other training source code dependencies aside from the entry
point file (default: None). If ``source_dir`` is an S3 URI, it must
Expand Down
4 changes: 1 addition & 3 deletions src/sagemaker/tensorflow/estimator.py
Original file line number Diff line number Diff line change
Expand Up @@ -237,9 +237,7 @@ def __init__(
py_version (str): Python version you want to use for executing your model training
code (default: 'py2').
framework_version (str): TensorFlow version you want to use for executing your model
training code. List of supported versions
https://github.com/aws/sagemaker-python-sdk#tensorflow-sagemaker-estimators.
If not specified, this will default to 1.11.
training code. If not specified, this will default to 1.11.
model_dir (str): S3 location where the checkpoint data and models can be exported to
during training (default: None). It will be passed in the training script as one of
the command line arguments. If not specified, one is provided based on
Expand Down
3 changes: 1 addition & 2 deletions src/sagemaker/xgboost/estimator.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,7 @@ def __init__(
be executed as the entry point to training. If ``source_dir`` is specified,
then ``entry_point`` must point to a file located at the root of ``source_dir``.
framework_version (str): XGBoost version you want to use for executing your model
training code. List of supported versions
https://github.com/aws/sagemaker-python-sdk#xgboost-sagemaker-estimators
training code.
source_dir (str): Path (absolute, relative or an S3 URI) to a directory
with any other training source code dependencies aside from the entry
point file (default: None). If ``source_dir`` is an S3 URI, it must
Expand Down