Skip to main content

Platform Login/Logout - fedml login/logout

fedml login [OPTIONS] [API_KEY]

Options

NameDefaultDescription
--version
or -v
releaseLogin which backend environment version of FedML® Nexus AI Platform. It should be dev, test, or release.
--computing
or -c
trueLogin as the general compute node in FEDML Nexus AI compute network. This is enabled by default. After login, 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 cannot specify options -c and -s simultaneously for a single environment.
--server
or -s
falseLogin 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 cannot specify options -c and -s simultaneously for a single environment.
--provider
or -p
falseLogin 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

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

fedml login <API_KEY>

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

fedml login -s <API_KEY>

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

fedml login -p <API_KEY>

fedml logout [OPTIONS]

Options

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

Examples

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

fedml logout -c

Logout from a federated-learning server in FEDML Nexus AI Cloud:

fedml logout -s