Skip to content

Latest commit

 

History

History
131 lines (85 loc) · 5.01 KB

README.md

File metadata and controls

131 lines (85 loc) · 5.01 KB
Raw

VirAAL: Virtual Adversarial Active Learning for NLU

This repository implements the basic blocks needed for VirAAL in a configurable manner to reproduce the results of the paper (https://arxiv.org/abs/2005.07287).

Best Paper Award of The 8th IEEE Spoken Language Technology Workshop (SLT 2021).

Installation

Clone the repository in a local folder and then once in the folder install viraal

pip install -e .

This will install all required packages. Next create an account at Weights & Biases and copy your API key from your profile settings. In the terminal just wandb login and paste your api key to upload your metrics automatically.

Dataset paths

You will need to modify the paths to datasets in viraal/config/dataset/atis.yaml and snips.yaml to point to an absolute path to the files included in the data/ folder for these scripts to work.

Reproducing the paper's experiments

To reproduce the paper's experiments launch the following two scripts :

bash launch_pretrain_experiments.sh
bash launch_rerank_experiments.sh

This will launch the experiments and upload the results to your Weights and Biases account if you logged in under the projects 'viraal-pretrain-full' and 'viraal-rerank-full'.

These scripts invoke pretrain and rerank functions in the base_functions.sh script that are the base for launching any experiment with this code.

Repo structure

This repo is mainly based on configurability. There are scripts that receive the config and instantiate the different objects needed for the task at hand and make them interact.

As of this moment there are two main scripts: train/text.py and rerank.py

These scripts can be invoked as follows

python -m viraal.train.text
python -m viraal.rerank

Config

The config is created by composing different blocks together. Hydra (the configuration manager) merges together the different parts and sends the whole config to the script. If no command line arguments are specified, the default config/train_text.yaml or config/rerank.yaml is used.

You can also override the defaults by specifying command line arguments. These arguments can either change a whole block python -m viraal.train.text dataset=atis or individual values python -m viraal.train.text training.epochs=80.

When a script is launched, hydra creates a new directory in the runs folder to store the run.

Multiple experiments in parallel

One can also launch multiple experiments in parallel very simply

python -m viraal.train.text -m dataset=atis,imdb5000,snips
python -m viraal.train.text -m misc.seed=100:110

Either using comma separated values or a range.

This launches the experiments using ray. You can override in the configuration how many cpus and gpus a single run uses in ray.remote.

TrainText

This object takes a configuration and instantiates objects directly from the config by importing the object and passing the parameters specified in the config to it.

iterator:
    class: allennlp.data.iterators.basic_iterator.BasicIterator
    params:
      batch_size: 64

Rerank

This script takes a path to a pretrained run and loads it to rerank the training data and trains a new classifier based on it.

Weights and biases (wandb)

It is very useful to aggregate the results in a single place for comparing runs and visualizing what goes on during training. For that one can enable wandb using the misc.wandb=True flag in the config.

The following is an example of running multiple experiments to average them. Grouping them with wandb.group makes it possible to directly see the average as it evolves.

PRETRAIN_NAME="imdb_vat_attention"
python -m viraal.train.text -m dataset=imdb5000 \
                               model=attention \
                               hydra=no_console \
                               hydra.sweep.dir=multiruns/pretrain/$PRETRAIN_NAME \
                               misc.seed=293920:293928 \
                               misc.wandb=True \
                               wandb.group=$PRETRAIN_NAME \
                               wandb.project=viraal-pretrain \

Data

The different paths to the datasets used can be found in the configurations in config/dataset

Visualizing results

We use weights and biases to visualize results. Please refer to https://www.wandb.com/ for more detail.

For a quickstart, create an account at wandb and get your API key and then launch

wandb login

in a terminal. Then the results are automatically uploaded to your workspace online.

Citation

If you use VirAAL in academic work, please cite it directly:

@misc{senay2021viraal,
    title={VirAAL: Virtual Adversarial Active Learning for NLU},
    author={Gregory Senay and Badr Youbi Idrissi and Marine Haziza},
    year={2021},
    eprint={2005.07287},
    archivePrefix={The 8th IEEE Spoken Language Technology Workshop (SLT 2021)},
    booktitle = {2021 {IEEE} Spoken Language Technology Workshop, {SLT} 2021, Shenzhen, China, January 18-21, 2021},
    primaryClass={cs.CL}
}