vitrine-api

Vitrine

Vitrine shows results as cards on a board the researcher reads beside the conversation. Cards belong to a study, stored in the .vitrine folder of the project.

Rules for every script

• One study. Set STUDY = "short-label" once and pass study=STUDY to every call that takes it. Cards without a label go to an auto-<time> study per process. To continue earlier work, reuse a label from vitrine studies.
• Run from the project folder. Cards go to the nearest .vitrine above the working directory, or to VITRINE_DATA_DIR. A script run from a temporary folder publishes where nobody looks.
• Let the server run. show() starts it, and the researcher's board points at it; stopping or restarting it breaks their view. With VITRINE_OPEN_BROWSER=0 a host app shows the board: point the researcher to the board, not to a URL.
• Run vitrine and python from the environment M4 is installed in.

Read the board

When the researcher mentions a card, a table, or the board, look before answering.

import vitrine

vitrine.list_studies()             # label, dir_name, card_count; CLI: vitrine studies
ctx = vitrine.study_context(STUDY) # cards (card_id, card_type, title, annotations),
                                   # decisions_made, pending_responses
card = vitrine.get_card("a1b2c3")  # preview, response_action/values/message, annotations
vitrine.get_selection("a1b2c3")    # rows or points the researcher selected

A reference copied from the board, [card:a1b2c3, study:sepsis-v1], names the card. A table's preview holds 20 rows; the whole table is <data_dir>/studies/<dir_name>/artifacts/<artifact_id>.parquet (data_dir from vitrine status --json).

Publish

from vitrine import progress, section, show

STUDY = "sepsis-v1"
section("Cohort", study=STUDY)
handle = show(cohort_df, title="Cohort", source="mimiciv_icu.icustays; scripts/01_cohort.py", study=STUDY)
show(fig, title="Age at admission", description="Included stays by decade of age.", study=STUDY)
show("28-day mortality was **23%** (412 of 1,790).", title="Primary outcome", study=STUDY)
show(final_df, title="Cohort", replace=handle, study=STUDY)  # update that card in place

with progress("Fitting the model", study=STUDY) as step:      # completes, or fails with the block
    step("fold 2 of 5")