ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-01-30 22:18:02 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add ClearML Agent deployment options (#877)

Browse Source
This commit is contained in:
pollfly 2024-07-17 09:50:55 +03:00 committed by GitHub
parent cbb65cb974
commit fa0003eb82
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 19 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/clearml_agent.md
View File

@ -59,12 +59,17 @@ original values:
* Modified recorded command line arguments will have the ClearML agent inject the new values in their stead
* Code-level configuration instrumented with [`Task.connect()`](references/sdk/task.md#connect) will be overridden by modified hyperparameters
For more information, see [ClearML Agent Reference](clearml_agent/clearml_agent_ref.md),
and [configuration options](configs/clearml_conf.md#agent-section).
ClearML Agent can be deployed in various setups to suit different workflows and infrastructure needs:
* [Bare Metal](clearml_agent/clearml_agent_deployment.md#spinning-up-an-agent)
* [Kubernetes](clearml_agent/clearml_agent_deployment.md#kubernetes)
* [Slurm](clearml_agent/clearml_agent_deployment.md#slurm)
* [Google Colab](guides/ide/google_colab.md)
## References
* See [ClearML Agent CLI](clearml_agent/clearml_agent_ref.md) for a reference for `clearml-agent`'s CLI commands.
* See [ClearML Agent Environment Variables](clearml_agent/clearml_agent_env_var.md) for a list of environment variables
to configure ClearML Agent
For more information, see the following:
* [ClearML Agent CLI](clearml_agent/clearml_agent_ref.md) for a reference for `clearml-agent`'s CLI commands.
* [ClearML Agent Environment Variables](clearml_agent/clearml_agent_env_var.md) for a list of environment variables
to configure ClearML Agent
* [Agent Section](configs/clearml_conf.md#agent-section) for a list of options to configure the ClearML Agent in the
`clearml.conf`

7
docs/clearml_agent/clearml_agent_deployment.md
View File

@ -239,6 +239,13 @@ If you are running Slurm with Singularity containers support, set the following:
clearml-agent-slurm --singularity-mode --template-files slurm.example_singularity.template --queue default
```
## Google Colab
ClearML Agent can run on a [Google Colab](https://colab.research.google.com/) instance. This helps users to leverage
compute resources provided by Google Colab and send experiments for execution on it.
Check out [this tutorial](../guides/ide/google_colab.md) on how to run a ClearML Agent on Google Colab!
## Explicit Task Execution
ClearML Agent can also execute specific tasks directly, without listening to a queue.

8
docs/clearml_agent/clearml_agent_google_colab.md
View File

@ -1,8 +0,0 @@
---
title: Google Colab
---
ClearML Agent can run on a [Google Colab](https://colab.research.google.com/) instance. This helps users to leverage
compute resources provided by Google Colab and send experiments for execution on it.
Check out [this tutorial](../guides/ide/google_colab.md) on how to run a ClearML Agent on Google Colab!

2
sidebars.js
View File

@ -41,7 +41,7 @@ module.exports = {
'clearml_agent/clearml_agent_execution_env', 'clearml_agent/clearml_agent_env_caching',
'clearml_agent/clearml_agent_dynamic_gpus', 'clearml_agent/clearml_agent_fractional_gpus',
'clearml_agent/clearml_agent_services_mode', 'clearml_agent/clearml_agent_docker',
'clearml_agent/clearml_agent_google_colab', 'clearml_agent/clearml_agent_scheduling'
'clearml_agent/clearml_agent_scheduling'
]},
{'Cloud Autoscaling': [
'cloud_autoscaling/autoscaling_overview',