Skip to content

doc: document name changes for TFS classes #1756

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
Jul 28, 2020
Merged
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
21 changes: 20 additions & 1 deletion doc/v2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -187,15 +187,34 @@ Specify Custom Serving Image

The ``image`` parameter has been renamed to ``image_uri`` for specifying a custom Docker image URI to use with inference.

TensorFlow Serving Model
~~~~~~~~~~~~~~~~~~~~~~~~

``sagemaker.tensorflow.serving.Model`` has been renamed to :class:`sagemaker.tensorflow.model.TensorFlowModel`.
(For the previous implementation of that class, see `Deprecate Legacy TensorFlow <#deprecate-legacy-tensorflow>`_).

Predictors
----------

Generic Predictor Class Name
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

``sagemaker.predictor.RealTimePredictor`` has been renamed to :class:`sagemaker.predictor.Predictor`.

In addition, for :class:`sagemaker.predictor.Predictor`, :class:`sagemaker.sparkml.model.SparkMLPredictor`,
Endpoint Argument Name
~~~~~~~~~~~~~~~~~~~~~~

For :class:`sagemaker.predictor.Predictor`, :class:`sagemaker.sparkml.model.SparkMLPredictor`,
and predictors for Amazon algorithm (e.g. Factorization Machines, Linear Learner, etc.),
the ``endpoint`` attribute has been renamed to ``endpoint_name``.

TensorFlow Serving Predictor
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

``sagemaker.tensorflow.serving.Predictor`` has been renamed to :class:`sagemaker.tensorflow.model.TensorFlowPredictor`.
(For the previous implementation of that class, see `Deprecate Legacy TensorFlow <#deprecate-legacy-tensorflow>`_).


Airflow
-------

Expand Down