Metadata-Version: 2.4
Name: computation-graph
Version: 78
Summary: Computation graph library
Requires-Python: >=3.14
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: gamla==164
Requires-Dist: immutables
Requires-Dist: termcolor
Requires-Dist: toposort
Requires-Dist: typeguard~=4.5
Dynamic: license-file

[![Build Status](https://travis-ci.com/hyroai/computation-graph.svg?branch=master)](https://travis-ci.com/hyroai/computation-graph)

A function composition framework that supports:

1. State - functions which retain state for their next turn of action.
2. Prioritized paths - lazily attempt overloaded composition paths according to priorities.
3. Deep dependency injection - compose a function to a variadic function at the end of an arbitrarily long pipeline.
4. Non cancerous `asyncio` support.

`pip install computation-graph`

To deploy: `python setup.py sdist bdist_wheel; twine upload dist/*; rm -rf dist/;`

### Node identity and duplication

A node is a function *plus* the wiring that feeds it. Composing the same function twice with the same inputs yields one shared node: edges are a `frozenset`, and equal edges collapse. Use `duplicate_function` / `duplicate_graph` (`computation_graph/composers/duplication.py`) only when the same function must take *different* inputs at the same parameter within one graph, which otherwise fails the build with "There are multiple edges with the same destination, key and priority". Input-less nodes never need it, and every needless copy is a permanent extra node. The module docstring spells out the rule and the cases that do not need it.

### Type checking

The runner will type check all outputs for nodes with return type annotations. In case of a wrong typing, it will log the node at fault.

### Debugging

#### Computation trace

Available computation trace visualizers:

1. `graphviz.computation_trace`
1. `mermaid.computation_trace`
1. `ascii.computation_trace`

To use, replace `to_callable` with `run.to_callable_with_side_effect` with your selected style as the first argument.

#### Graphviz debugger

This debugger will save a file on each graph execution to current working directory.

You can use this file in a graph viewer like [gephi](https://gephi.org/).
Nodes colored red are part of the 'winning' computation path.
Each of these nodes has the attributes 'result' and 'state'.
'result' is the output of the node, and 'state' is the _new_ state of the node.

In gephi you can filter for the nodes participating in calculation of final result by filtering on result != null.
