Skip to content

[Docs] De/Serializers no longer appear in the API doc #3976

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
athewsey opened this issue Jul 5, 2023 · 0 comments · Fixed by #4163
Closed

[Docs] De/Serializers no longer appear in the API doc #3976

athewsey opened this issue Jul 5, 2023 · 0 comments · Fixed by #4163
Assignees

Comments

@athewsey
Copy link
Collaborator

athewsey commented Jul 5, 2023

What did you find confusing? Please describe.

In releases since #3796, the available pre-built Serializer and Deserializer classes are no longer documented in the SDK API doc site. This makes it difficult for users to understand what alternative de/serializers are available (instead of just using the default ones for each framework's Predictor).

Describe how documentation can be improved

In #3796, the pre-built Serializer and Deserializer classes were moved from serializers.py and deserializers.py to base_serializers.py and base_deserializers.py respectively. The Serializers and Deserializers API doc pages used to list these out: For example see the Serializers doc @ v2.150.

However, these new base_* files aren't included in the auto-generated docs.

To improve the docs, we should ensure the available De/Serializer classes are included in the API reference so users can understand what's available.

It may also be worth having explicit guide somewhere mentioning how to override the de/serialization when running estimator.deploy(...), model.deploy(...) or new Predictor(...)?

Additional context

N/A

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