Welcome to the TorchCodec documentation!
========================================

TorchCodec provides utilities for decoding videos into PyTorch tensors.

.. note::

   TorchCodec is still in early development stage and we are actively seeking
   feedback. If you have any suggestions or issues, please let us know by
   `opening an issue <https://github.com/pytorch/torchcodec/issues/new/choose>`_
   on our `GitHub repository <https://github.com/pytorch/torchcodec/>`_.

.. grid:: 3

     .. grid-item-card:: :octicon:`file-code;1em`
        Installation instructions
        :img-top: _static/img/card-background.svg
        :link: install_instructions.html
        :link-type: url

        How to install TorchCodec

     .. grid-item-card:: :octicon:`file-code;1em`
        Getting Started with TorchCodec
        :img-top: _static/img/card-background.svg
        :link: generated_examples/basic_example.html
        :link-type: url

        A simple video decoding example

     .. grid-item-card:: :octicon:`file-code;1em`
        API Reference
        :img-top: _static/img/card-background.svg
        :link: api_ref_decoders.html
        :link-type: url

        The API reference for TorchCodec

.. toctree::
   :maxdepth: 1
   :caption: TorchCodec documentation
   :hidden:

   Home <self>
   glossary

.. toctree::
   :maxdepth: 1
   :caption: Examples and tutorials
   :hidden:

   install_instructions
   generated_examples/index


.. toctree::
   :glob:
   :maxdepth: 1
   :caption: API Reference
   :hidden:

   api_ref_decoders