speechbrain.utils.depgraph module

A dependency graph for finding evaluation order.

Example

>>> # The basic use case is that you have a bunch of keys
>>> # and some of them depend on each other:
>>> database = []
>>> functions = {'read': {'func': lambda: (0,1,2),
...                       'needs': []},
...              'process': {'func': lambda X: [x**2 for x in X],
...                          'needs': ['read']},
...              'save': {'func': lambda x: database.append(x),
...                       'needs': ['process']},
...              'print': {'func': lambda x,y: print(x, "became", y),
...                        'needs': ['read', 'process']},
...              'auxiliary': {'func': lambda: (1,2,3),
...                            'needs': []}}
>>> # If this is user supplied info, so you can't just hardcode the order,
>>> # a dependency graph may be needed.
>>> dg = DependencyGraph()
>>> # In simple cases, you can just encode the dependencies directly:
>>> for key, conf in functions.items():
...     for needed in conf["needs"]:
...         dg.add_edge(key, needed)
>>> # Now we can evaluate:
>>> outputs = {}
>>> for node in dg.get_evaluation_order():
...     f = functions[node.key]['func']
...     args = [outputs[needed] for needed in functions[node.key]['needs']]
...     outputs[node.key] = f(*args)
(0, 1, 2) became [0, 1, 4]
>>> # This added nodes implicitly.
>>> # However, since 'auxiliary' didn't depend on anything,
>>> # it didn't get added!
>>> assert 'auxiliary' not in outputs
>>> # So to be careful, we should also manually add nodes for any thing that
>>> # is not an intermediate step.
>>> _ = dg.add_node('auxiliary')
>>> assert 'auxiliary' in (node.key for node in dg.get_evaluation_order())
>>> # Arbitrary data can be added to nodes:
>>> dg2 = DependencyGraph()
>>> for key, conf in functions.items():
...     _ = dg2.add_node(key, conf)
...     for needed in conf["needs"]:
...         dg2.add_edge(key, needed)
>>> # Now we get access to the data in evaluation:
>>> outputs2 = {}
>>> for key, _, conf in dg2.get_evaluation_order():
...     f = conf['func']
...     args = [outputs[needed] for needed in conf['needs']]
...     outputs[key] = f(*args)
(0, 1, 2) became [0, 1, 4]
Authors:
  • Aku Rouhe 2020

Summary

Exceptions:

CircularDependencyError

An error caused by running into circular dependencies while searching for an evaluation order in a DependencyGraph.

Classes:

DGNode

DependencyGraph

General-purpose dependency graph.

Reference

exception speechbrain.utils.depgraph.CircularDependencyError[source]

Bases: ValueError

An error caused by running into circular dependencies while searching for an evaluation order in a DependencyGraph.

class speechbrain.utils.depgraph.DGNode(key, edges, data)

Bases: tuple

data

Alias for field number 2

edges

Alias for field number 1

key

Alias for field number 0

class speechbrain.utils.depgraph.DependencyGraph[source]

Bases: object

General-purpose dependency graph.

Essentially a directed acyclic graph. Usually used to find an evaluation order for e.g. variable substitution The relation that an edge between A and B represents is: “A depends on B, i.e. B should be evaluated before A”

Nodes can be added explicitly or they can be created implicitly while adding edges. Nodes have keys, which should be some hashable value that identifies the elements the graph represents in your use case. E.G. they can just be the variable name you want to substitute. However, if needed, more generally you can attach any data to a node (e.g. a path in your tree), and if so desired, a unique key can be created for you. You’ll only need to know that key while adding edges to/from it. Implicit keys and explicit keys can also be mixed.

static get_unique_key()[source]
add_node(key=None, data=None)[source]

Adds a node explicitly.

Parameters
  • key (hashable, optional) – If not given, a key is created for you.

  • data (Any, optional) – Any additional data you wish to attach to this node.

Returns

The key that was used (either yours or generated).

Return type

hashable

Raises

ValueError – If node with the given key has already been added explicitly (with this method, not “add_edge”).

add_edge(from_key, to_key)[source]

Adds an edge, and implicitly also creates nodes for keys which have not been seen before. This will not let you add data to your nodes. The relation encodes: “from_key depends on to_key” (to_key must be evaluated before from_key).

Parameters
  • from_key (hashable) – The key which depends on.

  • to_key (hashable) – The key which is depended on.

Return type

None

is_valid()[source]

Checks if an evaluation order can be found.

A dependency graph is evaluatable if there are no circular dependencies, i.e., the graph is acyclic.

Returns

Indicating if the graph is evaluatable.

Return type

bool

get_evaluation_order(selected_keys=None)[source]

Finds one valid evaluation order.

There can be many different valid orders. NOTE: Generates output one DGNode at a time. May generate DGNodes before it finds a circular dependency. If you really need to know whether an order can be found, check is_valid() first. However, the algorithm for finding cycles is essentially the same as the one used for finding an evaluation order, so for very large graphs… Ah well, but maybe then you should be using some other solution anyway.

Parameters

selected_keys (list, None) – List of keys. If not None, only the selected keys are guaranteed in the evaluation order (along with the keys they depend on).

Yields

DGNode – The added DGNodes in a valid evaluation order. See the DGNode namedtuple above.

Raises

CircularDependencyError – If a circular dependency is found.