Unverified Commit fdb1baa0 authored by Steven Liu's avatar Steven Liu Committed by GitHub
Browse files

[docs] VideoProcessor (#7965)

* fix?

* fix?

* fix
parent 6529ee67
...@@ -12,4 +12,10 @@ specific language governing permissions and limitations under the License. ...@@ -12,4 +12,10 @@ specific language governing permissions and limitations under the License.
# Video Processor # Video Processor
The `VideoProcessor` provides a unified API for video pipelines to prepare inputs for VAE encoding and post-processing outputs once they're decoded. The class inherits [`VaeImageProcessor`] so it includes transformations such as resizing, normalization, and conversion between PIL Image, PyTorch, and NumPy arrays. The [`VideoProcessor`] provides a unified API for video pipelines to prepare inputs for VAE encoding and post-processing outputs once they're decoded. The class inherits [`VaeImageProcessor`] so it includes transformations such as resizing, normalization, and conversion between PIL Image, PyTorch, and NumPy arrays.
\ No newline at end of file
## VideoProcessor
[[autodoc]] video_processor.VideoProcessor.preprocess_video
[[autodoc]] video_processor.VideoProcessor.postprocess_video
...@@ -30,17 +30,19 @@ class VideoProcessor(VaeImageProcessor): ...@@ -30,17 +30,19 @@ class VideoProcessor(VaeImageProcessor):
Preprocesses input video(s). Preprocesses input video(s).
Args: Args:
video: The input video. It can be one of the following: video (`List[PIL.Image]`, `List[List[PIL.Image]]`, `torch.Tensor`, `np.array`, `List[torch.Tensor]`, `List[np.array]`):
The input video. It can be one of the following:
* List of the PIL images. * List of the PIL images.
* List of list of PIL images. * List of list of PIL images.
* 4D Torch tensors (expected shape for each tensor: (num_frames, num_channels, height, width)). * 4D Torch tensors (expected shape for each tensor `(num_frames, num_channels, height, width)`).
* 4D NumPy arrays (expected shape for each array: (num_frames, height, width, num_channels)). * 4D NumPy arrays (expected shape for each array `(num_frames, height, width, num_channels)`).
* List of 4D Torch tensors (expected shape for each tensor: (num_frames, num_channels, height, width)). * List of 4D Torch tensors (expected shape for each tensor `(num_frames, num_channels, height,
* List of 4D NumPy arrays (expected shape for each array: (num_frames, height, width, num_channels)). width)`).
* 5D NumPy arrays: expected shape for each array: (batch_size, num_frames, height, width, * List of 4D NumPy arrays (expected shape for each array `(num_frames, height, width, num_channels)`).
num_channels). * 5D NumPy arrays: expected shape for each array `(batch_size, num_frames, height, width,
* 5D Torch tensors: expected shape for each array: (batch_size, num_frames, num_channels, height, num_channels)`.
width). * 5D Torch tensors: expected shape for each array `(batch_size, num_frames, num_channels, height,
width)`.
height (`int`, *optional*, defaults to `None`): height (`int`, *optional*, defaults to `None`):
The height in preprocessed frames of the video. If `None`, will use the `get_default_height_width()` to The height in preprocessed frames of the video. If `None`, will use the `get_default_height_width()` to
get default height. get default height.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment