onnx2fmu 0.0.1__tar.gz

onnx2fmu-0.0.1/.gitattributes

@@ -0,0 +1,17 @@
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto
+
+# Explicitly declare text files we want to always be normalized and converted
+# to native line endings on checkout.
+*.c text
+*.csv text
+*.h text
+*.html text
+*.md text
+*.py text
+*.txt text
+*.yml text
+.gitattributes text
+.gitignore text
+.mailmap text
+LICENSE text

onnx2fmu-0.0.1/.github/workflows/buil_branches.yml

@@ -0,0 +1,89 @@
+name: Build and test the project using self-hosted runners
+
+on:
+  push:
+    branches-ignore:
+      - master
+  pull_request:
+    branches-ignore:
+      - master
+
+jobs:
+
+  build_and_test_windows:
+    strategy:
+      matrix:
+        arch: [x86_64]
+        os: [windows]
+        python-version: ["3.10", "3.11", "3.12"]
+    runs-on: [self-hosted, windows]
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: "pip"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install numpy pandas onnx jinja2 loguru typer fmpy cmake
+          pip install -e .
+
+      - name: Python unit tests
+        run: |
+          python -m unittest tests.test_app
+
+      - name: Build example1 FMU
+        shell: pwsh
+        run: |
+          $fmi_platform = "${{ matrix.arch }}-${{ matrix.os }}"
+          onnx2fmu build tests/example1/example1.onnx tests/example1/example1Description.json --fmi-platform $fmi_platform
+
+      - name: Build example2 FMU
+        shell: pwsh
+        run: |
+          $fmi_platform = "${{ matrix.arch }}-${{ matrix.os }}"
+          onnx2fmu build tests/example2/example2.onnx tests/example2/example2Description.json --fmi-platform $fmi_platform
+
+  build_and_test_linux:
+    strategy:
+      matrix:
+        arch: [x86_64]
+        os: [linux]
+        python-version: ["3.10", "3.11", "3.12"]
+    runs-on: [self-hosted, linux]
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: "pip"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install numpy pandas onnx jinja2 loguru typer fmpy cmake
+          pip install -e .
+
+      - name: Python unit tests
+        run: |
+          python -m unittest tests.test_app
+
+      - name: Build example1 FMU
+        shell: bash -l {0}
+        run: |
+          onnx2fmu build tests/example1/example1.onnx tests/example1/example1Description.json --fmi-platform ${{ matrix.arch }}-${{ matrix.os }}
+
+      - name: Build example2 FMU
+        shell: bash -l {0}
+        run: |
+          onnx2fmu build tests/example2/example2.onnx tests/example2/example2Description.json --fmi-platform ${{ matrix.arch }}-${{ matrix.os }}

onnx2fmu-0.0.1/.github/workflows/build.yml

@@ -0,0 +1,86 @@
+name: Build and test the project master branch
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+
+  build_and_test:
+    strategy:
+      matrix:
+        include:
+          - name: x86-windows
+            image: windows-2022
+            arch: x86
+            python-version: "3.10"
+          - name: x86_64-windows
+            image: windows-2022
+            arch: x86_64
+            python-version: "3.10"
+          - name: x86_64-linux
+            image: ubuntu-20.04
+            arch: x86_64
+            python-version: "3.10"
+          - name: aarch64-linux
+            image: ubuntu-20.04
+            arch: aarch64
+            python-version: "3.10"
+          #   python-version: ["3.10"]
+          # - name: x86_64-darwin
+          #   image: macos-13
+          #   arch: x86_64
+          #   python-version: ["3.10"]
+          # - name: aarch64-darwin
+          #   image: macos-13
+          #   arch: aarch64
+          #   python-version: ["3.10"]
+    runs-on: ${{ matrix.image }}
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: "pip"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install numpy pandas onnx jinja2 loguru typer fmpy cmake
+          pip install -e .
+
+      - name: Python unit tests
+        run: |
+          python -m unittest tests.test_app
+
+      - name: Build example1 FMU (Windows)
+        if: runner.os == 'Windows'
+        shell: cmd
+        run: |
+          onnx2fmu build tests/example1/example1.onnx tests/example1/example1Description.json --fmi-platform ${{ matrix.name }}
+
+      - name: Build example1 FMU (non-Windows)
+        if: runner.os != 'Windows'
+        shell: bash
+        run: |
+          onnx2fmu build tests/example1/example1.onnx tests/example1/example1Description.json --fmi-platform ${{ matrix.name }}
+
+      - name: Build example2 FMU (Windows)
+        if: runner.os == 'Windows'
+        shell: cmd
+        run: |
+          onnx2fmu build tests/example2/example2.onnx tests/example2/example2Description.json --fmi-platform ${{ matrix.name }}
+
+      - name: Build example2 FMU (non-Windows)
+        if: runner.os != 'Windows'
+        shell: bash
+        run: |
+          onnx2fmu build tests/example2/example2.onnx tests/example2/example2Description.json --fmi-platform ${{ matrix.name }}

onnx2fmu-0.0.1/.gitignore

@@ -0,0 +1,15 @@
+# build artifacts
+__pycache__
+.cache
+.idea/
+*.fmu
+*.zip
+*_out.csv
+
+# Environment variables
+.env
+
+# Python virtual environments
+.venv/
+/build/
+.vscode/

onnx2fmu-0.0.1/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: onnx2fmu
+Version: 0.0.1
+Summary: A tool for wrapping ONNX netwroks in FMUs.
+Author-email: Michele Urbani <murbani@fbk.eu>
+Requires-Python: ~=3.10
+Description-Content-Type: text/markdown
+Classifier: Programming Language :: Python :: 3
+Requires-Dist: onnx
+Requires-Dist: jinja2
+Requires-Dist: cmake
+Requires-Dist: numpy
+Requires-Dist: loguru
+Requires-Dist: typer
+
+# ONNX2FMU: Encapsulate ONNX models in Functional Mock-up Units (FMUs)
+
+**What ONNX2FMU does?** It wraps ONNX models into FMUs by generating the C code
+and subsequently compiling it.
+
+## 🚀 Get started
+
+- Python 3.10+
+- CMake 3.22+
+- A code compiler for the host platform, which could be one of linux, windows
+and macos.
+
+The default Windows CMake Generator is Visual Studio 2022.
+
+## 📝 ONNX model declaration
+
+ONNX2FMU can handle models with multiple inputs and outputs as far as
+1. the model description lists all inputs and outputs, and node names are
+compliant with the node names in the ONNX model;
+2. Input and output nodes have no 0 dimension, i.e., they have shapes like
+`(N, )`, `(1, N)`, etc., with `N` being any tensor dimension.
+
+### Model description file
+
+A model description is declared in a JSON file and its schema includes the
+following global items:
+
+- `"name"` is the model name, which will also be the FMU archive name,
+- `"description"` provides a generic description of the model,
+- `"FMIVersion"` is the FMI standard version for generatign the FMU code and
+the FMU binaries,
+- `"inputs"` and `"outputs"` are the lists of inputs and output nodes in the
+ONNX model.
+
+Each entry of the the inputs and output lists is characterized by the following
+schema:
+
+- `"name"` must match the name of one of the model nodes, whereas
+- `"names"` is the list of user-provided names for each of the node elements.
+The number of names must match the number of elements in a given entry.
+- `"description"` allows the user to attach a description to each of the
+arrays.
+
+The following is an example of a model description for a model with three
+input nodes and one output node.
+
+### Causality of model variables
+
+Variables of type `local` can be declared but they do not change during a
+simulation. Indeed, the value of `local` variables must be defined *ad hoc* in
+the model and cannot be defined automatically by ONNX2FMU.
+
+### State variables
+
+State variables, which may usually be declare using variables with `local`
+causality, are not handled by ONNX2FMU. This is because there is no standard
+behaviour to rely on for their definition in the source code.
+
+To handle state variables, the original ONNX model should be wrapped in model
+that keep track of the state. The following example could help understanding
+how to manage the presence of a state.
+
+```python
+class CompleteModel(nn.Module):
+
+    def __init__(self):
+        super(CompleteModel).__init__()
+        self.fc1 = ...
+        self.relu = ...
+
+    def forward(self, X):
+        X = self.fc1(X)
+        X = self.relu(X)
+        return X
+
+
+class WrapperModel(nn.Module):
+
+    def __init__(self, complete_model: CompleteModel, initial_state):
+        super(WrapperModel).__init__()
+        self.model = complete_model
+        self.state = initial_state
+
+    def forward(self, u):
+        # Concatenate the control u with the state
+        X = torch.stack((u, self.state))
+        # Predic the state of the system at time t
+        Y = self.model(X)
+        # Part of the output Y is the state of the system at time t, which is
+        # stored in self.state
+        self.state = Y[:(N_state_elements)]
+        # Return the complete output to be used in the rest of the simulation
+        return Y
+
+```
+
+## ONNX model generation
+
+**Only co-simulation** FMUs can be generated.
+

onnx2fmu-0.0.1/README.md

@@ -0,0 +1,99 @@
+# ONNX2FMU: Encapsulate ONNX models in Functional Mock-up Units (FMUs)
+
+**What ONNX2FMU does?** It wraps ONNX models into FMUs by generating the C code
+and subsequently compiling it.
+
+## 🚀 Get started
+
+- Python 3.10+
+- CMake 3.22+
+- A code compiler for the host platform, which could be one of linux, windows
+and macos.
+
+The default Windows CMake Generator is Visual Studio 2022.
+
+## 📝 ONNX model declaration
+
+ONNX2FMU can handle models with multiple inputs and outputs as far as
+1. the model description lists all inputs and outputs, and node names are
+compliant with the node names in the ONNX model;
+2. Input and output nodes have no 0 dimension, i.e., they have shapes like
+`(N, )`, `(1, N)`, etc., with `N` being any tensor dimension.
+
+### Model description file
+
+A model description is declared in a JSON file and its schema includes the
+following global items:
+
+- `"name"` is the model name, which will also be the FMU archive name,
+- `"description"` provides a generic description of the model,
+- `"FMIVersion"` is the FMI standard version for generatign the FMU code and
+the FMU binaries,
+- `"inputs"` and `"outputs"` are the lists of inputs and output nodes in the
+ONNX model.
+
+Each entry of the the inputs and output lists is characterized by the following
+schema:
+
+- `"name"` must match the name of one of the model nodes, whereas
+- `"names"` is the list of user-provided names for each of the node elements.
+The number of names must match the number of elements in a given entry.
+- `"description"` allows the user to attach a description to each of the
+arrays.
+
+The following is an example of a model description for a model with three
+input nodes and one output node.
+
+### Causality of model variables
+
+Variables of type `local` can be declared but they do not change during a
+simulation. Indeed, the value of `local` variables must be defined *ad hoc* in
+the model and cannot be defined automatically by ONNX2FMU.
+
+### State variables
+
+State variables, which may usually be declare using variables with `local`
+causality, are not handled by ONNX2FMU. This is because there is no standard
+behaviour to rely on for their definition in the source code.
+
+To handle state variables, the original ONNX model should be wrapped in model
+that keep track of the state. The following example could help understanding
+how to manage the presence of a state.
+
+```python
+class CompleteModel(nn.Module):
+
+    def __init__(self):
+        super(CompleteModel).__init__()
+        self.fc1 = ...
+        self.relu = ...
+
+    def forward(self, X):
+        X = self.fc1(X)
+        X = self.relu(X)
+        return X
+
+
+class WrapperModel(nn.Module):
+
+    def __init__(self, complete_model: CompleteModel, initial_state):
+        super(WrapperModel).__init__()
+        self.model = complete_model
+        self.state = initial_state
+
+    def forward(self, u):
+        # Concatenate the control u with the state
+        X = torch.stack((u, self.state))
+        # Predic the state of the system at time t
+        Y = self.model(X)
+        # Part of the output Y is the state of the system at time t, which is
+        # stored in self.state
+        self.state = Y[:(N_state_elements)]
+        # Return the complete output to be used in the rest of the simulation
+        return Y
+
+```
+
+## ONNX model generation
+
+**Only co-simulation** FMUs can be generated.

onnx2fmu-0.0.1/environment.yml

@@ -0,0 +1,18 @@
+name: onnx2fmu
+channels:
+  - conda-forge
+  - defaults
+dependencies:
+  - python=3.10
+  - pip
+  - onnx
+  - jinja2
+  - loguru
+  - typer
+  - flake8
+  - fmpy
+  - cmake
+  - numpy
+  - pandas
+  - pip:
+    - -e .