feat: add function and compute task states in user doc (#390)

* feat: add function and compute task states in user doc Signed-off-by: Guilhem Barthés <guilhem.barthes@owkin.com> * docs: changelog Signed-off-by: Guilhem Barthés <guilhem.barthes@owkin.com> * feat: add compute plan statuses state machine Signed-off-by: Guilhem Barthés <guilhem.barthes@owkin.com> --------- Signed-off-by: Guilhem Barthés <guilhem.barthes@owkin.com>
Substra · Feb 15, 2024 · 5528acf · 5528acf
1 parent 0b9c426
commit 5528acf
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Support on Python 3.11 ([#367](https://github.com/Substra/substra-documentation/pull/367))
 - Add doc about task output permissions ([#369](https://github.com/Substra/substra-documentation/pull/369))
 - Examples now install torch on CPU only if launched on docker or remote mode ([#375](https://github.com/Substra/substra-documentation/pull/375))
+- Diagrams for status for function and compute tasks ([#390](https://github.com/Substra/substra-documentation/pull/390))
 
 ### Removed
 

diff --git a/docs/source/documentation/concepts.rst b/docs/source/documentation/concepts.rst
@@ -36,6 +36,10 @@ A function corresponds to an archive (tar or zip file) containing:
 * One or more Python scripts that implement the function.
 * A Dockerfile on which the user can specify the required dependencies of the Python scripts.
 
+The different statuses it can take can be represented by the following state machine:
+
+.. image:: /static/schemes/function.state.svg
+
 .. _concept_model:
 
 Model
@@ -56,13 +60,21 @@ Gathering tasks into a single compute plan will lead to a more optimized compute
 
 Note that you can register a task alone, i.e. not put the task in a compute plan, but Substra will still create a compute plan for you for this specific task.
 
+The different statuses it can take can be represented by the following state machine:
+
+.. image:: /static/schemes/computeplan.state.svg
+
 .. _concept_task:
 
 Task
 ^^^^
 
 A task correspond to a computation task. The task can use any inputs (data, functions or output from other tasks). The function is expected to write the outputs in files, on paths given as outputs dictionary.
 
+The different statuses it can take can be represented by the following state machine:
+
+.. image:: /static/schemes/computetask.state.svg
+
 Rank
 ^^^^
 

diff --git a/docs/source/static/schemes/computeplan.state.svg b/docs/source/static/schemes/computeplan.state.svg
diff --git a/docs/source/static/schemes/computetask.state.svg b/docs/source/static/schemes/computetask.state.svg