flip.constants.flip_constants

FLIP Constants and Configuration.

This module provides:

• Environment-aware settings (DevSettings, ProdSettings)

• Enumerations for resource types, model statuses, tasks, and events

Attributes

FlipConstants

Classes

DevSettings	Development environment configuration.
ProdSettings	Production environment configuration.
ResourceType	Types of imaging resources available in XNAT.
FlipTasks	Task names used in FLIP workflows.
FlipEvents	Event names used in FLIP workflows.
ModelStatus	Model training status values.
FlipMetricsLabel	Standard metric labels for FLIP metrics reporting.
FlipMetaKey	Metadata keys used in FLIP (diffusion model specific).

Functions

get_flip_constants(→ Union[DevSettings, ProdSettings])

Get FlipConstants singleton instance.

Module Contents

class flip.constants.flip_constants.DevSettings

Bases: _Common

Development environment configuration.

Used when LOCAL_DEV=true. Requires local paths for test data.

LOCAL_DEV: bool = True

DEV_DATAFRAME: str = ''

DEV_IMAGES_DIR: str = ''

class flip.constants.flip_constants.ProdSettings

Bases: _Common

Production environment configuration.

Used when LOCAL_DEV=false. Settings are grouped by which FL role uses them: - Server-only (fl-server on Central Hub): FLIP_API_INTERNAL_URL, INTERNAL_SERVICE_KEY* - Client-only (fl-client on trust side): DATA_ACCESS_API_URL, IMAGING_API_URL,

TRUST_INTERNAL_SERVICE_KEY*

• Shared: IMAGES_DIR, NET_ID, UPLOADED_FEDERATED_DATA_BUCKET

LOCAL_DEV: bool = False

FLIP_API_INTERNAL_URL: pydantic.HttpUrl = 'http://localhost:8000'

INTERNAL_SERVICE_KEY_HEADER: str = 'X-Internal-Service-Key'

INTERNAL_SERVICE_KEY: str = ''

DATA_ACCESS_API_URL: pydantic.HttpUrl = 'http://localhost:8001'

IMAGING_API_URL: pydantic.HttpUrl = 'http://localhost:8002'

TRUST_INTERNAL_SERVICE_KEY_HEADER: str = 'X-Trust-Internal-Service-Key'

TRUST_INTERNAL_SERVICE_KEY: str = ''

IMAGES_DIR: str = ''

NET_ID: str = 'default'

UPLOADED_FEDERATED_DATA_BUCKET: str = 's3://default-bucket'

flip.constants.flip_constants.get_flip_constants() → DevSettings | ProdSettings

Get FlipConstants singleton instance.

Lazy initialization ensures environment variables are only required when the instance is actually used, not at import time.

flip.constants.flip_constants.FlipConstants

class flip.constants.flip_constants.ResourceType

Bases: str, enum.Enum

Types of imaging resources available in XNAT.

Initialize self. See help(type(self)) for accurate signature.

DICOM = 'DICOM'

NIFTI = 'NIFTI'

SEGMENTATION = 'SEG'

ALL = 'ALL'

class flip.constants.flip_constants.FlipTasks

Bases: str, enum.Enum

Task names used in FLIP workflows.

Initialize self. See help(type(self)) for accurate signature.

INIT_TRAINING = 'init_training'

POST_VALIDATION = 'post_validation'

CLEANUP = 'cleanup'

INIT_TASK = 'init_task'

POST_TASK = 'post_task'

class flip.constants.flip_constants.FlipEvents

Event names used in FLIP workflows.

Note: This is a class with class attributes rather than an Enum because NVFLARE events are string constants.

TRAINING_INITIATED = '_training_initiated'

RESULTS_UPLOAD_STARTED = '_results_upload_started'

RESULTS_UPLOAD_COMPLETED = '_results_upload_completed'

SEND_RESULT = '_send_result'

LOG_EXCEPTION = '_log_exception'

ABORTED = '_aborted'

TASK_INITIATED = '_task_initiated'

class flip.constants.flip_constants.ModelStatus

Bases: str, enum.Enum

Model training status values.

Initialize self. See help(type(self)) for accurate signature.

PENDING = 'PENDING'

INITIATED = 'INITIATED'

PREPARED = 'PREPARED'

TRAINING_STARTED = 'TRAINING_STARTED'

RESULTS_UPLOADED = 'RESULTS_UPLOADED'

ERROR = 'ERROR'

STOPPED = 'STOPPED'

class flip.constants.flip_constants.FlipMetricsLabel

Bases: str, enum.Enum

Standard metric labels for FLIP metrics reporting.

Initialize self. See help(type(self)) for accurate signature.

LOSS_FUNCTION = 'LOSS_FUNCTION'

DL_RESULT = 'DL_RESULT'

AVERAGE_SCORE = 'AVERAGE_SCORE'

class flip.constants.flip_constants.FlipMetaKey

Bases: str, enum.Enum

Metadata keys used in FLIP (diffusion model specific).

Initialize self. See help(type(self)) for accurate signature.

STAGE = 'stage'