The goal of the DQM Playground is to serve information from various sources (OMS, Run Registry, DQM GUI, static files from the ML4DQM effort) in order to ease model development and to provide a place to compare the predictions of the various models.
All must be stored in a file named .env
:
DJANGO_DATABASE_ENGINE
DJANGO_DEBUG
DJANGO_DATABASE_NAME
DJANGO_DATABASE_PASSWORD
DJANGO_DATABASE_USER
DJANGO_DATABASE_HOST
DJANGO_DATABASE_PORT
DJANGO_SECRET_KEY
DIR_PATH_EOS_CMSML4DC
- Currently, the choices for available files provided are only refreshed
every time the
discover_dqm_files
management command is run. To run it, login to PaaS, select theml4dqm-playground
project, go toAdministrator
->Pods
, select the currently running pod, go toTerminal
and runpython manage.py discover_dqm_files
Known limitation:
- The
HistogramDataFile
entries can be deleted without affecting the Histograms loaded from the deleted files. However, re-reading the file will NOT update the existing Histogram entries to point to the newly read file
discover_dqm_files
: Will scanDIR_PATH_EOS_CMSML4DC
for files and check if aHistogramDataFile
has been stored in the DB for each file.
exctract_lumisections_histos1D_csv
: Given a CSV containing 1D Lumisection Histograms, this command will parse the file's contents and create appropriate entries in theLumisectionHistogram1D
table.exctract_lumisections_histos2D_csv
: Given a CSV containing 2D Lumisection Histograms, this command will parse the file's contents and create appropriate entries in theLumisectionHistogram2D
table.
To query the API from a third-party application, you will need to generate a token (from the admin dashboard)
For storing histograms, the ArrayField
is used, so a PostgreSQL database is
recommended for running the project locally.
Installing pgadmin4
is also recommended for easier interfacing with the DB.
Accessing the API via a rendered HTML page requires session authentication of the DRF. This is done by:
- Requiring the user to login to the page that contains the JS that does the requests
- Configuring DRF to accept
SessionAuthentication
- Adding the
X-CSRF-TOKEN
header to the API request and setting its value to the CSRF token which you can get by accessing the cookies stored in the current page. [https://docs.djangoproject.com/en/4.0/ref/csrf/#ajax]
[https://www.django-rest-framework.org/topics/ajax-csrf-cors/]