Skip to content

Add readme docs for chainer, pytorch, rl and tensorflow serving. #546

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 4 commits into from
Dec 12, 2018
Merged
Show file tree
Hide file tree
Changes from 3 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
18 changes: 18 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,24 @@ A managed environment for TensorFlow training and hosting on Amazon SageMaker

sagemaker.tensorflow

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
Expand Down
26 changes: 26 additions & 0 deletions doc/sagemaker.chainer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Chainer
=======

Chainer Estimator
-----------------

.. autoclass:: sagemaker.chainer.estimator.Chainer
:members:
:undoc-members:
:show-inheritance:

Chainer Model
-------------

.. autoclass:: sagemaker.chainer.model.ChainerModel
:members:
:undoc-members:
:show-inheritance:

Chainer Predictor
-----------------

.. autoclass:: sagemaker.chainer.model.ChainerPredictor
:members:
:undoc-members:
:show-inheritance:
26 changes: 26 additions & 0 deletions doc/sagemaker.pytorch.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
PyTorch
=======

PyTorch Estimator
-----------------

.. autoclass:: sagemaker.pytorch.estimator.PyTorch
:members:
:undoc-members:
:show-inheritance:

PyTorch Model
-------------

.. autoclass:: sagemaker.pytorch.model.PyTorchModel
:members:
:undoc-members:
:show-inheritance:

PyTorch Predictor
-----------------

.. autoclass:: sagemaker.pytorch.model.PyTorchPredictor
:members:
:undoc-members:
:show-inheritance:
10 changes: 10 additions & 0 deletions doc/sagemaker.rl.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
RLEstimator
===========

RLEstimator Estimator
---------------------

.. autoclass:: sagemaker.rl.estimator.RLEstimator
:members:
:undoc-members:
:show-inheritance:
23 changes: 19 additions & 4 deletions doc/sagemaker.tensorflow.rst
Original file line number Diff line number Diff line change
@@ -1,28 +1,43 @@
TensorFlow
======================
==========


TensorFlow Estimator
--------------------------------
--------------------

.. autoclass:: sagemaker.tensorflow.estimator.TensorFlow
:members:
:undoc-members:
:show-inheritance:

TensorFlow Model
--------------------------------
----------------

.. autoclass:: sagemaker.tensorflow.model.TensorFlowModel
:members:
:undoc-members:
:show-inheritance:

TensorFlow Predictor
--------------------------------
--------------------

.. autoclass:: sagemaker.tensorflow.model.TensorFlowPredictor
:members:
:undoc-members:
:show-inheritance:

TensorFlow Serving Model
--------------------
Copy link
Contributor

Choose a reason for hiding this comment

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

make sure the header matches the text 😂


.. autoclass:: sagemaker.tensorflow.serving.Model
:members:
:undoc-members:
:show-inheritance:

TensorFlow Serving Predictor
--------------------

.. autoclass:: sagemaker.tensorflow.serving.Predictor
:members:
:undoc-members:
:show-inheritance:
5 changes: 2 additions & 3 deletions src/sagemaker/rl/estimator.py
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,8 @@ def __init__(self, entry_point, toolkit=None, toolkit_version=None, framework=No
image_name (str): An ECR url. If specified, the estimator will use this image
for training and hosting, instead of selecting the appropriate SageMaker
official image based on framework_version and py_version.
Examples:
123.dkr.ecr.us-west-2.amazonaws.com/my-custom-image:1.0
metric_definitions (list[dict]): A list of dictionaries that defines the metric(s)
Example: 123.dkr.ecr.us-west-2.amazonaws.com/my-custom-image:1.0
metric_definitions (list[dict]): A list of dictionaries that defines the metric(s)
used to evaluate the training jobs. Each dictionary contains two keys:
'Name' for the name of the metric, and 'Regex' for the regular expression used to
extract the metric from the logs. This should be defined only for jobs
Expand Down