Fixed (pmrf.Fixed)

pmrf.Fixed(value: Array | ndarray | bool | number | bool | int | float | complex, *, name: str | None = None, scale: float = 1.0, metadata: Any | None = None) Param

Create a fixed parameter.

Compared to specifying raw floats or numpy arrays, this is a convenience specifier that allows the parameters to be ignored by optimizers while still having a name and being capable of easily being made into a variable using pmrf.unfreeze().

Parameters:
  • value (ArrayLike) – The initial unscaled parameter value.

  • name (str, optional) – A name for the parameter, by default None.

  • scale (float, optional) – The scaling factor to apply, by default 1.0.

  • metadata (Any, optional) – Arbitrary metadata for the parameter, by default None.

Returns:

The fixed parameter.

Return type:

pmrf.Param