[Settings]

Table of Contents

• Available objects and their input file syntax
  • 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.

additional_libraries Additional dynamic libraries to load at runtime. The Registry from these libraries are merged into the current Registry singleton. This is required for using custom models defined in dynamic libraries not directly linked to libneml2. The paths are either absolute or relative to the current working directory.

• Type: list of string
• Required: No

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
• Required: No
• Default: _

disable_jit Disable JIT compilation of models. This is useful for debugging or when the JIT compiler is not available. When set to false, each individual model can still selectively enable/disable JIT. When set to true, JIT is disabled globally, and it is an error to explicitly set jit to true for any model.

• Type: bool
• Required: No
• Default: false

history_separator History variable name separator. The default is '~'. For example, a variable 'x' will have its history variable for the previous time step named 'x~1', for the time step before that named 'x~2', etc.

• Type: string
• Required: No

linalg_solve_check_errors Whether to check for errors after solving linear systems. This is disabled by default for performance reasons, but it can be enabled to get better error messages when the solve fails.

• Type: bool
• Required: No
• Default: false

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
• Required: No
• Default: _

rate_prefix Prefix for rate variables. The default is an empty string. For example, if the prefix is 'rate_', then a variable named 'x' will have its rate variable named 'rate_x'.

• Type: string
• Required: No

rate_suffix Suffix for rate variables. The default is '_rate'. For example, if the suffix is '_rate', then a variable named 'x' will have its rate variable named 'x_rate'.

• Type: string
• Required: No
• Default: _rate

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
• Required: No
• Default: true

residual_prefix Prefix for residual variables. The default is an empty string. For example, if the prefix is 'residual_', then a variable named 'x' will have its residual variable named 'residual_x'.

• Type: string
• Required: No

residual_suffix Suffix for residual variables. The default is '_residual'. For example, if the suffix is '_residual', then a variable named 'x' will have its residual variable named 'x_residual'.

• Type: string
• Required: No
• Default: _residual

Detailed documentation link