Skip to content

Getting started

Benjamin Devillers edited this page Jan 11, 2023 · 5 revisions

Quick install (for use only)

Install the project from git:

pip install git+https://github.com/bdvllrs/bimGW.git

This will:

  • allow you to use pre-trained models.

This will NOT:

  • allow you to fine-tune models;
  • allow you to tinker with the project.

Contributing to the project

Download the git repository

git clone [email protected]:bdvllrs/bimGW.git & cd bimGW

Install the project in "editable" mode so you can still edit files. Before doing this, you probably want to create a new virtual environment for the project.

pip install -e ".[all]"

Note: [all] allows downloading the wandb dependency for experiment logging.

Up next

Project Architecture →