Join the newly launched Discord community for real-time discussions, peer support, and direct interaction with the Meridian team!

schema.processors.model_processor.ModelProcessor

Performs model-based analysis or optimization.

Methods

@abc.abstractmethod
execute(
    specs: Sequence[S]
) -> M

Runs an analysis/optimization on the model using the given specs.

Args
`specs`	Sequence of Specs containing parameters needed for the analysis/optimization. The specs must all be of the same type as `self.spec_type()` for this processor

Returns
A proto containing the results of the analysis/optimization.

@classmethod
@abc.abstractmethod
output_type() -> type[M]

Returns the concrete output type that this ModelProcessor produces.

@classmethod
@abc.abstractmethod
spec_type() -> type[S]

Returns the concrete Spec type that this ModelProcessor operates on.

__call__(
    specs: Sequence[S], output: pb.Mmm
)

Runs an analysis/optimization on the model using the given specs.

This also sets the appropriate output field in the given MmmOutput proto.

Args
`specs`	Sequence of Specs containing parameters needed for the analysis/optimization. The specs must all be of the same type as `self.spec_type()` for this processor
`output`	The output proto to which the results of the analysis/optimization should be attached.

Raises
`ValueError`	If any spec is not of the same type as `self.spec_type()`.