NEML2 2.0.0
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
[Settings]

Note
Clicking on the option with a triangle bullet ▸ next to it will expand/collapse its detailed information.
Type name written in PascalCase typically refer to a NEML2 object type, oftentimes a primitive tensor type.
The 🔗 symbol means that the tensor value can be cross-reference another object. See Model parameters (revisited) for details.
You can always use Ctrl+F or Cmd+F to search the entire page.

Available objects and their input file syntax

Refer to System Documentation for detailed explanation about this system.

Settings

Global settings for tensors, models, etc.

buffer_name_separator Nested buffer name separator. The default is '_'. For example, a sub-model 'foo' which declares a buffer 'bar' will have a buffer named 'foo_bar'.

  • Type: string
  • Default: _
default_integer_type Default integer type for tensors. Options are Int64 Int32 Int16 Int8

  • Type: EnumSelection
  • Default: Int64
machine_precision Machine precision used at various places to workaround singularities like division-by-zero.

  • Type: number
  • Default: 1e-15
parameter_name_separator Parameter name separator. The default is '_'. For example, a sub-model 'foo' which declares a parameter 'bar' will have a parameter named 'foo_bar'.

  • Type: string
  • Default: _
require_double_precision Require double precision for all computations. An error will be thrown when Model forward operators are called if the default dtype is not Float64. Set this option to false to allow other precisions.

  • Type: bool
  • Default: true
tighter_tolerance A tighter tolerance used in various algorithms.

  • Type: number
  • Default: 1e-12
tolerance Tolerance used in various algorithms.

  • Type: number
  • Default: 1e-06

Detailed documentation link