On Package Installation

This document provides information on AdaS package installation.

Python Package

---

Repository Cloning

After cloning the repository, cd into the directory and simply run

python setup.py build
python setup.py install

or

pip install .

or

pip install -e .

The above command is recommended if you intend on making changes to the repository.

Unpackaged Python

---

Ensure first that you have the requirements installed per requirements.txt

You can run the code by running

python train.py --...

Where --... represents the options for training (see below)

Similarly, the train.py file could be run from an IDE. We leave specifying arguments up to the user if run this way. Note a quick and dirty way is to alter the default argument values found in train.py. here --... represents the options for training (see below)