mlfmu.api

Functions

run(command, interface_file, model_file, ...)

Run the mlfmu process.

Classes

MlFmuBuilder([fmu_name, interface_file, ...])

Builder for creating FMUs (Functional Mock-up Units) from machine learning models.

MlFmuCommand(value[, names, module, ...])

Enum class for the different commands in the mlfmu process.

MlFmuProcess(command[, source_folder, ...])

Represents the ML FMU process.
mlfmu.api.run(command: MlFmuCommand, interface_file: str | None, model_file: str | None, fmu_path: str | None, source_folder: str | None) → None

Run the mlfmu process.

Run the mlfmu process with the given command and optional parameters.

Parameters:

  • command (MlFmuCommand) – which command in the mlfmu process that should be run

  • interface_file (Optional[str]) – the path to the file containing the FMU interface. Will be inferred if not provided.

  • model_file (Optional[str]) – the path to the ml model file. Will be inferred if not provided.

  • fmu_path (Optional[str]) – the path to where the built FMU should be saved. Will be inferred if not provided.

  • source_folder (Optional[str]) – the path to where the FMU source code is located. Will be inferred if not provided.