fx collaborator command#
fx collaborator#
Manage Federated Learning Collaborator.
fx collaborator [OPTIONS] COMMAND [ARGS]...
certify#
Certifies the collaborator certificate key-pair.
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.
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.
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.
start#
Starts a collaborator service.
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.