From a131f232f977cfadd889afa9711db102168cc88e Mon Sep 17 00:00:00 2001 From: Nadia Yakimakha <32335935+nadiaya@users.noreply.github.com> Date: Tue, 11 Dec 2018 15:16:13 -0800 Subject: [PATCH 1/4] Add readme docs for chainer, pytorch and rl. --- doc/index.rst | 18 ++++++++++++++++++ doc/sagemaker.chainer.rst | 26 ++++++++++++++++++++++++++ doc/sagemaker.pytorch.rst | 26 ++++++++++++++++++++++++++ doc/sagemaker.rl.rst | 10 ++++++++++ 4 files changed, 80 insertions(+) create mode 100644 doc/sagemaker.chainer.rst create mode 100644 doc/sagemaker.pytorch.rst create mode 100644 doc/sagemaker.rl.rst diff --git a/doc/index.rst b/doc/index.rst index aa9dfc0706..db74369e73 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -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 diff --git a/doc/sagemaker.chainer.rst b/doc/sagemaker.chainer.rst new file mode 100644 index 0000000000..f81f48bda9 --- /dev/null +++ b/doc/sagemaker.chainer.rst @@ -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: diff --git a/doc/sagemaker.pytorch.rst b/doc/sagemaker.pytorch.rst new file mode 100644 index 0000000000..f5cbb31a3c --- /dev/null +++ b/doc/sagemaker.pytorch.rst @@ -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: diff --git a/doc/sagemaker.rl.rst b/doc/sagemaker.rl.rst new file mode 100644 index 0000000000..6cb70d06a6 --- /dev/null +++ b/doc/sagemaker.rl.rst @@ -0,0 +1,10 @@ +RLEstimator +================= + +RLEstimator Estimator +--------------------------- + +.. autoclass:: sagemaker.rl.estimator.RLEstimator + :members: + :undoc-members: + :show-inheritance: From 179014255798fe5d6473ad8de097bfa1792dc279 Mon Sep 17 00:00:00 2001 From: Nadia Yakimakha <32335935+nadiaya@users.noreply.github.com> Date: Tue, 11 Dec 2018 15:35:46 -0800 Subject: [PATCH 2/4] Add tensorflow serving docs. --- doc/sagemaker.chainer.rst | 8 ++++---- doc/sagemaker.pytorch.rst | 8 ++++---- doc/sagemaker.rl.rst | 4 ++-- doc/sagemaker.tensorflow.rst | 23 +++++++++++++++++++---- 4 files changed, 29 insertions(+), 14 deletions(-) diff --git a/doc/sagemaker.chainer.rst b/doc/sagemaker.chainer.rst index f81f48bda9..26a0c56c73 100644 --- a/doc/sagemaker.chainer.rst +++ b/doc/sagemaker.chainer.rst @@ -1,8 +1,8 @@ Chainer -================= +======= Chainer Estimator ---------------------------- +----------------- .. autoclass:: sagemaker.chainer.estimator.Chainer :members: @@ -10,7 +10,7 @@ Chainer Estimator :show-inheritance: Chainer Model ---------------------------- +------------- .. autoclass:: sagemaker.chainer.model.ChainerModel :members: @@ -18,7 +18,7 @@ Chainer Model :show-inheritance: Chainer Predictor ---------------------------- +----------------- .. autoclass:: sagemaker.chainer.model.ChainerPredictor :members: diff --git a/doc/sagemaker.pytorch.rst b/doc/sagemaker.pytorch.rst index f5cbb31a3c..d36b2c7e50 100644 --- a/doc/sagemaker.pytorch.rst +++ b/doc/sagemaker.pytorch.rst @@ -1,8 +1,8 @@ PyTorch -================= +======= PyTorch Estimator ---------------------------- +----------------- .. autoclass:: sagemaker.pytorch.estimator.PyTorch :members: @@ -10,7 +10,7 @@ PyTorch Estimator :show-inheritance: PyTorch Model ---------------------------- +------------- .. autoclass:: sagemaker.pytorch.model.PyTorchModel :members: @@ -18,7 +18,7 @@ PyTorch Model :show-inheritance: PyTorch Predictor ---------------------------- +----------------- .. autoclass:: sagemaker.pytorch.model.PyTorchPredictor :members: diff --git a/doc/sagemaker.rl.rst b/doc/sagemaker.rl.rst index 6cb70d06a6..123ca87b4e 100644 --- a/doc/sagemaker.rl.rst +++ b/doc/sagemaker.rl.rst @@ -1,8 +1,8 @@ RLEstimator -================= +=========== RLEstimator Estimator ---------------------------- +--------------------- .. autoclass:: sagemaker.rl.estimator.RLEstimator :members: diff --git a/doc/sagemaker.tensorflow.rst b/doc/sagemaker.tensorflow.rst index 52286d7edb..94844581cd 100644 --- a/doc/sagemaker.tensorflow.rst +++ b/doc/sagemaker.tensorflow.rst @@ -1,9 +1,9 @@ TensorFlow -====================== +========== TensorFlow Estimator --------------------------------- +-------------------- .. autoclass:: sagemaker.tensorflow.estimator.TensorFlow :members: @@ -11,7 +11,7 @@ TensorFlow Estimator :show-inheritance: TensorFlow Model --------------------------------- +---------------- .. autoclass:: sagemaker.tensorflow.model.TensorFlowModel :members: @@ -19,10 +19,25 @@ TensorFlow Model :show-inheritance: TensorFlow Predictor --------------------------------- +-------------------- .. autoclass:: sagemaker.tensorflow.model.TensorFlowPredictor :members: :undoc-members: :show-inheritance: +TensorFlow Serving Model +-------------------- + +.. autoclass:: sagemaker.tensorflow.serving.Model + :members: + :undoc-members: + :show-inheritance: + +TensorFlow Serving Predictor +-------------------- + +.. autoclass:: sagemaker.tensorflow.serving.Predictor + :members: + :undoc-members: + :show-inheritance: From f3fcc7dc4b7a6cfab69aab19cf5b9c5b3c8cddf6 Mon Sep 17 00:00:00 2001 From: Nadia Yakimakha <32335935+nadiaya@users.noreply.github.com> Date: Tue, 11 Dec 2018 15:52:21 -0800 Subject: [PATCH 3/4] Fix rendering. --- src/sagemaker/rl/estimator.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/src/sagemaker/rl/estimator.py b/src/sagemaker/rl/estimator.py index c2fb880f14..d663b05164 100644 --- a/src/sagemaker/rl/estimator.py +++ b/src/sagemaker/rl/estimator.py @@ -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 From 0b7d70e278b7d6a8a380ce94102712cfe06d7ebe Mon Sep 17 00:00:00 2001 From: Nadia Yakimakha <32335935+nadiaya@users.noreply.github.com> Date: Tue, 11 Dec 2018 16:06:16 -0800 Subject: [PATCH 4/4] Fix ---. --- doc/sagemaker.tensorflow.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/sagemaker.tensorflow.rst b/doc/sagemaker.tensorflow.rst index 94844581cd..5107afcfc2 100644 --- a/doc/sagemaker.tensorflow.rst +++ b/doc/sagemaker.tensorflow.rst @@ -27,7 +27,7 @@ TensorFlow Predictor :show-inheritance: TensorFlow Serving Model --------------------- +------------------------ .. autoclass:: sagemaker.tensorflow.serving.Model :members: @@ -35,7 +35,7 @@ TensorFlow Serving Model :show-inheritance: TensorFlow Serving Predictor --------------------- +---------------------------- .. autoclass:: sagemaker.tensorflow.serving.Predictor :members: