CompressAI
==========

CompressAI (*compress-ay*) is a PyTorch library and evaluation platform for
end-to-end compression research.

.. image:: ../../assets/kodak-psnr.png

.. toctree::
   :maxdepth: 1

   intro
   installation

.. toctree::
   :maxdepth: 1
   :caption: Tutorials

   tutorials/tutorial_train
   Custom model<tutorials/tutorial_custom>

.. toctree::
   :maxdepth: 1
   :caption: Library API

   compressai
   ans
   datasets
   entropy_models
   latent_codecs
   layers
   losses
   models
   ops
   transforms

.. toctree::
   :maxdepth: 2
   :caption: Model Zoo

   zoo

.. toctree::
  :maxdepth: 2
  :caption: Utils

  cli_usage


.. toctree::
   :caption: Development

   Github repository <https://github.com/InterDigitalInc/CompressAI/>
