.. VideoGenHub documentation master file, created by
   sphinx-quickstart on Wed May 22 16:32:32 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to VideoGenHub's documentation!
=======================================

VideoGenHub is a centralized framework to standardize the evaluation of conditional video generation models by curating unified datasets, building an inference library and a benchmark that align with real life applications.

.. _GitHub Code: https://github.com/TIGER-AI-Lab/VideoGenHub
.. _Pypi Page: https://pypi.org/project/videogen-hub/

* `GitHub Code`_
* `Pypi Page`_

.. toctree::
   :maxdepth: 2
   :caption: Overview


.. toctree::
   :maxdepth: 2
   :caption: Overview

   Overview/intro
   Overview/philosophy
   Overview/models
   Overview/datasets

.. toctree::
   :maxdepth: 2
   :caption: Guidelines

   Guidelines/install
   Guidelines/quickstart
   Guidelines/custombenchmark
   Guidelines/deepdive

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Researcher Guidelines

   Guidelines/custommodel
   Guidelines/humaneval
   Guidelines/imagenmuseum

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Contributing

   Contributing/basics
   Contributing/coding
   Contributing/docs

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: API Reference

   source/modules
   source/videogen_hub.infermodels
   source/videogen_hub.benchmark
   source/videogen_hub.pipelines