Skip to content

Commit a1893fa

Browse files
authored
Add readme docs for chainer, pytorch, rl and tensorflow serving. (#546)
1 parent c217a4c commit a1893fa

File tree

6 files changed

+101
-7
lines changed

6 files changed

+101
-7
lines changed

doc/index.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,24 @@ A managed environment for TensorFlow training and hosting on Amazon SageMaker
3939

4040
sagemaker.tensorflow
4141

42+
PyTorch
43+
-------
44+
A managed environment for PyTorch training and hosting on Amazon SageMaker
45+
46+
.. toctree::
47+
:maxdepth: 2
48+
49+
sagemaker.pytorch
50+
51+
Chainer
52+
-------
53+
A managed environment for Chainer training and hosting on Amazon SageMaker
54+
55+
.. toctree::
56+
:maxdepth: 2
57+
58+
sagemaker.chainer
59+
4260
Reinforcement Learning
4361
----------------------
4462
A managed environment for Reinforcement Learning training and hosting on Amazon SageMaker

doc/sagemaker.chainer.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Chainer
2+
=======
3+
4+
Chainer Estimator
5+
-----------------
6+
7+
.. autoclass:: sagemaker.chainer.estimator.Chainer
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
11+
12+
Chainer Model
13+
-------------
14+
15+
.. autoclass:: sagemaker.chainer.model.ChainerModel
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
Chainer Predictor
21+
-----------------
22+
23+
.. autoclass:: sagemaker.chainer.model.ChainerPredictor
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:

doc/sagemaker.pytorch.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
PyTorch
2+
=======
3+
4+
PyTorch Estimator
5+
-----------------
6+
7+
.. autoclass:: sagemaker.pytorch.estimator.PyTorch
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
11+
12+
PyTorch Model
13+
-------------
14+
15+
.. autoclass:: sagemaker.pytorch.model.PyTorchModel
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
PyTorch Predictor
21+
-----------------
22+
23+
.. autoclass:: sagemaker.pytorch.model.PyTorchPredictor
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:

doc/sagemaker.rl.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
RLEstimator
2+
===========
3+
4+
RLEstimator Estimator
5+
---------------------
6+
7+
.. autoclass:: sagemaker.rl.estimator.RLEstimator
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:

doc/sagemaker.tensorflow.rst

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,43 @@
11
TensorFlow
2-
======================
2+
==========
33

44

55
TensorFlow Estimator
6-
--------------------------------
6+
--------------------
77

88
.. autoclass:: sagemaker.tensorflow.estimator.TensorFlow
99
:members:
1010
:undoc-members:
1111
:show-inheritance:
1212

1313
TensorFlow Model
14-
--------------------------------
14+
----------------
1515

1616
.. autoclass:: sagemaker.tensorflow.model.TensorFlowModel
1717
:members:
1818
:undoc-members:
1919
:show-inheritance:
2020

2121
TensorFlow Predictor
22-
--------------------------------
22+
--------------------
2323

2424
.. autoclass:: sagemaker.tensorflow.model.TensorFlowPredictor
2525
:members:
2626
:undoc-members:
2727
:show-inheritance:
2828

29+
TensorFlow Serving Model
30+
------------------------
31+
32+
.. autoclass:: sagemaker.tensorflow.serving.Model
33+
:members:
34+
:undoc-members:
35+
:show-inheritance:
36+
37+
TensorFlow Serving Predictor
38+
----------------------------
39+
40+
.. autoclass:: sagemaker.tensorflow.serving.Predictor
41+
:members:
42+
:undoc-members:
43+
:show-inheritance:

src/sagemaker/rl/estimator.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,9 +113,8 @@ def __init__(self, entry_point, toolkit=None, toolkit_version=None, framework=No
113113
image_name (str): An ECR url. If specified, the estimator will use this image
114114
for training and hosting, instead of selecting the appropriate SageMaker
115115
official image based on framework_version and py_version.
116-
Examples:
117-
123.dkr.ecr.us-west-2.amazonaws.com/my-custom-image:1.0
118-
metric_definitions (list[dict]): A list of dictionaries that defines the metric(s)
116+
Example: 123.dkr.ecr.us-west-2.amazonaws.com/my-custom-image:1.0
117+
metric_definitions (list[dict]): A list of dictionaries that defines the metric(s)
119118
used to evaluate the training jobs. Each dictionary contains two keys:
120119
'Name' for the name of the metric, and 'Regex' for the regular expression used to
121120
extract the metric from the logs. This should be defined only for jobs

0 commit comments

Comments
 (0)