Skip to main content

Device Management - fedml device

fedml device bind [OPTIONS] [API_KEY]

Options

NameDefaultDescription
--version
or -v
releaseBind to which backend environment version of FedML® Nexus AI Platform. It should be dev, test, or release.
--computing
or -c
trueBind as the general compute node in FEDML Nexus AI compute network. This is enabled by default. After binding, you can view and manage the device in the FEDML® Nexus AI Platform: https://fedml.ai/compute. It can be grouped as a cluster and then you can use FEDML®Launch to schedule any job (training, deployment,federated learning) to it. You can not specify the option -c and -s simultaneously.
--server
or -s
falseBind as the FedML on-premise parameter server (PS). It can be used for PS-based training paradigms, such as distributed training, cross-cloud training, and federated-learning. You can not specify the option -c and -s simultaneously for a single environment.
--provider
or -p
falseBind as the FedML compute node (GPU) provider (supplier). This is used by Nexus AI Platform - Share and Earn: https://fedml.ai/gpu-supplier. You can share your GPUs in this way and earn money. You can specify the option -p and -c simultaneously (can be used as provider for others as well compute node for your own jobs), but you can not specify -p and -s simultaneously.

Arguments

NameDefaultDescription
API_KEYrequired, no default valueYou can find your API Key at https://fedml.ai. Click your avatar on top-right area and then click "Profile".

Examples

Bind as a general compute node in FEDML Nexus AI Cloud:

fedml device bind <API_KEY>

Bind as a federated-learning server in FEDML Nexus AI Cloud:

fedml device bind -s <API_KEY>

Bind as the compute node (GPU) provider (supplier) in FEDML Nexus AI Cloud:

fedml device bind -p <API_KEY>

Usage: fedml device unbind [OPTIONS]

Options

NameDefaultDescription
--compute_node
or -c
trueUnbind from the FedML general compute node.
--server
or -s
falseUnbind from the the FedML on-premise parameter server (PS).
--version
or -v
releaseUnbind which backend environment version of FedML® Nexus AI Platform. It should be dev, test, or release.

Examples

Unbind from a general compute node in FEDML Nexus AI Cloud:

fedml device unbind -c

Unbind from a federated learning server in FEDML Nexus AI Cloud:

fedml device unbind -s