nvflare.apis.workspace module

class Workspace(root_dir: str, name: str, config_folder: str)

Bases: object

Define a workspace.

NOTE:

Workspace folder structure:

    Workspace ROOT
        startup (optional)
            provisioned content
        run_1
            config (required)
                configurations
            custom (optional)
                custom python code
            other_folder (app defined)

Parameters

• root_dir – root directory of the workspace

• name – name of the workspace

• config_folder – where to find required config inside an app

get_app_config_dir(job_id: str) → str

get_app_custom_dir(job_id: str) → str

get_app_dir(job_id: str) → str

get_root_dir() → str

get_run_dir(job_id: str) → str

get_startup_kit_dir() → str