ramp_database.model.Event¶
-
class
ramp_database.model.Event(problem_name, name, event_title, ramp_sandbox_name, path_ramp_submissions, session=None)¶ Event table.
This table contains all information of a RAMP event.
- Parameters
- problem_namestr
The name of the problem.
- namestr
The name of the event.
- event_titlestr
The title to give for the event (used in the frontend, can contain spaces).
- ramp_sandbox_namestr
Name of the submission which will be considered the sandbox. It will correspond to the key
sandbox_nameof the dictionary created withramp_utils.generate_ramp_config.- path_ramp_submissionsstr
Path to the deployment RAMP submissions directory. It will corresponds to the key
ramp_submissions_dirof the dictionary created withramp_utils.generate_ramp_config.- sessionNone or
sqlalchemy.orm.Session, optional The session used to perform some required queries. It is a required argument when interacting with the database outside of Flask.
- Attributes
- idint
ID of the table row.
- namestr
Event name.
- titlestr
Event title.
- problem_idint
The problem ID associated with this event.
- problem
ramp_database.model.Problem The
ramp_database.model.Probleminstance.- max_members_per_teamint
The maximum number of members per team.
- max_n_ensembleint
The maximum number of models in the ensemble.
- is_send_trained_mailsbool
Whether or not to send an email when a model is trained.
- is_publicbool
Whether or not the event is public.
- is_controled_signupbool
Whether or not the sign-up to the event is moderated.
- is_competitivebool
Whether or not the challenge is in the competitive phase.
- min_duration_between_submissionint
The amount of time to wait between two submissions.
- opening_timestampdatetime
The date and time of the event opening.
- public_opening_timestampdatetime
The date and time of the publicly event opening.
- closing_timestampdatetime
The date and time of the event closure.
- official_score_namestr
The name of the official score used to evaluate the submissions.
- combined_combined_valid_scorefloat
The combined public score for all folds.
- combine_combined_test_scorefloat
The combined private score for all folds.
- combined_foldwise_valid_scorefloat
The combined public scores for each fold.
- combined_foldwise_test_scorefloat
The combined public scores for each fold.
- n_submissionsint
The number of submissions for an event.
- public_leaderboard_html_no_linksstr
The public leaderboard in HTML format with links to the submissions.
- public_leaderboard_html_with_linksstr
The public leaderboard in HTML format.
- private_leaderboard_htmlstr
The private leaderboard in HTML.
- failed_leaderboard_htmlstr
The leaderboard with the failed submissions.
- new_leaderboard_htmlstr
The leaderboard with the new submitted submissions.
- public_competition_leaderboard_htmlstr
The public leaderboard of the competition in HTML.
- private_competition_leaderboard_htmlstr
The private leaderboard of the competition in HTML.
- path_ramp_kitstr
The path where the kit are located.
- ramp_sandbox_namestr
Name of the submission which will be considered the sandbox.
- path_ramp_submissionsstr
Path to the deployment RAMP submissions directory. It will correspond to the key
ramp_submissions_dirof the dictionary created withramp_utils.generate_ramp_config.- score_typeslist of
ramp_database.model.EventScoreType A back-reference to the score type used in the event.
- event_adminslist of
ramp_database.model.EventAdmin A back-reference to the admin for the event.
- event_teams: list ofclass:
ramp_database.model.EventTeam A back-reference to the teams enrolled in the event.
- cv_foldslist of
ramp_database.model.CVFold A back-reference to the CV folds for the event.
-
__init__(problem_name, name, event_title, ramp_sandbox_name, path_ramp_submissions, session=None)¶ A simple constructor that allows initialization from kwargs.
Sets attributes on the constructed instance using the names and values in
kwargs.Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.