fx collaborator command#
fx collaborator#
Manage Federated Learning Collaborator.
Usage
fx collaborator [OPTIONS] COMMAND [ARGS]...
calchash#
Generates a hash for the dataset whose data sources are defined in datasources.json.
The hash, saved as hash.txt in the same directory, can later be used in custom data loaders to validate and track dataset consistency.
Usage
fx collaborator calchash [OPTIONS]
Options
- -j, --data_path <data_path>#
Path to directory containing sources.json file defining the data sources of the dataset. This file should contain a JSON object with the data sources to be registered. For ‘local’ type, ‘params’ must include: ‘path’. For ‘s3’ type, ‘params’ must include: ‘uri’, ‘access_key_env_name’, ‘secret_key_env_name’, ‘secret_name’, and optionally ‘endpoint’.
certify#
Certifies the collaborator certificate key-pair.
Usage
fx collaborator certify [OPTIONS]
Options
- -n, --collaborator_name <collaborator_name>#
The certified common name of the collaborator.
- -s, --silent#
Do not prompt
- -r, --request-pkg <request_pkg>#
Path to a zip containing the certificate signing request for a collaborator.
- -i, --import <import_>#
Path to an archive containing the collaborator’s certificate (signed by the CA).
create#
Registers given dataset path in the plan/data.yaml file.
Usage
fx collaborator create [OPTIONS]
Options
- -n, --collaborator_name <collaborator_name>#
Required The certified common name of the collaborator.
- -d, --data_path <data_path>#
The data path to be associated with the collaborator.
- -s, --silent#
If set, skips manual confirmation.
generate-cert-request#
Generates collaborator certificate key-pair to be sent to aggregator for signing.
Usage
fx collaborator generate-cert-request [OPTIONS]
Options
- -n, --collaborator_name <collaborator_name>#
Required The certified common name of the collaborator.
- -s, --silent#
Do not prompt
- -x, --skip-package#
If set, does not package the certificate signing request for export.
ping#
Ping the aggregator without starting any tasks.
Usage
fx collaborator ping [OPTIONS]
Options
- -p, --plan <plan>#
Path to an FL plan.
- Default:
'plan/plan.yaml'
- -d, --data_config <data_config>#
The dataset shard configuration file.
- Default:
'plan/data.yaml'
- -n, --collaborator_name <collaborator_name>#
Required The certified common name of the collaborator.
start#
Starts a collaborator service.
Usage
fx collaborator start [OPTIONS]
Options
- -p, --plan <plan>#
Path to an FL plan.
- Default:
'plan/plan.yaml'
- -d, --data_config <data_config>#
The dataset shard configuration file.
- Default:
'plan/data.yaml'
- -n, --collaborator_name <collaborator_name>#
Required The certified common name of the collaborator.