Skip to content

Fix links in KMeans docstring #254

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.

Sign up for GitHub

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 26, 2018
Merged

Fix links in KMeans docstring #254

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d2f7f49
Fix links in KMeans docstring
laurenyu Jun 25, 2018
71ba6df
Merge branch 'master' into remove-alpha-doc-links
ChoiByungWook Jun 25, 2018
65011d2
Merge branch 'master' into remove-alpha-doc-links
laurenyu Jun 25, 2018
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/amazon/kmeans.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ def __init__(self, role, train_instance_count, train_instance_type, k, init_meth
:class:`~sagemaker.amazon.record_pb2.Record` protobuf serialized data to be stored in S3.

To learn more about the Amazon protobuf Record class and how to prepare bulk data in this format, please
consult AWS technical documentation: https://alpha-docs-aws.amazon.com/sagemaker/latest/dg/cdf-training.html
consult AWS technical documentation: https://docs.aws.amazon.com/sagemaker/latest/dg/cdf-training.html.

After this Estimator is fit, model data is stored in S3. The model may be deployed to an Amazon SageMaker
Endpoint by invoking :meth:`~sagemaker.amazon.estimator.EstimatorBase.deploy`. As well as deploying an Endpoint,
Expand All @@ -61,14 +61,13 @@ def __init__(self, role, train_instance_count, train_instance_type, k, init_meth

KMeans Estimators can be configured by setting hyperparameters. The available hyperparameters for KMeans
are documented below. For further information on the AWS KMeans algorithm, please consult AWS technical
documentation: https://alpha-docs-aws.amazon.com/sagemaker/latest/dg/k-means.html
documentation: https://docs.aws.amazon.com/sagemaker/latest/dg/k-means.html.

Args:
role (str): An AWS IAM role (either name or full ARN). The Amazon SageMaker training jobs and
APIs that create Amazon SageMaker endpoints use this role to access
training data and model artifacts. After the endpoint is created,
the inference code might use the IAM role, if accessing AWS resource.
For more information, see <link>???.
train_instance_count (int): Number of Amazon EC2 instances to use for training.
train_instance_type (str): Type of EC2 instance to use for training, for example, 'ml.c4.xlarge'.
k (int): The number of clusters to produce.
Expand Down