nvflare.apis.workspace module

class Workspace(root_dir: str, site_name: str = '', config_folder: str = 'config')[source]

Bases: object

Define a workspace.

NOTE:

Example of client workspace folder structure:

    Workspace ROOT
        local
            authorization.json.default
            resources.json.default
            custom/
                custom python code
            ...
        startup (optional)
            provisioned content
            fed_client.json
        run_1
            app
                config (required)
                    configurations
                custom (optional)
                    custom python code
                other_folder (app defined)
            log.txt
            job_meta.json
            ...
Parameters:
  • root_dir – root directory of the workspace

  • site_name – site name of the workspace

  • config_folder – where to find required config inside an app

get_admin_startup_file_path()[source]
get_app_config_dir(job_id: str) str[source]
get_app_custom_dir(job_id: str) str[source]
get_app_dir(job_id: str) str[source]
get_app_log_file_path(job_id: str) str[source]
get_audit_file_path() str[source]
get_authorization_file_path()[source]
get_client_app_config_file_path(job_id)[source]
get_client_custom_dir() str[source]
get_client_startup_file_path()[source]
get_file_path_in_root(file_basename: str)[source]
get_file_path_in_site_config(file_basename: str | List[str])[source]
get_file_path_in_startup(file_basename: str)[source]
get_job_meta_path(job_id: str) str[source]
get_job_resources_file_path()[source]
get_log_config_file_path()[source]
get_log_file_path() str[source]
get_resources_file_path()[source]
get_root_dir() str[source]
get_run_dir(job_id: str) str[source]
get_server_app_config_file_path(job_id)[source]
get_server_startup_file_path()[source]
get_site_config_dir() str[source]
get_site_custom_dir() str[source]
get_site_privacy_file_path()[source]
get_startup_kit_dir() str[source]
get_stats_pool_records_path(job_id: str, prefix=None) str[source]
get_stats_pool_summary_path(job_id: str, prefix=None) str[source]