Getting started with a ramp kit

Starting kits in ramp-kits are meant to work out of the box.

Getting started with a given kit <ramp_kit_name> is a quick 4-step process.

Clone the kit

$ cd /path/to/your/ramp-kits/directory
$ git clone https://github.com/ramp-kits/<ramp_kit_name>.git
$ cd <ramp_kit_name>

Install dependencies

• with conda and the environment.yml file (preferred method)

  $ conda env create -f environment.yml  # create the virtual env

  and activate the virtual environment, named after the kit

  $ source activate <ramp_kit_name>

• with pip and the requirements.txt file

  $ pip install -r requirements.txt

Download the public data

$ python download_data.py

Test the execution

$ ramp_test_submission --quick-test

Alternatively, for example if you want to use a debugger, you can run the script from a python environment by

from rampwf.utils.testing import assert_submission

then

assert_submission()

See the signature of assert submission for optional parameters.