flip.constants

FLIP Constants module containing configuration and enumerations.

Exports:

• FlipConstants: Environment-aware configuration singleton

• DevSettings: Development environment settings

• ProdSettings: Production environment settings

• ResourceType: Enum for imaging resource types (DICOM, NIFTI, etc.)

• ModelStatus: Enum for model training status

• FlipEvents: Event name constants

• FlipTasks: Task name constants

• FlipMetaKey: Metadata key constants

• FlipMetricsLabel: Metrics label constants

• PTConstants: PyTorch-related constants

• JobType: Enum for FLIP job types

Submodules

• flip.constants.flip_constants
• flip.constants.job_types
• flip.constants.pt_constants

Attributes

FlipConstants

Classes

DevSettings	Development environment configuration.
FlipEvents	Event names used in FLIP workflows.
FlipMetaKey	Metadata keys used in FLIP (diffusion model specific).
FlipMetricsLabel	Standard metric labels for FLIP metrics reporting.
FlipTasks	Task names used in FLIP workflows.
ModelStatus	Model training status values.
ProdSettings	Production environment configuration.
ResourceType	Types of imaging resources available in XNAT.
JobType	Enumeration of supported FLIP job types.
PTConstants	Constants for PyTorch model handling in federated learning.

Package Contents

class 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 = ''

flip.constants.FlipConstants

class 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.FlipMetaKey

Bases: str, enum.Enum

Metadata keys used in FLIP (diffusion model specific).

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

STAGE = 'stage'

class 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.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.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.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'

class 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.JobType

Bases: str, enum.Enum

Enumeration of supported FLIP job types.

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

STANDARD = 'standard'

EVALUATION = 'evaluation'

FED_OPT = 'fed_opt'

DIFFUSION = 'diffusion_model'

class flip.constants.PTConstants

Constants for PyTorch model handling in federated learning.

PTServerName = 'server'

PTModelName = 'model.pt'

PTFileModelName = 'FL_global_model.pt'

PTLocalModelName = 'local_model.pt'

PTModelsDir = 'models'

CrossValResultsJsonFilename = 'cross_val_results.json'

EvalResultsFilename = 'evaluation_results.json'

EvalDir = 'evaluation_results'

EvalTaskName = 'evaluation'