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..26a0c56c73 --- /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..d36b2c7e50 --- /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..123ca87b4e --- /dev/null +++ b/doc/sagemaker.rl.rst @@ -0,0 +1,10 @@ +RLEstimator +=========== + +RLEstimator Estimator +--------------------- + +.. autoclass:: sagemaker.rl.estimator.RLEstimator + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/sagemaker.tensorflow.rst b/doc/sagemaker.tensorflow.rst index 52286d7edb..5107afcfc2 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: 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