Skip to content

Latest commit

 

History

History
188 lines (138 loc) · 9.82 KB

README.md

File metadata and controls

188 lines (138 loc) · 9.82 KB
Raw

🔥🔥🔥 INFERNO: Set the world on fire with FLAME 🔥🔥🔥

Radek Daněček

PyTorch Lightning Discord Shield

Welcome to INFERNO. INFERNO is a library of tools and applications for deep-learning-based in-the-wild face reconstruction, animation and accompanying tasks. It contains many tools, from processing face video datasets, training face reconstruction networks, applying those face reconstruction networks to get 3D faces and then using these 3D faces to do other things (such as speech-driven animation).

If you are planning to use INFERNO, consider joining the Discord Community.

INFERNO makes heavy use of FLAME, PyTorch and Pytorch Lightning.

Current infernal projects:

Installation

Dependencies

  1. Install conda and update its base environment:
conda update -n base -c defaults conda
  1. Clone this repo

Short version

  1. Run the installation script:
bash install_38.sh

If this ran without any errors, you now have a functioning conda environment with all the necessary packages to run the demos. If you had issues with the installation script, go through the long version of the installation and see what went wrong. Certain packages (especially for CUDA, PyTorch and PyTorch3D) may cause issues for some users.

Long version

  1. (Optional) Pull the relevant submodules using:
bash pull_submodules.sh

Some functionalities of INFERNO rely on these external submodules (for instance using SWIN transformer or SPECTRE-like lip reading network). You will most likely not need them to run demos. However, if you wish to train your own models or process datasets, you may need some of the submodules. If you experience issues with some of them, leave an issue.

  1. Set up a conda environment with one of the provided conda files. I recommend using conda-environment_py38_cu11_ubuntu.yml.

You can use mamba to create a conda environment (strongly recommended):

mamba env create python=3.8 --file conda-environment_py38_cu11.yml

but you can also use plain conda if you want (but it will be slower):

conda env create python=3.8 --file conda-environment_py38_cu11.yml

In case the specified pytorch version somehow did not install, try again manually:

mamba install pytorch==1.12.1 torchvision==0.13.1 torchaudio==0.12.1 cudatoolkit=11.3 -c pytorch

Note: If you find the environment has a missing then just conda/mamba- or pip- install it and please notify me.

  1. Activate the environment:
conda activate work38_cu11
  1. For some reason cython is glitching in the requirements file so install it separately:
pip install Cython==0.29.14
  1. Install inferno using pip install. I recommend using the -e option and I have not tested otherwise.
pip install -e .
  1. Verify that previous step correctly installed Pytorch3D

For some people the compilation fails during requirements install and works after. Try running the following separately:

pip install git+https://github.com/facebookresearch/[email protected]

Pytorch3D installation (which is part of the requirements file) can unfortunately be tricky and machine specific. EMOCA was developed with is Pytorch3D 0.6.2 and the previous command includes its installation from source (to ensure its compatibility with pytorch and CUDA). If it fails to compile, you can try to find another way to install Pytorch3D.

Notes:

  1. INFERNO was developed with Pytorch 1.12.1 and Pytorch3d 0.6.2 running on CUDA toolkit 11.3. If for some reason installation of these failed on your machine (which can happen), feel free to install these dependencies another way. The most important thing is that version of Pytorch and Pytorch3D match. The version of CUDA is probably less important.
  2. Some people experience import issues with opencv-python from either pip or conda. If the OpenCV version installed by the automated script does not work for you (i.e. it does not import without errors), try updating with pip install -U opencv-python or installing it through other means. The install script installs opencv-python~=4.5.1.48 installed via pip.

Docker

Docker installation now available. Please go to the docker folder

Structure

This repo has two subpackages. inferno and inferno_apps

INFERNO

inferno is a library full of research code. Some things are OK organized, some things less so. It includes but is not limited to the following:

  • models is a module with (larger) deep learning modules (pytorch based)
  • layers contains individual deep learning layers
  • datasets contains base classes and their implementations for various datasets I had to use at some points. It's mostly image-based datasets with various forms of GT if any
  • utils - various tools

The repo is heavily based on PyTorch, Pytorch Lightning, makes us of Hydra for configuration and

INFERNO_APPS

inferno_apps contains prototypes that use the INFERNO library. These can include scripts on how to train, evaluate, test and analyze models from inferno and/or data for various tasks.

Look for individual READMEs in each sub-projects in inferno_apps

Usage

  1. Activate the environment:
conda activate work38_cu11
  1. Go the demo folder of one of the projects above and follow the instructions

Contribute

Contributions to INFERNO are very welcome. Here are two ways to contribute.

Projects building on top of INFERNO:

  • Create a submodule repo in apps and use INFERNO tools to build something cool. I will be happy to promote and/or merge your project if you do so.

Improving INFERNO

  • INFERNO can do many things, but there is many more it cannot do or it should do better. If you implement a new feature (such as a dataset, add an architecture etc.) or upgrade an existing feature, you are most welcome to create a PR. We will merge it.

  • If you want to build your own tools with INFERNO, refer to this and this

License

This code and model are available for non-commercial scientific research purposes as defined in the LICENSE file. By downloading and using the code and model you agree to the terms of this license.

Acknowledgements

There are many people who deserve to get credited. These include but are not limited to: