Skip to content

Add FrameworkProcessor and inherited classes to the documentation #3513

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

Closed
paoloirrera opened this issue Dec 8, 2022 · 0 comments · Fixed by #4152
Closed

Add FrameworkProcessor and inherited classes to the documentation #3513

paoloirrera opened this issue Dec 8, 2022 · 0 comments · Fixed by #4152
Assignees

Comments

@paoloirrera
Copy link

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:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants