From 130754161d8830ef4870d788a74aac778154c8bc Mon Sep 17 00:00:00 2001
From: Erwan Rouchet <rouchet@teklia.com>
Date: Wed, 14 Dec 2022 15:57:09 +0100
Subject: [PATCH] Add gpu_usage and model_usage in YAML config docs
---
docs/contents/workers/yaml.md | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/docs/contents/workers/yaml.md b/docs/contents/workers/yaml.md
index b3cc7fb6..a7d57e11 100644
--- a/docs/contents/workers/yaml.md
+++ b/docs/contents/workers/yaml.md
@@ -67,6 +67,21 @@ include:
- `word-segmenter`
- `paragraph-creator`
+`gpu_usage`
+: Whether or not this worker requires or supports GPUs. Defaults to `disabled`. May take one of the following values:
+
+ `required`
+ : This worker requires a GPU, and will only be run on Ponos agents whose hosts have a GPU.
+
+ `supported`
+ : This worker supports using a GPU, but may run on any available host, including those without GPUs.
+
+ `disabled`
+ : This worker does not support GPUs. It may run on a host that has a GPU, but it will ignore it.
+
+`model_usage`
+: Boolean. Whether or not this worker requires a model version to run. Defaults to `false`.
+
`docker`
: Regroups Docker-related configuration attributes:
<!--
--
GitLab