https://github.com/interdigitalinc/compressai-trainer

Training platform for End-to-End compression models, losses and metrics defined in Compressai
https://github.com/interdigitalinc/compressai-trainer

Last synced: about 1 month ago
JSON representation

Training platform for End-to-End compression models, losses and metrics defined in Compressai

• Host: GitHub
• URL: https://github.com/interdigitalinc/compressai-trainer
• Owner: InterDigitalInc
• License: bsd-3-clause-clear
• Created: 2022-12-23T00:47:56.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2023-11-30T22:17:41.000Z (about 1 year ago)
• Last Synced: 2024-04-25T07:31:17.886Z (8 months ago)
• Language: Python
• Homepage: https://interdigitalinc.github.io/CompressAI-Trainer/index.html
• Size: 3.98 MB
• Stars: 15
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



[![License](https://img.shields.io/github/license/InterDigitalInc/CompressAI-Trainer?color=blue)](https://github.com/InterDigitalInc/CompressAI-Trainer/blob/master/LICENSE)

CompressAI Trainer is a training platform that assists in managing experiments for end-to-end neural network-based compression research.

CompressAI Trainer integrates with [CompressAI] (library), [Aim] (experiment tracker), [Catalyst] (training engine), and [Hydra] (YAML configuration).

[Aim]: https://aimstack.io/

[Catalyst]: https://catalyst-team.com/

[CompressAI]: https://github.com/InterDigitalInc/CompressAI/#readme

[Hydra]: https://hydra.cc/

| ![](docs/source/media/images/aim-run-figure-rd-curves.png) |

|:--:|

| *CompressAI Trainer integrates with the Aim experiment tracker to display live visualizations of RD curves during training.* |

## Installation

**Requirements:** Python 3.8+.

First, clone the repositories:

```bash

git clone "https://github.com/InterDigitalInc/CompressAI.git" compressai

git clone "https://github.com/InterDigitalInc/CompressAI-Trainer.git" compressai-trainer

```

### Using venv

Create a virtual environment and install as editable:

```bash

python3 -m venv venv

source venv/bin/activate

pip install --upgrade pip

pip install --editable ./compressai-trainer

pip install --editable ./compressai

```

### Using poetry

Poetry helps manage version-pinned virtual environments. First, [install Poetry]:

```bash

curl -sSL https://install.python-poetry.org | python3 -

```

[install Poetry]: https://python-poetry.org/docs/#installation

Then, create the virtual environment and install the required Python packages:

```bash

cd compressai-trainer

# Install Python packages to new virtual environment.

poetry install

echo "Virtual environment created in $(poetry env list --full-path)"

# Link to local CompressAI source code.

poetry run pip install --editable /path/to/compressai

```

To activate the virtual environment, run:

```bash

poetry shell

```

### Development

To install dependencies for documentation and development, run the following (compatible with both poetry and venv installations):

```bash

poetry install --with=dev,docs,tests

```

You can then build and serve documentation using `make`:

```bash

make docs-serve

```

## Documentation

- [Documentation](https://interdigitalinc.github.io/CompressAI-Trainer/index.html)

- [Walkthrough](https://interdigitalinc.github.io/CompressAI-Trainer/tutorials/full.html) (setup, training, visualizations, configuring, customizing, tips and tricks)

## Usage

Please see the documentation for a complete [walkthrough](https://interdigitalinc.github.io/CompressAI-Trainer/tutorials/full.html).

## Authors

- Mateen Ulhaq, Fabien Racapé, and InterDigital Emerging Technologies Lab.