Skip to content

Commit 304baa9

Browse files
committed
doc: mention FrameworkProcessor in dev guide
Add API TOC entries for the FrameworkProcessor classes and briefly mention them in the processing overview guide.
1 parent 9b437be commit 304baa9

File tree

6 files changed

+53
-2
lines changed

6 files changed

+53
-2
lines changed

doc/amazon_sagemaker_processing.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,14 @@ For an in-depth look, please see the `Feature Transformation with Spark`_ exampl
221221
.. _Feature Transformation with Spark: https://github.com/awslabs/amazon-sagemaker-examples/blob/master/sagemaker_processing/feature_transformation_with_sagemaker_processing/feature_transformation_with_sagemaker_processing.ipynb
222222

223223

224+
Data Processing with Other Frameworks
225+
=====================================
226+
227+
:class:`FrameworkProcessor`-based classes are also provided for a range of other ML frameworks: For example PyTorch, TensorFlow, and MXNet.
228+
229+
You can use these to run data processing jobs in pre-built container environments, similarly to model training with :class:`Framework`-based Estimators.
230+
231+
224232
Learn More
225233
==========
226234

@@ -229,12 +237,18 @@ Processing class documentation
229237

230238
- :class:`sagemaker.processing.Processor`
231239
- :class:`sagemaker.processing.ScriptProcessor`
240+
- :class:`sagemaker.processing.FrameworkProcessor`
232241
- :class:`sagemaker.sklearn.processing.SKLearnProcessor`
233242
- :class:`sagemaker.spark.processing.PySparkProcessor`
234243
- :class:`sagemaker.spark.processing.SparkJarProcessor`
235244
- :class:`sagemaker.processing.ProcessingInput`
236245
- :class:`sagemaker.processing.ProcessingOutput`
237246
- :class:`sagemaker.processing.ProcessingJob`
247+
- :class:`sagemaker.huggingface.processing.HuggingFaceProcessor`
248+
- :class:`sagemaker.mxnet.processing.MXNetProcessor`
249+
- :class:`sagemaker.pytorch.processing.PyTorchProcessor`
250+
- :class:`sagemaker.tensorflow.processing.TensorFlowProcessor`
251+
- :class:`sagemaker.xgboost.processing.XGBoostProcessor`
238252

239253

240254
Further documentation

doc/frameworks/huggingface/sagemaker.huggingface.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,18 @@ Hugging Face Model
1717
:undoc-members:
1818
:show-inheritance:
1919

20-
HuggingFace Predictor
21-
---------------------
20+
Hugging Face Predictor
21+
----------------------
2222

2323
.. autoclass:: sagemaker.huggingface.model.HuggingFacePredictor
2424
:members:
2525
:undoc-members:
2626
:show-inheritance:
27+
28+
Hugging Face Processor
29+
----------------------
30+
31+
.. autoclass:: sagemaker.huggingface.processing.HuggingFaceProcessor
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:

doc/frameworks/mxnet/sagemaker.mxnet.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,11 @@ MXNet Predictor
2525
:members:
2626
:undoc-members:
2727
:show-inheritance:
28+
29+
MXNet Processor
30+
---------------------------
31+
32+
.. autoclass:: sagemaker.mxnet.processing.MXNetProcessor
33+
:members:
34+
:undoc-members:
35+
:show-inheritance:

doc/frameworks/pytorch/sagemaker.pytorch.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,11 @@ PyTorch Predictor
2424
:members:
2525
:undoc-members:
2626
:show-inheritance:
27+
28+
PyTorch Processor
29+
-----------------
30+
31+
.. autoclass:: sagemaker.pytorch.processing.PyTorchProcessor
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:

doc/frameworks/tensorflow/sagemaker.tensorflow.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,11 @@ TensorFlow Serving Predictor
2525
:members:
2626
:undoc-members:
2727
:show-inheritance:
28+
29+
TensorFlow Processor
30+
--------------------
31+
32+
.. autoclass:: sagemaker.tensorflow.processing.TensorFlowProcessor
33+
:members:
34+
:undoc-members:
35+
:show-inheritance:

doc/frameworks/xgboost/xgboost.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,8 @@ The Amazon SageMaker XGBoost open source framework algorithm.
1616
:members:
1717
:undoc-members:
1818
:show-inheritance:
19+
20+
.. autoclass:: sagemaker.xgboost.processing.XGBoostProcessor
21+
:members:
22+
:undoc-members:
23+
:show-inheritance:

0 commit comments

Comments
 (0)