-
Notifications
You must be signed in to change notification settings - Fork 7k
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
Cleanup README.md #7847
Merged
Merged
Cleanup README.md #7847
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,37 @@ | ||
Reading/Writing images and videos | ||
================================= | ||
Decoding / Encoding images and videos | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just moved the image section before the video one. |
||
===================================== | ||
|
||
.. currentmodule:: torchvision.io | ||
|
||
The :mod:`torchvision.io` package provides functions for performing IO | ||
operations. They are currently specific to reading and writing video and | ||
images. | ||
operations. They are currently specific to reading and writing images and | ||
videos. | ||
|
||
Images | ||
------ | ||
|
||
.. autosummary:: | ||
:toctree: generated/ | ||
:template: function.rst | ||
|
||
read_image | ||
decode_image | ||
encode_jpeg | ||
decode_jpeg | ||
write_jpeg | ||
encode_png | ||
decode_png | ||
write_png | ||
read_file | ||
write_file | ||
|
||
.. autosummary:: | ||
:toctree: generated/ | ||
:template: class.rst | ||
|
||
ImageReadMode | ||
|
||
|
||
|
||
Video | ||
----- | ||
|
@@ -20,7 +46,7 @@ Video | |
|
||
|
||
Fine-grained video API | ||
---------------------- | ||
^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
In addition to the :mod:`read_video` function, we provide a high-performance | ||
lower-level API for more fine-grained control compared to the :mod:`read_video` function. | ||
|
@@ -61,28 +87,3 @@ Example of inspecting a video: | |
# the constructor we select a default video stream, but | ||
# in practice, we can set whichever stream we would like | ||
video.set_current_stream("video:0") | ||
|
||
|
||
Image | ||
----- | ||
|
||
.. autosummary:: | ||
:toctree: generated/ | ||
:template: class.rst | ||
|
||
ImageReadMode | ||
|
||
.. autosummary:: | ||
:toctree: generated/ | ||
:template: function.rst | ||
|
||
read_image | ||
decode_image | ||
encode_jpeg | ||
decode_jpeg | ||
write_jpeg | ||
encode_png | ||
decode_png | ||
write_png | ||
read_file | ||
write_file |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure this section is relevant these days. I'm tempted to remove it. @pmeier @vfdev-5 any thought?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK to me
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess I'll just keep it for now. I wouldn't even know what to do with the "video backend" section either...