README.md

Template Kit for RAMP challenge

Introduction

Describe the challenge, in particular:

• Where the data comes from?
• What is the task this challenge aims to solve?
• Why does it matter?

Getting started

Install

To run a submission and the notebook you will need the dependencies listed in requirements.txt. You can install the dependencies with the following command-line:

pip install -U -r requirements.txt

If you are using conda, we provide an environment.yml file for similar usage.

Challenge description

Get started on this RAMP with the dedicated notebook.

Test a submission

The submissions need to be located in the submissions folder. For instance for my_submission, it should be located in submissions/my_submission.

To run a specific submission, you can use the ramp-test command line:

ramp-test --submission my_submission

You can get more information regarding this command line:

ramp-test --help

To go further

You can find more information regarding ramp-workflow in the dedicated documentation