From 55fd5b4cb1e9f23ba1f86fee27c976ab4f2b3c9f Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Wed, 8 Feb 2023 13:19:08 +0200 Subject: [PATCH] Add admonition about running agents in venv (#470) --- docs/clearml_agent.md | 2 ++ docs/fundamentals/agents_and_queues.md | 8 +++++++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/clearml_agent.md b/docs/clearml_agent.md index 8011d895..b5412efb 100644 --- a/docs/clearml_agent.md +++ b/docs/clearml_agent.md @@ -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 diff --git a/docs/fundamentals/agents_and_queues.md b/docs/fundamentals/agents_and_queues.md index e0ded70a..e0750102 100644 --- a/docs/fundamentals/agents_and_queues.md +++ b/docs/fundamentals/agents_and_queues.md @@ -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