From 1279be78f7cc72848db50959600ee536329fe3b7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guilhem=20Barth=C3=A9s?= Date: Thu, 15 Feb 2024 16:15:58 +0100 Subject: [PATCH 1/3] feat: add function and compute task states in user doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Guilhem Barthés --- docs/source/documentation/concepts.rst | 8 ++++++++ docs/source/static/schemes/computetask.state.svg | 1 + docs/source/static/schemes/function.state.svg | 1 + 3 files changed, 10 insertions(+) create mode 100644 docs/source/static/schemes/computetask.state.svg create mode 100644 docs/source/static/schemes/function.state.svg diff --git a/docs/source/documentation/concepts.rst b/docs/source/documentation/concepts.rst index 28121477..29c5de4c 100644 --- 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 @@ -63,6 +67,10 @@ 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/computetask.state.svg b/docs/source/static/schemes/computetask.state.svg new file mode 100644 index 00000000..608c877c --- /dev/null +++ b/docs/source/static/schemes/computetask.state.svg @@ -0,0 +1 @@ +
WAITING_FOR_BUILDER_SLOT
BUILDING
WAITING_FOR_PARENT_TASKS
WAITING_FOR_EXECUTOR_SLOT
DOING
CANCELED
FAILED
DONE
 \ No newline at end of file diff --git a/docs/source/static/schemes/function.state.svg b/docs/source/static/schemes/function.state.svg new file mode 100644 index 00000000..e9fc9f11 --- /dev/null +++ b/docs/source/static/schemes/function.state.svg @@ -0,0 +1 @@ +
WAITING
BUILDING
CANCELED
FAILED
READY
 \ No newline at end of file From e0539ca3f4bcf9100aa382786b6132c3611bf21c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guilhem=20Barth=C3=A9s?= Date: Thu, 15 Feb 2024 16:20:07 +0100 Subject: [PATCH 2/3] docs: changelog MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Guilhem Barthés --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3c2a21e1..06ca8a2f 100644 --- 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 From f57906352420b1add7b8747d4792899bd15bc0eb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guilhem=20Barth=C3=A9s?= Date: Thu, 15 Feb 2024 17:20:47 +0100 Subject: [PATCH 3/3] feat: add compute plan statuses state machine MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Guilhem Barthés --- docs/source/documentation/concepts.rst | 4 ++++ docs/source/static/schemes/computeplan.state.svg | 1 + 2 files changed, 5 insertions(+) create mode 100644 docs/source/static/schemes/computeplan.state.svg diff --git a/docs/source/documentation/concepts.rst b/docs/source/documentation/concepts.rst index 29c5de4c..fb05906c 100644 --- a/docs/source/documentation/concepts.rst +++ b/docs/source/documentation/concepts.rst @@ -60,6 +60,10 @@ 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 diff --git a/docs/source/static/schemes/computeplan.state.svg b/docs/source/static/schemes/computeplan.state.svg new file mode 100644 index 00000000..db71563d --- /dev/null +++ b/docs/source/static/schemes/computeplan.state.svg @@ -0,0 +1 @@ +
EMPTY
WAITING
TODO
CANCELED
FAILED
DOING
DONE
 \ No newline at end of file