fx workspace command

fx workspace command#

fx workspace#

Manage Federated Learning Workspaces.

fx workspace [OPTIONS] COMMAND [ARGS]...

certify#

Creates a certificate authority (CA) for the federation.

fx workspace certify [OPTIONS]

create#

Creates a workspace.

fx workspace create [OPTIONS]

Options

--prefix <prefix>#

Required Path to the new workspace including name.

--template <template>#

Required Name of a built-in template to use for creating the workspace.

Options:

torch/histology_s3 | torch/histology | torch/mnist_straggler_check | torch/histology_fedcurv | torch/mnist | torch/mnist_eden_compression | torch/template | no-op | federated_analytics/smokers_health | federated_analytics/histogram | gandlf_seg_test | keras/torch/mnist | keras/jax/mnist | keras/tensorflow/mnist | keras/hippmapp3r | keras/2dunet | keras/mnist | xgb_higgs | flower-app-pytorch

dockerize#

Packages current workspace as a TEE-ready docker image.

fx workspace dockerize [OPTIONS]

Options

--save#

Export the workspace image as <workspace_name>.tar file.

Default:

False

--rebuild#

If set, rebuilds workspace image with --no-cache option.

Default:

False

--enclave-key <enclave_key>#

Path to an enclave signing key. If not provided, a key will be auto-generated in the workspace. Note that this command builds a TEE-ready image by default. You have the flexibility to not run inside a TEE later.

--base-image <base_image>#

OpenFL base image to use for creating a workspace. If unspecified, default latest base image will be pulled. To build a base image from source, follow docker build instructions. Format: IMAGE_URI:TAG

Default:

'ghcr.io/securefederatedai/openfl:latest'

export#

Exports the OpenFL workspace (in current directory) to an archive.

The archive contains the following files/directories copied as-is:
- src: All experiment source code.
- plan: The FL plan directory.
- save: Model initial weights.
- requirements.txt: Package list required for the experiment.

This command does not copy data, logs, or secrets.

This command takes no additional arguments.

fx workspace export [OPTIONS]

import#

Imports an FL workspace.

fx workspace import [OPTIONS]

Options

--archive <archive>#

Required Path to workspace archive (generated using fx workspace export).

Contents