Skip to content

Adds docs and Fixes Imports for ops and io #2654

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

Merged
merged 3 commits into from
Sep 18, 2020
Merged

Adds docs and Fixes Imports for ops and io #2654

merged 3 commits into from
Sep 18, 2020

Conversation

oke-aditya
Copy link
Contributor

@oke-aditya oke-aditya commented Sep 8, 2020

Closes #2649 .

Adds docs for

  • Image reading functions here

  • Torchvision ops from boxes.py.

Some functions were missing in the __init__.py files, I have added those imports too.
Please review and do let me know if changes are needed.

cc @vfdev-5 @fmassa @pmeier

@oke-aditya oke-aditya changed the title Adds docs and Fixes Improts for ops and io Adds docs and Fixes Imports for ops and io Sep 8, 2020
@codecov
Copy link

codecov bot commented Sep 8, 2020

Codecov Report

Merging #2654 into master will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2654   +/-   ##
=======================================
  Coverage   72.57%   72.57%           
=======================================
  Files          95       95           
  Lines        8249     8249           
  Branches     1309     1309           
=======================================
  Hits         5987     5987           
  Misses       1855     1855           
  Partials      407      407           
Impacted Files Coverage Δ
torchvision/io/__init__.py 100.00% <ø> (ø)
torchvision/ops/__init__.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7f5b2c4...5ebdc3f. Read the comment docs.

@pmeier pmeier requested a review from fmassa September 8, 2020 18:42
@vfdev-5
Copy link
Collaborator

vfdev-5 commented Sep 18, 2020

Hi @oke-aditya , sorry for delay, we discussed with @fmassa about this PR and we think that exposing decode_*/read_* from io module is not suitable as in future the idea is to provide a bit more generic functions like read and decode which could dispatch to those decode_*/read_* functions. Thus, user does not need to check the format and dispatch in his/her code. I'll open an issue to expose in details this idea.

For torchvision ops, they were not included in 0.3.0 release, but now we may consider them as more mature and make them public. Let me comment what we would to remove and we can merge this PR.

Copy link
Collaborator

@vfdev-5 vfdev-5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@oke-aditya I left few comment. If you could handle that it would be perfect and we can merge this PR after that. Thanks !

@oke-aditya
Copy link
Contributor Author

Ok @vfdev-5 sure, I will undo the changes from io module. I saw other PR being opened to revamp torchvision video reader and other APIs #2660 .

I will do changes as suggested 👍 and ask for a review once again

@oke-aditya oke-aditya requested a review from vfdev-5 September 18, 2020 17:18
Copy link
Collaborator

@vfdev-5 vfdev-5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM ! Thanks @oke-aditya !

@vfdev-5 vfdev-5 merged commit 2801a76 into pytorch:master Sep 18, 2020
@oke-aditya oke-aditya deleted the add_docs branch September 19, 2020 04:55
bryant1410 pushed a commit to bryant1410/vision-1 that referenced this pull request Nov 22, 2020
* Adds docs and fixes improts for ops and io

* reverts io and init for images
vfdev-5 pushed a commit to Quansight/vision that referenced this pull request Dec 4, 2020
* Adds docs and fixes improts for ops and io

* reverts io and init for images
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs of some functions written are missing
3 participants