ramp_database.tools.event.add_event

ramp_database.tools.event.add_event(session, problem_name, event_name, event_title, ramp_sandbox_name, ramp_submissions_path, is_public=False, force=False)

Add a RAMP event in the database.

Event file should be set up in databoard/specific/events/<event_name>. Should be preceded by adding a problem (cf., add_problem), then problem_name imported in the event file (problem_name is acting as a pointer for the join). Also adds CV folds.

Parameters

sessionsqlalchemy.orm.Session

The session to directly perform the operation on the database.

problem_namestr

The problem name associated with the event.

event_namestr

The event name.

event_titlestr

The even title.

ramp_sandbox_namestr

Name of the submission which will be considered the sandbox. It will correspond to the key sandbox_name of the dictionary created with ramp_utils.generate_ramp_config.

ramp_submissions_pathstr

Path to the deployment RAMP submissions directory. It will corresponds to the key ramp_submissions_dir of the dictionary created with ramp_utils.generate_ramp_config.

is_publicbool, default is False

Whether the event is made public or not.

forcebool, default is False

Whether to overwrite an existing event. If false=False, an error will be raised.

Returns

eventEvent

The event which has been registered in the database.