phenotypic.sdk_.JobMetadataKey#

class phenotypic.sdk_.JobMetadataKey[source]#

Bases: object

Keys inside <output>/.phenotypic/progress/job_metadata.json.

Writers (CLI execution strategies) and readers (recompile worker, sentinel, checkpoint handler, GUI runs registry) must reference these constants — never the bare string. Renaming a key here should fail fast at every site.

Methods

__init__

Attributes

CHUNK_JOB_IDS

CHUNK_SCRIPTS

DATASETS

EXECUTION_MODE

FIGURES_RUN_DATE

The initial CLI call of a measure-mode SLURM invocation (figures spec §1a): its UTC date (the figure-folder {date}), UTC timestamp and pid.

GUI_RECORD_GENERATION

GUI owner-record generation that initiated this scheduler launch.

IMAGE_TASK_MAPPING

IMAGE_TYPE

INCLUDE_DATASET_COLUMN

INITIATED_AT_UTC

INITIATED_PID

INPUT_PATH

METADATA_CSV

NCOLS

NO_QC

Whether the recompile finalizer task should skip QC compute.

NROWS

ORCHESTRATION_EPOCH

PIPELINE_PATH

PROCESSING_GENERATION

SLURM_JOB_IDS

START_TIME

EXECUTION_MODE: Final[str] = 'execution_mode'#
START_TIME: Final[str] = 'start_time'#
INPUT_PATH: Final[str] = 'input_path'#
METADATA_CSV: Final[str] = 'metadata_csv'#
NO_QC: Final[str] = 'no_qc'#

Whether the recompile finalizer task should skip QC compute. Set on the SLURM recompile finalizer task dict alongside METADATA_CSV; read by _cli_recompile_worker._run_post_master_steps.

SLURM_JOB_IDS: Final[str] = 'slurm_job_ids'#
CHUNK_JOB_IDS: Final[str] = 'chunk_job_ids'#
CHUNK_SCRIPTS: Final[str] = 'chunk_scripts'#
DATASETS: Final[str] = 'datasets'#
INCLUDE_DATASET_COLUMN: Final[str] = 'include_dataset_column'#
IMAGE_TASK_MAPPING: Final[str] = 'image_task_mapping'#
ORCHESTRATION_EPOCH: Final[str] = 'orchestration_epoch'#
GUI_RECORD_GENERATION: Final[str] = 'gui_record_generation'#

GUI owner-record generation that initiated this scheduler launch. Together with slurm_generation this is the durable restart-safe binding between GUI identity and the CLI lifecycle epoch.

PROCESSING_GENERATION: Final[str] = 'processing_generation'#
PIPELINE_PATH: Final[str] = 'pipeline_path'#
IMAGE_TYPE: Final[str] = 'image_type'#
NROWS: Final[str] = 'nrows'#
NCOLS: Final[str] = 'ncols'#
FIGURES_RUN_DATE: Final[str] = 'figures_run_date'#

The initial CLI call of a measure-mode SLURM invocation (figures spec §1a): its UTC date (the figure-folder {date}), UTC timestamp and pid. Measure mode keeps no processing state, so its workers read these instead; written with the rest of this file, before fan-out. The same three names key state.config for every other mode (_cli_state_management.RUN_INITIATION_KEYS).

INITIATED_AT_UTC: Final[str] = 'initiated_at_utc'#
INITIATED_PID: Final[str] = 'initiated_pid'#