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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,16 @@
CHANGELOG
=========


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

* doc-fix: Remove incorrect parameter for EI TFS Python README
* feature: ``Predictor``: delete SageMaker model
* feature: ``Pipeline``: delete SageMaker model
* bug-fix: Estimator.attach works with training jobs without hyperparameters
* doc-fix: remove duplicate content from mxnet/README.rst
* doc-fix: move overview content in main README into sphynx project
* bug-fix: pass accelerator_type in ``deploy`` for REST API TFS ``Model``

1.18.3.post1
Expand Down
43 changes: 30 additions & 13 deletions doc/index.rst
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 an 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.

********
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