68 update readme for interface vector inputs

.gitignore

@@ -157,4 +157,7 @@ examples/**/*.db
 examples/**/*.nc
 
 # Cmake generated files
-CMakeUserPresets.json
+CMakeUserPresets.json
+
+# Generated FMUs
+*.fmu

CHANGELOG.md

@@ -11,6 +11,8 @@ The changelog format is based on [Keep a Changelog](https://keepachangelog.com/e
 * Added missing unit tests for the template data generated when building the FMU.
 * Unit tests for the modelDescription.xml generation.
 * Unit tests for the Interface JSON validation.
+* Wind turbine power prediction model example is included in the mlfmu\examples\wind_to_power_pyspark directory.
+* README.md : Interface.json is updated to show how to define vectors as inputs.
 * Changed from `pip`/`tox` to `uv` as package manager
 * README.md : Completely rewrote section "Development Setup", introducing `uv` as package manager.
 * Added missing docstrings for py/cpp/h files with help of Github Copilot

README.md

@@ -93,6 +93,14 @@ Given that you have an ML model, you now need to:
             "name": "input_1",
             "description": "My input signal to the model at position 0",
             "agentInputIndexes": ["0"]
+        },
+        {
+            "name": "input_2",
+            "description": "My input signal as a vector with four elements at position 1 to 5",
+            "agentInputIndexes": ["1:5"],
+            "type": "real",
+            "isArray": true,
+            "length": 4
         }
     ],
     "parameters": [
@@ -112,6 +120,8 @@ Given that you have an ML model, you now need to:
 }
 ```
 
+More information about the interface.json schema can be found in the mlfmu\docs\interface\schema.html
+
 2. Compile the FMU:
 
 ```sh

docs/source/CHANGELOG.md

@@ -1,2 +1,2 @@
-```{include} ../../CHANGELOG.md
+```{include} ../../CHANGELOG.md
 ```

docs/source/LICENSE.md

@@ -1,3 +1,3 @@
-# LICENSE
-```{include} ../../LICENSE
+# LICENSE
+```{include} ../../LICENSE
 ```

docs/source/README.md

@@ -1,2 +1,2 @@
-```{include} ../../README.md
+```{include} ../../README.md
 ```

docs/source/STYLEGUIDE.md

@@ -1,2 +1,2 @@
-```{include} ../../STYLEGUIDE.md
+```{include} ../../STYLEGUIDE.md
 ```

docs/source/cli.rst

@@ -1,7 +1,7 @@
-CLI Documentation
-=================
-
-.. toctree::
-   :maxdepth: 2
-
-   cli.mlfmu
+CLI Documentation
+=================
+
+.. toctree::
+   :maxdepth: 2
+
+   cli.mlfmu

examples/wind_to_power_pyspark/config/interface.json

@@ -0,0 +1,23 @@
+{
+    "name": "MLFMU_RF_Regressor",
+    "description": "A Random Forest Regressor based FMU",
+    "usesTime": false,
+    "inputs": [
+        {
+            "name": "features",
+            "description": "Inputs with four features: month, hour, wind_speed, wind_direction",
+            "agentInputIndexes": ["0:4"],
+            "type": "real",
+            "isArray": true,
+            "length": 4
+        }
+    ],
+    "parameters": [],
+    "outputs": [
+        {
+            "name": "prediction",
+            "description": "The prediction generated by ML model",
+            "agentOutputIndexes": ["0"]
+        }
+    ]
+}