RAMP Command-Line Interface¶

RAMP comes with a set of command-lines allowing to:

deploy your RAMP server and events;
interact with the database;
launch web frontend;
launch the dispatcher and workers.

Note

In the following sections, we are documenting the ramp-* subcommands. Be aware that you can access those subcommands using ramp * without a dash. As an example:

ramp-database -h

is equivalent to:

ramp database -h

You can find the documentation using:

ramp -h

We advise you to use the ramp commands since it will aggregate the available subcommands of RAMP workflow for instance.

Commands to setup your RAMP server or RAMP events¶

ramp-setup¶

Command-lines for setting and deploying RAMP server and events.

These command-lines are used to create the configuration file for your RAMP server and events. In addition, it will allow you to deploy easily RAMP events.

ramp-setup [OPTIONS] COMMAND [ARGS]...

create-conda-env¶

Create the conda environment for a specific event

ramp-setup create-conda-env [OPTIONS]

Options

--config <config>¶

Configuration file in YAML format containing the database information

Default: config.yml

--event-config <event_config>¶

Configuration file in YAML format containing the RAMP information

Default: config.yml

deploy-event¶

Deploy event (add problem and event to the database, optionally clone: kit and data)

ramp-setup deploy-event [OPTIONS]

Options

--config <config>¶

Configuration file in YAML format containing the database information

Default: config.yml

--event-config <event_config>¶

Configuration file in YAML format containing the RAMP information

Default: config.yml

--cloning, --no-cloning¶

Whether or not to clone the RAMP kit and data repositories.

Default: True

--force¶: Whether or not to potentially overwrite the repositories, problem and event in the database.

init¶

Initialize the deployment directory with a template config.yml

ramp-setup init [OPTIONS]

Options

--deployment-dir <deployment_dir>¶

The directory where to create a config file.

Default: .

--force¶: Whether or not to potentially overwrite the repositories, problem and event in the database.

init-event¶

Initialize the event directory with a template config.yml

ramp-setup init-event [OPTIONS]

Options

--name <name>¶: Required The name of the event.

--deployment-dir <deployment_dir>¶

The directory where to create a config file.

Default: .

--force¶: Whether or not to potentially overwrite the repositories, problem and event in the database.

update-conda-env¶

Update the conda environment for a specific event

ramp-setup update-conda-env [OPTIONS]

Options

--event-config <event_config>¶

Configuration file in YAML format containing the RAMP information

Default: config.yml

Commands to interact with the RAMP database¶

ramp-database¶

Command-line to interact directly with the database.

ramp-database [OPTIONS] COMMAND [ARGS]...

add-event¶

Add an event in the database.

ramp-database add-event [OPTIONS]

Options

--config <config>¶

Configuration file YAML format containing the database information

Default: config.yml

--problem <problem>¶: Name of the problem

--event <event>¶: Name of the event

--title <title>¶: Title of the event

--sandbox <sandbox>¶: Name of the sandbox

--submissions-dir <submissions_dir>¶: Path to the deployment RAMP submissions path.

--is-public <is_public>¶

Whether or not the event should be public

Default: False

--force <force>¶

Whether or not to overwrite the problem if it exists

Default: False

add-event-admin¶

Make a user admin of a specific RAMP event.

ramp-database add-event-admin [OPTIONS]

Options

--config <config>¶

Configuration file YAML format containing the database information

Default: config.yml

--event <event>¶: Name of the event

--user <user>¶: Name of the user becoming event admin

add-problem¶

Add a RAMP problem in the database.

ramp-database add-problem [OPTIONS]

Options

--config <config>¶

Configuration file YAML format containing the database information

Default: config.yml

--problem <problem>¶: Name of the problem

--kit-dir <kit_dir>¶: Path to the RAMP kit

--data-dir <data_dir>¶: Path to the RAMP data

--force <force>¶

Whether or not to overwrite the problem if it exists

Default: False

add-submission¶

Add a submission to the database.

ramp-database add-submission [OPTIONS]

Options

--config <config>¶

Configuration file YAML format containing the database information

Default: config.yml

--event <event>¶: Name of the event

--team <team>¶: Name of the team

--submission <submission>¶: Name of the submission

--path <path>¶: Path to the submission

add-user¶

Add a new user in the database.

ramp-database add-user [OPTIONS]

Options

--config <config>¶

Configuration file YAML format containing the database information

Default: config.yml

--login <login>¶: Login

--password <password>¶: Password

--lastname <lastname>¶: User’s last name

--firstname <firstname>¶: User’s first name

--email <email>¶: User’s email

--access-level <access_level>¶

User’s administration rights

Default: user

--hidden-notes <hidden_notes>¶

User’s additional hidden notes

Default

approve-user¶

Approve a user which asked to sign-up to RAMP studio.

ramp-database approve-user [OPTIONS]

Options

--config <config>¶

Configuration file YAML format containing the database information

Default: config.yml

--login <login>¶: User’s login to be approved

compute-contributivity¶

Blend submissions, compute combined score and contributivities.

ramp-database compute-contributivity [OPTIONS]

Options

--config <config>¶

Configuration file YAML format containing the database information

Default: config.yml

--config-event <config_event>¶: Required The event config file name.

--min-improvement <min_improvement>¶: The minimum score improvement to continue building the ensemble

delete-event¶

Delete event.

ramp-database delete-event [OPTIONS]

Options

--config <config>¶

Configuration file YAML format containing the database information

Default: config.yml

--config-event <config_event>¶: Required Path to configuration file YAML format containing the database information, eg config.yml

--dry-run¶: Emulate the removal without taking action. Basically, only the printing information will be shown. The deletion will not be done.

--from-disk¶: Flag to remove the event folder from the disk as well.

--force¶: Flag to force a removal, even from the disk, when an event is not in the database.

delete-event-team¶

Delete a link between a user (or team) and a RAMP event.

ramp-database delete-event-team [OPTIONS]

Options

--config <config>¶

Configuration file YAML format containing the database information

Default: config.yml

--event <event>¶: Name of the event

--team <team>¶: Name of the team

delete-predictions¶

Delete event predictions from the disk.

ramp-database delete-predictions [OPTIONS]

Options

--config <config>¶

Configuration file YAML format containing the database information

Default: config.yml

--config-event <config_event>¶: Required Path to configuration file YAML format containing the database information, eg config.yml

--force¶: Flag to force a removal of the predictions from the disk, when an event is not in the database.

delete-user¶

Delete a user which asked to sign-up to RAMP studio.

ramp-database delete-user [OPTIONS]

Options

--config <config>¶

Configuration file YAML format containing the database information

Default: config.yml

--login <login>¶: User’s login to be removed

export-leaderboards¶

Export all the scored submissions.

ramp-database export-leaderboards [OPTIONS]

Options

--config <config>¶

Configuration file YAML format containing the database information

Default: config.yml

--event <event>¶: The name of the event

--path <path>¶: path to the .csv file where to save the submissions and their score

get-submissions-by-state¶

Display the list of submission for an event in a particular state.

ramp-database get-submissions-by-state [OPTIONS]

Options

--config <config>¶

Configuration file YAML format containing the database information

Default: config.yml

--event <event>¶: Name of the event

--state <state>¶: The state of the submissions to display

make-user-admin¶

Make a user a RAMP admin.

ramp-database make-user-admin [OPTIONS]

Options

--config <config>¶

Configuration file YAML format containing the database information

Default: config.yml

--login <login>¶: User’s login to be made admin

set-submission-state¶

Set the state of a submission.

ramp-database set-submission-state [OPTIONS]

Options

--config <config>¶

Configuration file YAML format containing the database information

Default: config.yml

--submission-id <submission_id>¶: The submission ID

--state <state>¶: The state to affect to the submission

set-user-access-level¶

Change the access level of a RAMP user.

ramp-database set-user-access-level [OPTIONS]

Options

--config <config>¶

Configuration file YAML format containing the database information

Default: config.yml

--login <login>¶: User’s login to be made admin

--access-level <access_level>¶

The access level to grant the user.One of {‘asked’, ‘user’, ‘admin’}

Default: user

update-all-users-leaderboards¶

Update the leaderboards of all users for a given event.

ramp-database update-all-users-leaderboards [OPTIONS]

Options

--config <config>¶

Configuration file YAML format containing the database information

Default: config.yml

--event <event>¶: The event name

update-leaderboards¶

Update the leaderboards for a given event.

ramp-database update-leaderboards [OPTIONS]

Options

--config <config>¶

Configuration file YAML format containing the database information

Default: config.yml

--event <event>¶: The event name

update-user-leaderboards¶

Update the user leaderboards for a given event.

ramp-database update-user-leaderboards [OPTIONS]

Options

--config <config>¶

Configuration file YAML format containing the database information

Default: config.yml

--event <event>¶: The event name

--user <user>¶: The user name

Commands to interact with the RAMP web frontend¶

ramp-frontend¶

ramp-frontend [OPTIONS] COMMAND [ARGS]...

test-launch¶

ramp-frontend test-launch [OPTIONS]

Options

--config <config>¶

Configuration file in YAML format

Default: config.yml

--port <port>¶

The port where to launch the website

Default: 8080

--host <host>¶

The IP address where to launch the website

Default: 127.0.0.1

Commands to interact with the RAMP engine¶

ramp-launch¶

Command-line to launch engine to process RAMP submission.

ramp-launch [OPTIONS] COMMAND [ARGS]...

daemon¶

Launch the RAMP dispatcher.

The RAMP dispatcher is in charge of starting RAMP workers, collecting results from them, and update the database.

ramp-launch daemon [OPTIONS]

Options

--config <config>¶

Configuration file in YAML format containing the database information.

Default: config.yml

--events-dir <events_dir>¶: Directory where the event config files are located.

-v, --verbose¶

dispatcher¶

Launch the RAMP dispatcher.

The RAMP dispatcher is in charge of starting RAMP workers, collecting results from them, and update the database.

ramp-launch dispatcher [OPTIONS]

Options

--config <config>¶

Configuration file in YAML format containing the database information.

Default: config.yml

--event-config <event_config>¶: Configuration file in YAML format containing the RAMP event information.

-v, --verbose¶

worker¶

Launch a standalone RAMP worker.

The RAMP worker is in charger of processing a single submission by specifying the different locations (kit, data, logs, predictions)

ramp-launch worker [OPTIONS]

Options

--event-config <event_config>¶

Configuration file in YAML format containing the RAMP event information.

Default: config.yml

--submission <submission>¶: The submission name

-v, --verbose¶

RAMP Command-Line Interface¶

Commands to setup your RAMP server or RAMP events¶

ramp-setup¶

create-conda-env¶

deploy-event¶

init¶

init-event¶

update-conda-env¶

Commands to interact with the RAMP database¶

ramp-database¶

add-event¶

add-event-admin¶

add-problem¶

add-submission¶

add-user¶

approve-user¶

compute-contributivity¶

delete-event¶

delete-event-team¶

delete-predictions¶

delete-user¶

export-leaderboards¶

get-submissions-by-state¶

make-user-admin¶

set-submission-state¶

set-user-access-level¶

sign-up-team¶

update-all-users-leaderboards¶

update-leaderboards¶

update-user-leaderboards¶

Commands to interact with the RAMP web frontend¶

ramp-frontend¶

test-launch¶

Commands to interact with the RAMP engine¶

ramp-launch¶

daemon¶

dispatcher¶

worker¶