MicrogradEx.Graph (MicrogradEx v0.1.0)

Extracts scalar computation graphs from MicrogradEx.Value expressions.

This module returns plain Elixir data structures suitable for Livebook tables, documentation, and Graphviz DOT export. It does not depend on Livebook, Graphviz, or browser rendering.

Summary

Types

edge_row()

node_row()

Functions

edges(value)

Returns parent-to-child graph edges reachable from a final Value.

graph(value, gradients \\ nil)

Returns both nodes and edges for a scalar computation graph.

nodes(value, gradients \\ nil)

Returns graph nodes reachable from a final Value.

to_dot(value, gradients \\ nil)

Returns a Graphviz DOT representation of a scalar computation graph.

Types

edge_row()

@type edge_row() :: %{
  from: String.t(),
  to: String.t(),
  local_gradient: float(),
  parent_label: String.t(),
  child_label: String.t(),
  child_op: String.t()
}

node_row()

@type node_row() :: %{
  :id => String.t(),
  :label => String.t(),
  :op => String.t(),
  :data => float(),
  :arity => non_neg_integer(),
  :is_leaf => boolean(),
  optional(:grad) => float()
}

Functions

edges(value)

@spec edges(MicrogradEx.Value.t()) :: [edge_row()]

Returns parent-to-child graph edges reachable from a final Value.

graph(value, gradients \\ nil)

@spec graph(MicrogradEx.Value.t(), MicrogradEx.Gradients.t() | nil) :: %{
  nodes: [node_row()],
  edges: [edge_row()]
}

Returns both nodes and edges for a scalar computation graph.

nodes(value, gradients \\ nil)

@spec nodes(MicrogradEx.Value.t(), MicrogradEx.Gradients.t() | nil) :: [node_row()]

Returns graph nodes reachable from a final Value.

Nodes are returned in topological order from inputs toward the selected output. When a Gradients table is supplied, each row also includes :grad.

to_dot(value, gradients \\ nil)

@spec to_dot(MicrogradEx.Value.t(), MicrogradEx.Gradients.t() | nil) :: String.t()

Returns a Graphviz DOT representation of a scalar computation graph.

Graphviz is not required to call this function; it only returns text.