Skip to content

Latest commit

 

History

History
executable file
·
94 lines (64 loc) · 2.72 KB

get_started.md

File metadata and controls

executable file
·
94 lines (64 loc) · 2.72 KB
Raw

Get started

Prerequisites

  • Linux
  • Python 3.8+=
  • PyTorch 1.7+=
  • CUDA 10.1+
  • numpy 1.19.4+=
  • transformers 3.4.0+=

There are still some dependent packages not listed, which wil all be installed in the step 4.

Installation

  1. Create a conda virtual environment and activate it.

    conda create -n IMIX python=3.8 -y
conda activate IMIX

  2. Install PyTorch and torchvision following the official instructions, e.g.,

    conda install pytorch torchvision -c pytorch

    Note: Make sure that your compilation CUDA version and runtime CUDA version match. You can check the supported CUDA version for precompiled packages on the PyTorch website.

    E.g. If you have CUDA 10.1 installed under /usr/local/cuda and would like to install PyTorch 1.6+, you need to install the prebuilt PyTorch with CUDA 10.1.

    conda install pytorch cudatoolkit=10.1 torchvision -c pytorch

  3. Clone the iMIX repository.

    git clone https://github.com/multimodal-framework/imix.git
cd imix

  4. Install build requirements and then install iMIX.

    pip install -r requirements.txt
pip install -v -e .  # or "python setup.py develop"

Note:

a. Following the above instructions, iMIX is installed on dev mode , any local modifications made to the code will take effect without the need to reinstall it.

A from-scratch setup script

Assuming that you already have CUDA 10.1 installed, here is a full script for setting up iMIX with conda.

conda create -n iMIX python=3.8 -y
conda activate iMIX

conda install pytorch==1.6.0 torchvision==0.7.0 cudatoolkit=10.1 -c pytorch -y

# install imix
git clone https://github.com/multimodal-framework/imix.git
cd imix
pip install -r requirements.txt
pip install -v -e .

Developing with multiple iMIX versions

The train and test scripts already modify the PYTHONPATH to ensure the script use the iMIX in the current directory.

To use the default iMIX installed in the environment rather than that you are working with, you can remove the following line in those scripts

PYTHONPATH="$(dirname $0)/..":$PYTHONPATH

Verification

To verify whether iMIX and the required environment are installed correctly, we can run sample Python code to initialize a train job (use LXMERT as an example):

cd imix
export PYTHONPATH="your/path/imix" # set Python search path as your imix directory path
python tools/run.py --config-file configs/lxmert/lxmert_vqa.py

The above code is supposed to run successfully upon you finish the installation.