Skip to content

refactor the navigation #1525

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 1 commit into from
May 26, 2020
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
15 changes: 15 additions & 0 deletions doc/airflow/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#################
Airflow Workflows
#################

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

.. toctree::
:maxdepth: 1

using_workflow

.. toctree::
:maxdepth: 2

sagemaker.workflow.airflow
File renamed without changes.
20 changes: 20 additions & 0 deletions doc/algorithms/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
######################
First-Party Algorithms
######################

Amazon SageMaker provides implementations of some common machine learning algorithms optimized for GPU architecture and massive datasets.

.. toctree::
:maxdepth: 2

sagemaker.amazon.amazon_estimator
factorization_machines
ipinsights
kmeans
knn
lda
linear_learner
ntm
object2vec
pca
randomcutforest
Copy link
Contributor

Choose a reason for hiding this comment

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

doesn't have to be in this PR, but is there a way to automate getting the list of algorithms (maybe using the glob trick)?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, we can totally do that ... it'll be alphabetical, so if we want any organization, then we'd want to rename the files to fit that org.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
12 changes: 12 additions & 0 deletions doc/api/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
####
APIs
####

The SageMaker Python SDK consists of a variety classes for training, inference and general utility:

.. toctree::
:maxdepth: 2

training/index
inference/index
utility/index
9 changes: 9 additions & 0 deletions doc/api/inference/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
##############
Inference APIs
##############

.. toctree::
:maxdepth: 1
:glob:

*
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
9 changes: 9 additions & 0 deletions doc/api/training/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#############
Training APIs
#############

.. toctree::
:maxdepth: 1
:glob:

*
File renamed without changes.
File renamed without changes.
File renamed without changes.
9 changes: 9 additions & 0 deletions doc/api/utility/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
############
Utility APIs
############

.. toctree::
:maxdepth: 1
:glob:

*
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
15 changes: 15 additions & 0 deletions doc/frameworks/chainer/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
##########################
Chainer
##########################

A managed environment for Chainer training and hosting on Amazon SageMaker

.. toctree::
:maxdepth: 1

using_chainer

.. toctree::
:maxdepth: 2

sagemaker.chainer
File renamed without changes.
17 changes: 17 additions & 0 deletions doc/frameworks/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
##########
Frameworks
##########

The SageMaker Python SDK supports managed training and inference for a variety of machine learning frameworks:

.. toctree::
:maxdepth: 2

mxnet/index
chainer/index
pytorch/index
rl/index
sklearn/index
sparkml/index
tensorflow/index
xgboost/index
15 changes: 15 additions & 0 deletions doc/frameworks/mxnet/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
########################
Apache MXNet
########################

A managed environment for MXNet training and hosting on Amazon SageMaker

.. toctree::
:maxdepth: 1

using_mxnet

.. toctree::
:maxdepth: 2

sagemaker.mxnet
File renamed without changes.
File renamed without changes.
9 changes: 9 additions & 0 deletions doc/frameworks/pytorch/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
##########################
PyTorch
##########################

.. toctree::
:maxdepth: 1
:glob:

*
File renamed without changes.
15 changes: 15 additions & 0 deletions doc/frameworks/rl/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#########################################
Reinforcement Learning
#########################################

A managed environment for Reinforcement Learning (RL) on Amazon SageMaker

.. toctree::
:maxdepth: 1

using_rl

.. toctree::
:maxdepth: 2

sagemaker.rl
File renamed without changes.
File renamed without changes.
15 changes: 15 additions & 0 deletions doc/frameworks/sklearn/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
###############################
Scikit-Learn
###############################

A managed environment for Scikit-Learn training and hosting on Amazon SageMaker

.. toctree::
:maxdepth: 1

using_sklearn

.. toctree::
:maxdepth: 2

sagemaker.sklearn
File renamed without changes.
10 changes: 10 additions & 0 deletions doc/frameworks/sparkml/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
##################################
SparkML Serving
##################################

A managed environment for SparkML Serving on Amazon SageMaker

.. toctree::
:maxdepth: 2

sagemaker.sparkml
15 changes: 15 additions & 0 deletions doc/frameworks/tensorflow/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#############################
TensorFlow
#############################

A managed environment for TensorFlow training and hosting on Amazon SageMaker

.. toctree::
:maxdepth: 1

using_tf

.. toctree::
:maxdepth: 2

sagemaker.tensorflow
7 changes: 5 additions & 2 deletions doc/using_tf.rst → doc/frameworks/tensorflow/using_tf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -621,12 +621,14 @@ The following content formats are supported without custom intput and output han
* JSON - specify ``application/json`` as the value of the ``content_type`` parameter.
* JSON lines - specify ``application/jsonlines`` as the value of the ``content_type`` parameter.

For detailed information about how TensorFlow Serving formats these data types for input and output, see :ref:`using_tf:TensorFlow Serving Input and Output`.
For detailed information about how TensorFlow Serving formats these data types for input and output, see :ref:`tensorflow-serving-input-output`.

You can also accept any custom data format by writing input and output functions, and include them in the ``inference.py`` file in your model.
For information, see :ref:`using_tf:Create Python Scripts for Custom Input and Output Formats`.
For information, see :ref:`custom-input-output`.


.. _tensorflow-serving-input-output:

TensorFlow Serving Input and Output
===================================

Expand Down Expand Up @@ -750,6 +752,7 @@ convert them to CSV, but the client-size CSV conversion is more sophisticated th
CSV parsing on the Endpoint, so if you encounter conversion problems, try using one of the
JSON options instead.

.. _custom-input-output:

Create Python Scripts for Custom Input and Output Formats
---------------------------------------------------------
Expand Down
9 changes: 9 additions & 0 deletions doc/frameworks/xgboost/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
##########################
XGBoost
##########################

.. toctree::
:maxdepth: 1
:glob:

*
File renamed without changes.
File renamed without changes.
Loading