Add admonition about running agents in venv (#470)

This commit is contained in:
pollfly 2023-02-08 13:19:08 +02:00 committed by GitHub
parent f77403e6d6
commit 55fd5b4cb1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 1 deletions

View File

@ -52,6 +52,8 @@ pip install clearml-agent
:::info
Install ClearML Agent as a system Python package and not in a Python virtual environment.
An agent that runs in Virtual Environment Mode or Conda Environment Mode needs to create virtual environments, and
it can't do that when running from a virtual environment.
:::
## Configuration

View File

@ -72,7 +72,7 @@ Task to one of your queues, according to the amount of resources you want to all
With queues and ClearML Agent, you can easily add and remove machines from the cluster, and you can
reuse machines without the need for any dedicated containers or images.
## Additional Features
## Running Modes
Agents can be deployed bare-metal, with multiple instances allocating
specific GPUs to the agents. They can also be deployed as dockers in a Kubernetes cluster.
@ -87,6 +87,12 @@ The Agent has three running modes:
- Conda Environment Mode: Similar to the Virtual Environment mode, only instead of using pip, it uses conda install and
pip combination. Notice this mode is quite brittle due to the Conda package version support table.
:::tip Agents and virtual environments
An agent that runs in Virtual Environment Mode or Conda Environment Mode needs to create virtual environments, and
it can't do that when running from a virtual environment. You can run agents in these modes with
system Python.
:::
## Services Mode
In its default mode, a ClearML Agent executes a single task at a time, since training tasks typically require all resources