rlmesh.params.Param
One declared construction parameter -- validated, presentable, sweepable.
Param(
name: str,
type: type | str | Vector = 'str',
choices: tuple[Any, ...] | None = None,
description: str = '',
group: str | None = None,
)Declaring a Param is the act of marking a knob primary: it is presented
as a first-class widget, validated (type/choices/required) before
construction, and offered as a sweep axis. Undeclared keyword args of
make/load are still presented and type-checked for free (the
signature-derived tier); Param enriches one with domains, choices,
grouping, and sweepability.
The default lives in the make/load signature, never here: a param with
a signature default is optional, one without is required. A Param only
enriches that knob (choices/grouping/description/sweepability); it does not
restate the default.
Parameters
| Name | Type | Description |
|---|---|---|
name | str | The keyword name, matching the make/load parameter. |
type | type | str | Vector | A Python type (int/float/str/bool) or its string name, "enum" (domain defined entirely by choices), or a Vector (a fixed-length float vector). |
choices | tuple[Any, ...] | None | Allowed values -- the enumeration/sweep axis; a supplied value outside them is rejected. |
description | str | Human-facing help text for the dashboard widget. |
group | str | None | Optional UI grouping label (advisory; the core never reads it). |