Skip to content

Docs of some functions written are missing #2649

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
2 tasks done
oke-aditya opened this issue Sep 8, 2020 · 3 comments · Fixed by #2654
Closed
2 tasks done

Docs of some functions written are missing #2649

oke-aditya opened this issue Sep 8, 2020 · 3 comments · Fixed by #2654

Comments

@oke-aditya
Copy link
Contributor

oke-aditya commented Sep 8, 2020

📚 Documentation

A simple issue, Docs are missing on the torchvision website for following functions written in torchvision.

I guess we should add these docs on the webpage, as end-users will benefit from using these functions.

Most people will not look at source code to find these functions but refer to docs.

Missing docs that I found

Please do let me know if some other docs or missing as well.

Also, I can raise a PR to fix these, please do let me know if it is needed!

@vfdev-5
Copy link
Collaborator

vfdev-5 commented Sep 8, 2020

@oke-aditya thanks for reporting :)

Concerning "Image reading functions", it is only master version and does not exist yet in the stable version, right ?

About torchvision ops from boxes.py, yes, seems like some docstrings are missing in https://pytorch.org/docs/stable/torchvision/ops.html which can be easily added.

So, yes, please, send a PR for fixing missing functions in docs for boxes.py.

@oke-aditya
Copy link
Contributor Author

For image reading functions, docs do not exist for both, master as well as stable.

Please verify once io.rst

@vfdev-5
Copy link
Collaborator

vfdev-5 commented Sep 8, 2020

Yes, you are right, docs for master version are also missing image reading functions. A PR for that could also help :)

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