Skip to content

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

Merged
merged 7 commits into from
Feb 27, 2019

Conversation

eslesar-aws
Copy link
Contributor

@eslesar-aws eslesar-aws commented Feb 26, 2019

Issue #, if available:

Description of changes:

  • Add overview content in main repo README into sphynx project
  • Change heading levels in sphynx index.rst

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.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have updated the changelog with a description of my changes (if appropriate)
  • I have updated any necessary documentation (if appropriate)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@codecov-io
Copy link

codecov-io commented Feb 26, 2019

Codecov Report

Merging #666 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8b33a30...67c6160. Read the comment docs.

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.

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
Copy link
Contributor

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.
Copy link
Contributor

Choose a reason for hiding this comment

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

s/overview/an overview

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.

sorry, one nitpicky comment I missed last time

CHANGELOG.rst Outdated

1.18.3.post1
============

* doc-fix: fix README for PyPI


Copy link
Contributor

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
Copy link
Contributor

Choose a reason for hiding this comment

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

bad merge?

Copy link
Contributor Author

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.

@laurenyu laurenyu merged commit dc70fd6 into aws:master Feb 27, 2019
@eslesar-aws eslesar-aws deleted the migrate-overview branch March 14, 2019 21:25
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