Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
12 changes: 12 additions & 0 deletions docs/source/documentation/concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
^^^^

Expand Down
1 change: 1 addition & 0 deletions docs/source/static/schemes/computeplan.state.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/source/static/schemes/computetask.state.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading