Dsxir.Optimizer behaviour (dsxir v0.1.0)

Copy Markdown

Behaviour and dispatcher for program optimizers.

An optimizer compiles a Dsxir.Program.t() against a trainset under a Dsxir.Metric.t(), returning a new program plus an open stats map.

Implementations declare @behaviour Dsxir.Optimizer and implement compile/4. Callers invoke an optimizer through compile/5, which performs argument validation and delegates to the impl module.

The return contract is fixed across versions:

{:ok, Dsxir.Program.t(), stats :: map()} | {:error, Exception.t()}

stats is an open map. Each optimizer documents the keys it populates; consumers must tolerate unknown keys.

Summary

Types

result()
stats()

Callbacks

compile(student, trainset, metric, opts)

Functions

compile(impl, student, trainset, metric, opts)

Dispatch to impl.compile/4 with validated arguments.

Types

result()

@type result() :: {:ok, Dsxir.Program.t(), stats()} | {:error, Exception.t()}

stats()

@type stats() :: map()

Callbacks

compile(student, trainset, metric, opts)

@callback compile(
  student :: Dsxir.Program.t(),
  trainset :: [Dsxir.Example.t()],
  metric :: Dsxir.Metric.t(),
  opts :: keyword()
) :: result()

Functions

compile(impl, student, trainset, metric, opts)

@spec compile(
  module(),
  Dsxir.Program.t(),
  [Dsxir.Example.t()],
  Dsxir.Metric.t(),
  keyword()
) :: result()

Dispatch to impl.compile/4 with validated arguments.

Guards: impl must be an atom (module), trainset a list, metric a 3-arity function, and opts a keyword list (any list satisfies the guard; impls are expected to treat it as a keyword list).