Skip to main content

Keras sequence generators for video data

Project description

PyPI version Build Status

Keras Sequence Video generators

This package proposes some classes to work with Keras (included in TensorFlow) that generates batches of frames from video files.

It is useful to work with Time Distributed Layer with Video input (frames). Then you may use GRU or LSTM. See articles:

An provided example of usage can be displayed in nbviewer here.

Requirements are:

  • Python >= 3.6 (Python 2 will never been supported)
  • OpenCV
  • numpy
  • Keras >= 2
  • TensorFlow >= 1.15 (or other backend, not tested, TensorFlow is needed by Keras)

TensorFlow 2 works as well. This requirements is not integrated in the to let you choose the version, or to let you try with other backend. We mean that you will need to install a backend yourself (e.g. pip install tensorflow)

If you want to compile the package, you need:

  • sphinx to compile doc (work in progress)
  • setuptools


You can install the package via pip:

pip install keras-video-generators

If you want to build from sources, clone the repository then:

python build


The package contains 3 generators that inherits Sequence interface. So they may be used with model.fit_generator():

  • VideoFrameGenerator that will take the choosen number of frames from the entire video
  • SlidingFrameGenerator that takes frames with decay for the entire video or with a sequence time
  • OpticalFlowGenerator that gives optical flow sequence from frames with different methods (experimental)

Each of these generators accepts parameters:

  • glob_pattern that must contain {classname}, e.g. './videos/{classname}/*.avi' - the "classname" in string is used to detect classes
  • nb_frames that is the number of frame in the sequence
  • batch_size that is the number of sequence in one batch
  • transformation that can be None or or ImageDataGenerator to make data augmentation
  • use_frame_cache to use with caution, if set to True, the class will keep frames in memory (without augmentation). You need a lot of memory
  • and many more, see class documentation



  • Changes to get first and last frames in sequence


  • try to fix SageMaker problem by avoiding usage of internal keras from tensorflow


  • fix transformation error with SlidingFrameGenerator


  • set generator to be Iterable
  • frame cache was disabled by error, it's back now
  • fixup import Sequence from tensorflow.keras
  • fix frame count problems for video with bad headers


  • fix Windows problems with path using backslashes
  • add auto discovery for classes if "None" is sent
  • add travis tests


  • fix frame counter in SlidingFrameGenerator


  • fix tiny video frame count
  • refactorisation
  • pep8
  • fix problems for video without headers


  • fix name check in classes to get them from filename
  • add split_test and split_val


  • fix package generation


  • fix assertion

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

keras-video-generators-1.0.14.tar.gz (11.6 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page