Skip to content

Add FrameworkProcessor and inherited classes to the documentation #3513

@paoloirrera

Description

@paoloirrera

What did you find confusing? Please describe.
I looked for documentation PyTorchProcessor on the documentation page and I did not find it because it is not in the doc folder. I had to look at the source code in src/sagemaker/processing.py to know how to correctly create an object of this class.

Describe how documentation can be improved
Update the documentation. For example, for PyTorchProcessor add to doc/frameworks/pytorch/sagemaker.pytorch.rst the following:

## PyTorch Processing
.. autoclass:: sagemaker.pytorch.processing.PyTorchProcessor
    :members:
    :undoc-members:
    :show-inheritance:

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions