Skip to content
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

Generate and publish Python API docs #77

Open
ScottTodd opened this issue Aug 13, 2024 · 0 comments
Open

Generate and publish Python API docs #77

ScottTodd opened this issue Aug 13, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@ScottTodd
Copy link
Member

(Issue migrated from nod-ai/SHARK-ModelDev#106)


Users would find it helpful to view API documentation pages instead of just needing to read through source files, samples, and tests. I would also like to link to API docs from https://iree.dev/guides/ml-frameworks/pytorch/.

IREE Python used readthedocs (with mixed results): https://iree-python-api.readthedocs.io/en/latest/

Could see what PyTorch uses for https://pytorch.org/docs/stable/index.html (sample page: torch.nn.Linear)

Even if we don't end up publishing API docs, going through and adding docstrings and help text could still be useful.

@ScottTodd ScottTodd added the documentation Improvements or additions to documentation label Aug 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant