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.

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 7 commits into from
Feb 27, 2019
Merged

Move overview content from main readme into sphynx project #666

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
59d8b32
Move overview content from main readme into sphynx project
eslesar-aws Feb 26, 2019
0c56bb4
made changes per feedback
eslesar-aws Feb 26, 2019
4858676
Merge branch 'master' of https://github.com/aws/sagemaker-python-sdk …
eslesar-aws Feb 26, 2019
29fa519
fixed changelog doc fix entries
eslesar-aws Feb 26, 2019
7ae0107
remove extraneous newlines from changelog
eslesar-aws Feb 27, 2019
7735abf
resolve merge conflict in changelog
eslesar-aws Feb 27, 2019
67c6160
fixed merge conflict
eslesar-aws Feb 27, 2019
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: 5 additions & 0 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
CHANGELOG
=========

1.18.4.post1
Copy link
Contributor

@laurenyu laurenyu Feb 26, 2019

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?

============

* Documentation: move overview content in main README into sphynx project

1.18.4.dev
==========

Expand Down
43 changes: 30 additions & 13 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,22 @@
###########################
Amazon SageMaker Python SDK
===========================
###########################
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

@laurenyu laurenyu Feb 26, 2019

Choose a reason for hiding this comment

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

s/overview/an overview


********
Overview
--------
The SageMaker Python SDK consists of a few primary interfaces:
********

.. toctree::
:maxdepth: 2

overview

The SageMaker Python SDK consists of a few primary classes:

.. toctree::
:maxdepth: 2
Expand All @@ -22,8 +30,9 @@ The SageMaker Python SDK consists of a few primary interfaces:
session
analytics

*****
MXNet
-----
*****
A managed environment for MXNet training and hosting on Amazon SageMaker

.. toctree::
Expand All @@ -36,62 +45,69 @@ A managed environment for MXNet training and hosting on Amazon SageMaker

sagemaker.mxnet

**********
TensorFlow
----------
**********
A managed environment for TensorFlow training and hosting on Amazon SageMaker

.. toctree::
:maxdepth: 2

sagemaker.tensorflow

************
Scikit-Learn
------------
************
A managed enrionment for Scikit-learn training and hosting on Amazon SageMaker

.. toctree::
:maxdepth: 2

sagemaker.sklearn

*******
PyTorch
-------
*******
A managed environment for PyTorch training and hosting on Amazon SageMaker

.. toctree::
:maxdepth: 2

sagemaker.pytorch

*******
Chainer
-------
*******
A managed environment for Chainer training and hosting on Amazon SageMaker

.. toctree::
:maxdepth: 2

sagemaker.chainer

**********************
Reinforcement Learning
----------------------
**********************
A managed environment for Reinforcement Learning training and hosting on Amazon SageMaker

.. toctree::
:maxdepth: 2

sagemaker.rl

***************
SparkML Serving
---------------
***************
A managed environment for SparkML hosting on Amazon SageMaker

.. toctree::
:maxdepth: 2

sagemaker.sparkml

********************************
SageMaker First-Party Algorithms
--------------------------------
********************************
Amazon provides implementations of some common machine learning algortithms optimized for GPU architecture and massive datasets.

.. toctree::
Expand All @@ -109,8 +125,9 @@ Amazon provides implementations of some common machine learning algortithms opti
pca
randomcutforest

*********
Workflows
---------
*********
SageMaker APIs to export configurations for creating and managing Airflow workflows.

.. toctree::
Expand Down
Loading