diff --git a/doc/source/engines.rst b/doc/source/engines.rst index 2deb8fa1..6aac42e0 100644 --- a/doc/source/engines.rst +++ b/doc/source/engines.rst @@ -232,7 +232,9 @@ The graph (and helper objects) previously created are now used for guiding further execution. The flow is put into the ``RUNNING`` :doc:`state ` and a :py:class:`~taskflow.engines.action_engine.graph_action.FutureGraphAction` -object starts to take over and begins going through the stages listed below. +object starts to take over and begins going through the stages listed +below (for a more visual diagram/representation see +the :ref:`engine state diagram `). Resumption ^^^^^^^^^^ diff --git a/doc/source/img/engine_states.png b/doc/source/img/engine_states.png new file mode 100644 index 00000000..b91041d2 Binary files /dev/null and b/doc/source/img/engine_states.png differ diff --git a/doc/source/states.rst b/doc/source/states.rst index fd2b0fa9..34841f4d 100644 --- a/doc/source/states.rst +++ b/doc/source/states.rst @@ -1,9 +1,40 @@ ------------------------------- -States of Task, Retry and Flow ------------------------------- +------ +States +------ -Flow States -=========== +.. _engine states: + +Engine +====== + +.. image:: img/engine_states.png + :height: 265px + :align: right + :alt: Action engine state transitions + +Executing +--------- + +**RESUMING** - Prepare flow to be resumed. + +**SCHEDULING** - Schedule nodes to be worked on. + +**WAITING** - Wait for nodes to finish executing. + +**ANALYZING** - Analyze and process result/s of node completion. + +End +--- + +**SUCCESS** - Engine completed successfully. + +**REVERTED** - Engine reverting was induced and all nodes were not completed +successfully. + +**SUSPENDED** - Engine was suspended while running.. + +Flow +==== .. image:: img/flow_states.png :height: 400px @@ -60,8 +91,8 @@ chance to run. type of misuse/state violation is occurring, and should be reported as such. -Task States -=========== +Task +==== .. image:: img/task_states.png :height: 265px @@ -91,8 +122,8 @@ goes to the FAILURE state. **REVERTED** - The task that has been reverted appears it this state. -Retry States -============ +Retry +===== .. image:: img/retry_states.png :height: 275px