Entities
In the package workflow, entities are the symbols that appear in a problem definition.
Parameters and Variables
Parameters are registered with
kkthn.builder.KKTHardNet.add_parameter().Variables are registered with
kkthn.builder.KKTHardNet.add_variable().Access is expression-based, for example
x.x1ory.y2.Full vectors are available with
x.vector()andy.vector().
Inverse Parameters
Inverse parameters are registered with
kkthn.builder.KKTHardNet.add_inverse_parameter() and are learned during
estimate().
Constants and Extracted Arrays
Constants are registered with kkthn.builder.KKTHardNet.matrix(),
kkthn.builder.KKTHardNet.vector(), and
kkthn.builder.KKTHardNet.tensor(). A .npz file can be loaded with
kkthn.builder.KKTHardNet.extract(); each array is then available as an
attribute on the model.
Autodoc
- class kkthn.builder.VectorExpression(fn: Callable, text: str, *, size: int, components: list[Expression] | None = None)[source]
Bases:
object- eval(ctx)[source]
- class kkthn.builder.Constant(name: str, value: Any)[source]
Bases:
object
- class kkthn.builder._SymbolNamespace(builder: KKTHardNet, kind: str)[source]
Bases:
object- vector() VectorExpression[source]