Skip to content

README.rst additions #13

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 4 commits into from
Dec 15, 2017
Merged

README.rst additions #13

merged 4 commits into from
Dec 15, 2017

Conversation

lukmis
Copy link
Contributor

@lukmis lukmis commented Dec 7, 2017

Add SageMaker banner and reference it from the README.rst
Add link to 'Read the Docs'.
Provide more information on AWS built-in algorithms in the description.

…mation on AWS built-in algorithms in the description.
README.rst Outdated
@@ -1419,6 +1426,20 @@ The full list of algorithms is available on the AWS website: https://docs.aws.am

SageMaker Python SDK includes Estimator wrappers for the AWS K-means, Principal Components Analysis, and Liner Learner algorithms.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know you didn't change this line, but would you mind to fix the type Liner -> Linear?

README.rst Outdated
Estimators that wrap Amazon's built-in algorithms define algorithm's hyperparameters with defaults. When a default is not possible you need to provide the value during construction:

- ``KMean`` Estimator requires parameter ``k`` to define number of clusters
- ``PCA`` Estimator requires parameter ``num_components`` to define number of principal components
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a code block with example usage of these estimators here?

README.rst Outdated

Predictions support
~~~~~~~~~~~~~~~~~~~
Calling inference on deployed Amazon's built-in algorithms you must follow specific input format. By default this library creates a predictor that allows to use just numpy data.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Calling inference on deployed Amazon's built-in algorithms requires a specific input format. By default , ...

Copy link
Contributor

@laurenyu laurenyu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sure the final commit message is in imperative mood :)

@lukmis lukmis merged commit 3462496 into master Dec 15, 2017
@lukmis lukmis deleted the readme_additions branch December 15, 2017 19:28
laurenyu added a commit to laurenyu/sagemaker-python-sdk that referenced this pull request May 31, 2018
aws#11 updated master to reflect the public SDK. This change brings this branch up to date.
apacker pushed a commit to apacker/sagemaker-python-sdk that referenced this pull request Nov 15, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants