diff options
| author | Joshua Harlow <jxharlow@godaddy.com> | 2016-06-10 17:35:01 -0700 |
|---|---|---|
| committer | ChangBo Guo(gcb) <glongwave@gmail.com> | 2017-01-03 06:37:57 +0000 |
| commit | 774d59813417a945fdbe50316786effd1203e8f7 (patch) | |
| tree | fcf0225f05135e955cf1ccaf397b347fc41f26cf /doc | |
| parent | dc15edc8423ea81120f0007938a66b46f2ab9b0f (diff) | |
| download | taskflow-774d59813417a945fdbe50316786effd1203e8f7.tar.gz | |
Rename engine analyzer to be named selector
This moves out the engine next to run (or revert)
selection process to a single class that just does
this and moves out the common functions the analyzer
class provided to the runtime object (which all
components can access).
This makes it easier to adjust the selection algorithm
in different ways.
Change-Id: I091c69297a7bff60729791d3ca6c3fae14d6eea5
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/engines.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/source/engines.rst b/doc/source/engines.rst index bfabe06..aef0c0d 100644 --- a/doc/source/engines.rst +++ b/doc/source/engines.rst @@ -284,7 +284,7 @@ analyzing the current state of the task; which is determined by looking at the state in the task detail object for that task and analyzing edges of the graph for things like retry atom which can influence what a tasks intention should be (this is aided by the usage of the -:py:class:`~taskflow.engines.action_engine.analyzer.Analyzer` helper +:py:class:`~taskflow.engines.action_engine.selector.Selector` helper object which was designed to provide helper methods for this analysis). Once these intentions are determined and associated with each task (the intention is also stored in the :py:class:`~taskflow.persistence.models.AtomDetail` object) @@ -299,7 +299,7 @@ This stage selects which atoms are eligible to run by using a :py:class:`~taskflow.engines.action_engine.scheduler.Scheduler` implementation (the default implementation looks at their intention, checking if predecessor atoms have ran and so-on, using a -:py:class:`~taskflow.engines.action_engine.analyzer.Analyzer` helper +:py:class:`~taskflow.engines.action_engine.selector.Selector` helper object as needed) and submits those atoms to a previously provided compatible `executor`_ for asynchronous execution. This :py:class:`~taskflow.engines.action_engine.scheduler.Scheduler` will return a @@ -444,7 +444,6 @@ Components other locations **without** notice (and without the typical deprecation cycle). -.. automodule:: taskflow.engines.action_engine.analyzer .. automodule:: taskflow.engines.action_engine.builder .. automodule:: taskflow.engines.action_engine.compiler .. automodule:: taskflow.engines.action_engine.completer @@ -453,6 +452,7 @@ Components .. automodule:: taskflow.engines.action_engine.process_executor .. automodule:: taskflow.engines.action_engine.runtime .. automodule:: taskflow.engines.action_engine.scheduler +.. automodule:: taskflow.engines.action_engine.selector .. autoclass:: taskflow.engines.action_engine.scopes.ScopeWalker :special-members: __iter__ .. automodule:: taskflow.engines.action_engine.traversal |