Struct ModelEntry 

pub struct ModelEntry { /* private fields */ }

One model a host can offer: its declarations, and the factory that builds it on any device.

Cheap to clone. Clones share the declarations and the factory.

Implementations

impl ModelEntry

pub fn id(&self) -> &str

Stable id that identifies the model in a model set, on the command line and in a spec file.

pub fn name(&self) -> &str

Name shown in the UI.

pub fn description(&self) -> &str

One-line description shown in the UI.

pub fn param_descriptors(&self) -> &[ParamDescriptor]

Every parameter, in the order a build reads its values.

pub fn stat_descriptors(&self) -> &[StatDescriptor]

Stats the model reports, in the order its state returns them.

pub fn action_descriptors(&self) -> &[ActionDescriptor]

One-off steps the model offers, in the order the Parameters panel draws their buttons.

pub fn topology_hint(&self) -> TopologyHint

Display layers the model presents.

pub fn metadata(&self) -> &ModelMetadata

Declared facts about the model, derived from its trait consts.

pub fn schema(&self) -> ModelSchema<'_>

Declarations a plan checks a spec against, readable with no device.

pub fn gpu_needs(&self) -> Option<GpuNeeds>

Device needs above the WebGPU baseline. None for a CPU model.

pub fn source(&self) -> &ModelSource

Origin of the model’s code: its type path always, and the registering crate’s build once a set records it.

pub fn param_index(&self, id: &str) -> Option<usize>

Returns the position of parameter id in Self::param_descriptors.

pub fn action_index(&self, id: &str) -> Option<usize>

Returns the position of action id in Self::action_descriptors.

pub fn setup(&self) -> RunSetup

Returns a setup at the declared defaults, the default seed and no actions.

pub fn build( &self, params: &[ParamValue], seed: Option<u64>, gpu: Option<&GpuContext>, ) -> Result<ModelState, Fault>

Builds the model from positional values, unchecked. RunSetup is the checked path.

A CPU model ignores gpu, and a GPU model builds on it.

Errors

Returns a Fault when the build panics, the device rejects it, or a GPU model receives no device.

pub fn demand(&self, params: &[ParamValue], limits: &Limits) -> Option<Demand>

Returns the device resources the model would allocate at params on a device with limits.

Returns None for a CPU model. It allocates on the host and knows its footprint only once built.

pub fn shortfalls(&self, params: &[ParamValue], limits: &Limits) -> Vec<String>

Returns the reasons a device with limits cannot build the model at params, empty when it can.

Trait Implementations

impl Clone for ModelEntry

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ModelEntry

Prints the declarations, and leaves out the factory and the capacity closures.

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.