RaivoKoot/Video-Dataset-Loading-Pytorch

Generic PyTorch dataset implementation to load and augment VIDEOS for deep learning training loops.

Efficient Video Dataset Loading and Augmentation in PyTorch

Author: Raivo Koot
https://video-dataset-loading-pytorch.readthedocs.io/en/latest/VideoDataset.html
If you find the code useful, please star the repository.

If you are completely unfamiliar with loading datasets in PyTorch using torch.utils.data.Dataset and torch.utils.data.DataLoader, I recommend getting familiar with these first through this or this.

In a Nutshell

Video-Dataset-Loading-Pytorch provides the lowest entry barrier for setting up deep learning training loops on video data. It makes working with video datasets easy and accessible (also efficient!). It only requires you to have your video dataset in a certain format on disk and takes care of the rest. No complicated dependencies and it supports native Torchvision video data augmentation.

Overview: This small library solely provides the class VideoFrameDataset

The VideoFrameDataset class (an implementation of torch.utils.data.Dataset) serves to easily, efficiently and effectively load video samples from video datasets in PyTorch.

1. Easily because this dataset class can be used with custom datasets with minimum effort and no modification. The class merely expects the video dataset to have a certain structure on disk and expects a .txt annotation file that enumerates each video sample. Details on this can be found below. Pre-made annotation files and preparation scripts are also provided for Kinetics 400, Something Something V2 and Epic Kitchens 100.
2. Efficiently because the video loading pipeline that this class implements is very fast. This minimizes GPU waiting time during training by eliminating CPU input bottlenecks that can slow down training time by several folds.
3. Effectively because the implemented sampling strategy for video frames is very representative. Video training using the entire sequence of video frames (often several hundred) is too memory and compute intense. Therefore, this implementation samples frames evenly from the video (sparse temporal sampling) so that the loaded frames represent every part of the video, with support for arbitrary and differing video lengths within the same dataset. This approach has shown to be very effective and is taken from "Temporal Segment Networks (ECCV2016)" with modifications.

In conjunction with PyTorch's DataLoader, the VideoFrameDataset class returns video batch tensors of size BATCH x FRAMES x CHANNELS x HEIGHT x WIDTH.

For a demo, visit demo.py.

QuickDemo (demo.py)

root = os.path.join(os.getcwd(), 'demo_dataset')  # Folder in which all videos lie in a specific structure
annotation_file = os.path.join(root, 'annotations.txt')  # A row for each video sample as: (VIDEO_PATH START_FRAME END_FRAME CLASS_ID)

""" DEMO 1 WITHOUT IMAGE TRANSFORMS """
dataset = VideoFrameDataset(
    root_path=root,
    annotationfile_path=annotation_file,
    num_segments=5,
    frames_per_segment=1,
    imagefile_template='img_{:05d}.jpg',
    transform=None,
    test_mode=False
)

sample = dataset[0]  # take first sample of dataset 
frames = sample[0]   # list of PIL images
label = sample[1]    # integer label

for image in frames:
    plt.imshow(image)
    plt.title(label)
    plt.show()
    plt.pause(1)

Table of Contents

• 1. Requirements
• 2. Custom Dataset
• 3. Video Frame Sampling Method
• 4. Alternate Video Frame Sampling Methods
• 5. Using VideoFrameDataset for Training
• 6. Allowing Multiple Labels per Sample
• 7. Conclusion
• 8. Kinetics 400 & Something Something V2 & EPIC-KITCHENS-100
• 9. Upcoming Features
• 10. Acknowledgements

1. Requirements

# Without these three, VideoFrameDataset will not work.
torchvision >= 0.8.0
torch >= 1.7.0
python >= 3.6

2. Custom Dataset

(This description explains using custom datasets where each sample has a single class label. If you want to know how to use a dataset where a sample can have more than a single class label, read this anyways and then read 6. below)

To use any dataset, two conditions must be met.

1. The video data must be supplied as RGB frames, each frame saved as an image file. Each video must have its own folder, in which the frames of that video lie. The frames of a video inside its folder must be named uniformly with consecutive indices such as img_00001.jpg ... img_00120.jpg, if there are 120 frames. Indices can start at zero or any other number and the exact file name template can be chosen freely. The filename template for frames in this example is "img_{:05d}.jpg" (python string formatting, specifying 5 digits after the underscore), and must be supplied to the constructor of VideoFrameDataset as a parameter. Each video folder must lie inside some root folder.
2. To enumerate all video samples in the dataset and their required metadata, a .txt annotation file must be manually created that contains a row for each video clip sample in the dataset. The training, validation, and testing datasets must have separate annotation files. Each row must be a space-separated list that contains VIDEO_PATH START_FRAME END_FRAME CLASS_INDEX. The VIDEO_PATH of a video sample should be provided without the root prefix of this dataset.

This example project demonstrates this using a dummy dataset inside of demo_dataset/, which is the root dataset folder of this example. The folder structure looks as follows:

demo_dataset
│
├───annotations.txt
├───jumping # arbitrary class folder naming
│       ├───0001  # arbitrary video folder naming
│       │     ├───img_00001.jpg
│       │     .
│       │     └───img_00017.jpg
│       └───0002
│             ├───img_00001.jpg
│             .
│             └───img_00018.jpg
│
└───running # arbitrary folder naming
        ├───0001  # arbitrary video folder naming
        │     ├───img_00001.jpg
        │     .
        │     └───img_00015.jpg
        └───0002
              ├───img_00001.jpg
              .
              └───img_00015.jpg

 

The accompanying annotation .txt file contains the following rows (PATH, START_FRAME, END_FRAME, LABEL_ID)

jumping/0001 1 17 0
jumping/0002 1 18 0
running/0001 1 15 1
running/0002 1 15 1

Another annotations file that uses multiple clips from each video could be

jumping/0001 1 8 0
jumping/0001 5 17 0
jumping/0002 1 18 0
running/0001 10 15 1
running/0001 5 10 1
running/0002 1 15 1

(END_FRAME is inclusive)

Another, simpler, example of the way your dataset's RGB frames can be organized on disk is the following:

demo_dataset
│
├───annotations.txt
└───rgb 
     ├───video_1
     │     ├───img_00001.jpg
     │     .
     │     └───img_00017.jpg
     ├───video_2
     │     ├───img_00001.jpg
     │     .
     │     └───img_00044.jpg
     └───video_3
           ├───img_00001.jpg
           .
           └───img_00023.jpg

 

The accompanying annotation .txt file contains the following rows (PATH, START_FRAME, END_FRAME, LABEL_ID)

video_1 1 17 1
video_2 1 44 0
video_3 1 23 0

Instantiating a VideoFrameDataset with the root_path parameter pointing to demo_dataset/rgb/, the annotationsfile_path parameter pointing to the annotation file demo_dataset/annotations.txt, and the imagefile_template parameter as "img_{:05d}.jpg", is all that it takes to start using the VideoFrameDataset class.

3. Video Frame Sampling Method

When loading a video, only a number of its frames are loaded. They are chosen in the following way:

1. The frame index range [START_FRAME, END_FRAME] is divided into NUM_SEGMENTS even segments. From each segment, a random start-index is sampled from which FRAMES_PER_SEGMENT consecutive indices are loaded. This results in NUM_SEGMENTS*FRAMES_PER_SEGMENT chosen indices, whose frames are loaded as PIL images and put into a list and returned when calling dataset[i].

4. Alternate Video Frame Sampling Methods

If you do not want to use sparse temporal sampling and instead want to sample a single N-frame continuous clip from a video, this is possible. Set NUM_SEGMENTS=1 and FRAMES_PER_SEGMENT=N. Because VideoFrameDataset will chose a random start index per segment and take NUM_SEGMENTS continuous frames from each sampled start index, this will result in a single N-frame continuous clip per video that starts at a random index. An example of this is in demo.py.

5. Using VideoFrameDataset for training

As demonstrated in demo.py, we can use PyTorch's torch.utils.data.DataLoader class with VideoFrameDataset to take care of shuffling, batching, and more. To turn the lists of PIL images returned by VideoFrameDataset into tensors, the transform video_dataset.ImglistToTensor() can be supplied as the transform parameter to VideoFrameDataset. This turns a list of N PIL images into a batch of images/frames of shape N x CHANNELS x HEIGHT x WIDTH. We can further chain preprocessing and augmentation functions that act on batches of images onto the end of ImglistToTensor(), as seen in demo.py

As of torchvision 0.8.0, all torchvision transforms can now also operate on batches of images, and they apply deterministic or random transformations on the batch identically on all images of the batch. Because a single video-tensor (FRAMES x CHANNELS x HEIGHT x WIDTH) has the same shape as an image batch tensor (BATCH x CHANNELS x HEIGHT x WIDTH), any torchvision transform can be used here to apply video-uniform preprocessing and augmentation.

REMEMBER:
Pytorch transforms are applied to individual dataset samples (in this case a list of PIL images of a video, or a video-frame tensor after ImglistToTensor()) before batching. So, any transforms used here must expect its input to be a frame tensor of shape FRAMES x CHANNELS x HEIGHT x WIDTH or a list of PIL images if ImglistToTensor() is not used.

6. Allowing Multiple Labels per Sample

Your dataset labels might be more complicated than just a single label id per sample. For example, in the EPIC-KITCHENS dataset each video clip has a verb class, noun class, and action class. In this case, each sample is associated with three label ids. To accommodate for datasets where a sample can have N integer labels, annotation.txt files can be used where each row is space separated PATH, FRAME_START, FRAME_END, LABEL_1_ID, ..., LABEL_N_ID, instead of PATH, FRAME_START, FRAME_END, LABEL_ID. The VideoFrameDataset class can handle this type of annotation files too, without changing anything apart from the rows in your annotations.txt.

The annotations.txt file for a dataset where multiple clip samples can come from the same video and each sample has three labels, would have rows like PATH, START_FRAME, END_FRAME, LABEL1, LABEL2, LABEL3 as seen below

jumping/0001 1 8 0 2 1
jumping/0001 5 17 0 10 3
jumping/0002 1 18 0 5 3
running/0001 10 15 1 3 3
running/0001 5 10 1 1 0
running/0002 1 15 1 12 4

When you use torch.utils.data.DataLoader with VideoFrameDataset to retrieve your batches during training, the dataloader then no longer returns batches as a ( (BATCHxFRAMESxHEIGHTxWIDTH) , (BATCH) ) tuple, where the second item is just a list/tensor of the batch's labels. Instead, the second item is replaced with the tuple ( (BATCH) ... (BATCH) ) where the first BATCH-sized list gives label_1 for the whole batch, and the last BATCH-sized list gives label_n for the whole batch.

A demo of this can be found at the end in demo.py. It uses the dummy dataset in directory demo_dataset_multilabel.

7. Conclusion

A proper code-based explanation on how to use VideoFrameDataset for training is provided in demo.py

8. Kinetics 400 & Something Something V2 & EPIC-KITCHENS-100

After you have read Section 1 to 7, this repository also contains easy pre-made conversion scripts and annotation files to get you instantly started with the Kinetics 400 dataset, Something Something V2 dataset, and the EPIC-KITCHENS-100 dataset. To get started with either, read the README inside the Kinetics400, EpicKitchens100 or SomethingSomethingV2 directory.

9. Upcoming Features

• Include compatible annotation files for common datasets, such as Something-Something-V2, EPIC-KITCHENS-100 and Kinetics, so that users do not need to spend their own time converting those datasets' annotation files to be compatible with this repository.
• Add demo for sampling a single continous-frame clip from videos.
• Add support for arbitrary labels that are more than just a single integer.
• Add support for specifying START_FRAME and END_FRAME for a video instead of NUM_FRAMES.
• Improve the handling of edge cases where NUM_FRAMES*FRAM_PER_SEG (or similar) might be larger than the number of frames in a video. (a warning message is printed now)
• Clean up some of the internal code that is still very messy, which was taken from the below codebase.
• Create a version of this implementation that uses OpenCV instead of PIL for frame loading, so that you can use Albumentation transforms instead of Torchvision transforms.

10. Acknowledgements

We thank the authors of TSN for their codebase, from which we took VideoFrameDataset and adapted it for general use and compatibility.

@InProceedings{wang2016_TemporalSegmentNetworks,
    title={Temporal Segment Networks: Towards Good Practices for Deep Action Recognition},
    author={Limin Wang and Yuanjun Xiong and Zhe Wang and Yu Qiao and Dahua Lin and
            Xiaoou Tang and Luc {Val Gool}},
    booktitle={The European Conference on Computer Vision (ECCV)},
    year={2016}
}