1.1. Installation

Since torchmfbd v0.1 is a pure Python module, it should be pretty easy to install.

1.1.1. Package managers

The simplest and recommended way to install torchmfbd v0.1 is by using pip. We recommend to install it into a virtual environment, using any of the available options in Python, like pip or conda. This makes everything much safer, plus making sure that all packages are installed for the code. For example, once you have installed Miniconda, you can generate a new environment and install the dependencies (you can install whatever version of Python 3 you desire).

For the installation, just type:

conda create -n torchmfbd
conda activate torchmfbd
pip install torchmfbd

The code relies on the pytorch package. Take a look at the documentation for PyTorch for more information.

1.1.2. From source

torchmfbd v0.1 is developed on GitHub. If you want to install the latest version from the repository, you can clone the repository and install it manually once you have installed the requirements. For example, you can do:

git clone https://github.com/aasensio/torchmfbd.git
cd torchmfbd
pip install -e .

1.1.3. Requirements

torchmfbd v0.1 depends on the following external packages, that should be pretty straightforward to install:

  • numpy

  • torch

  • scipy

  • matplotlib

  • tqdm

  • scikit-image

  • scikit-learn

  • nvitop

  • pyyaml

  • einops

  • dict_hash