-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Move overview content from main readme into sphynx project #666
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
Conversation
Codecov Report
@@ Coverage Diff @@
## master #666 +/- ##
=======================================
Coverage 92.73% 92.73%
=======================================
Files 71 71
Lines 5489 5489
=======================================
Hits 5090 5090
Misses 399 399 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
seems like there's some weirdness going on with line endings - can you make sure you're using LF and not CRLF?
CHANGELOG.rst
Outdated
@@ -2,6 +2,11 @@ | |||
CHANGELOG | |||
========= | |||
|
|||
1.18.4.post1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the "dev" part of the label means we haven't released it yet, so you can add this in the entry below. Also maybe add an entry for the last PR since we forgot?
doc/index.rst
Outdated
Amazon SageMaker Python SDK is an open source library for training and deploying machine-learned models on Amazon SageMaker. | ||
|
||
With the SDK, you can train and deploy models using popular deep learning frameworks, algorithms provided by Amazon, or your own algorithms built into SageMaker-compatible Docker images. | ||
|
||
Here you'll find API docs for SageMaker Python SDK. The project homepage is in Github: https://github.com/aws/sagemaker-python-sdk, where you can find the SDK source, installation instructions and a general overview of the library. | ||
Here you'll find overview and API documentation for SageMaker Python SDK. The project homepage is in Github: https://github.com/aws/sagemaker-python-sdk, where you can find the SDK source and installation instructions for the library. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/overview/an overview
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sorry, one nitpicky comment I missed last time
CHANGELOG.rst
Outdated
|
||
1.18.3.post1 | ||
============ | ||
|
||
* doc-fix: fix README for PyPI | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should just be one newline between sections. same comment for line 15
CHANGELOG.rst
Outdated
* bug-fix: pass accelerator_type in ``deploy`` for REST API TFS ``Model`` | ||
>>>>>>> 8b33a305110997e18b1f2f2a37b2d3cdd98b2f91 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
bad merge?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry...should be fixed now.
Issue #, if available:
Description of changes:
Merge Checklist
Put an
x
in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.