Python API

Auto-generated reference for the Python surface of the neml2 package, grouped by purpose. Each entry below links to one top-level module; classes and functions inside each module are listed on its page.

For narrative model-authoring material see Extension; the entries below are organised for reading existing code. The top-level neml2 namespace just re-exports names from the subpackages below, so it has no page of its own.

Core

• neml2.factory
• neml2.schema
• neml2.models.model
• neml2.models.chain_rule
• neml2.models.resolver

Typed tensor wrappers

• neml2.types

Built-in catalogs

• neml2.models
• neml2.solvers
• neml2.es
• neml2.drivers
• neml2.data
• neml2.user_tensors

The HIT-side catalog of each subpackage above is autogenerated into Reference → HIT syntax from the same docstrings; the entries here document the underlying Python classes.

Compilation and AOTI

• neml2.models.export
• neml2.aoti

See also: AOTI packages.

Adapters

• neml2.pyzag

CLI entry points

• neml2.cli

These modules back the neml2-run / neml2-inspect / neml2-syntax / neml2-compile / neml2-stub console scripts; end-user docs live in CLI utilities.