Skip to content

Add / Restart / Delete agent

Here you can find all necessary information about how to add (or delete) nodes to your computational Cluster.

With Supervisely Agent it is easy and straightforward to add new nodes to Cluster.

Your computer is safe

We only run tasks on your agents that you have explicitly started yourself. We will never use your nodes for benefit of others.

System requirements

First, make sure that computer you want to use in Supervisely meets several requirements:

  • Linux OS (Kernel 3.10)
  • Docker (Version 18.0)
  • GPU (CUDA 9.0) - for training and inference tasks
  • Nvidia-docker - for training and inference tasks


Open Cluster section in Supervisely Dashboard. If you have no agents installed yet, you will see the following picture:

Click "Connect your first node" button to open Agent installation dialog window.

Copy command you will see (you can click blue icon on the right to do it), paste in terminal on computer (host) you want to use with Supervisely and run it.

One agent per node

You can run only one agent per node. Don't worry — it's multithreading and runs tasks in a separate docker containers.

It will run Supervisely agent as a docker image with name "supervisely-agent/".

Advanced configuration (optional)

Before start Agent on you computer you can customize few parameters.

  • Use nvidia runtime: will add --runtime-nvidia flag to docker run to support GPU related taks
  • Registries: if you want to use your own private docker images for training and inference custom models, provide path, login and password.

Private Docker registry

We don't store your registry credentials. Your login and password will be passed to command as an environment variables.

If everything goes well, you will the the following output in your terminal:

You can now close terminal window.

Run on system startup

Supervisely agent runs with flag --restart=always by default and will start again after reboot.

Restart and update agent

There are few scenariuos when you will need to restart Agent: to update to the latest version or to apply your custom changes. Restarting process is simple.

Just click "three dots" icon in nodes list and select "Instructions". Copy command from instructions and perform in terminal on Agent's computer (host). Updated version will be automatically pulled from Docker registry.


Agent restarting will stop all running tasks

Disable agent

To remove node from Supervisely simple click on "three dots" icon in nodes list and select "Disable". You data will stay safe and you can recover you node later by selecting "Recover" option.

Stop agent(s)

If you will need to stop your agent(s), you can safely do it by running docker stop $(docker ps -q -f "name=supervisely-agent") command in your terminal. You can always bring it back by running docker start $(docker ps -q -f "name=supervisely-agent") command. Agent will re-connect to Supervisely and you can continue your work.

Remove agent(s)

To completely remove agent(s) from your machine run docker rm -fv $(docker ps -q -f "name=supervisely-agent") in your terminal and delete directory ~/.supervisely-agent/<token>