Skip to content

Conversation

@StephanieKemna
Copy link
Collaborator

…s, including dataset, requirements, and instructions in the README

Description

Resolves #104

Added Python code and instructions for creating the keras and onnx models, for the examples in this repo. The split is a bit different from the other repo, I stuck to the structure here, so there are 2 separate train_model scripts, in each model folder. The utils.py is placed in the examples folder, so both folders/model creation scripts can access it.

Instructions are added to the README in the examples folder, and there is also a requirements file to get the correct packages.

How Has This Been Tested?

Following the instructions I added to README.md, I:

  • Tested creation of the wind.onnx model from nothing
  • Tested creation of the power.onnx model from nothing

Developer Checklist (before requesting PR review)

  • My code follows the style guidelines of this project (I added some ruff ignores to not deal with so many type ignores - these are not core scripts for this repo, just some examples)
  • My changes generate no new warnings
  • [n/a] Any dependent changes have been merged and published in downstream modules

I have:

  • not committed unnecessary formatting changes, thereby occluding the actual changes (e.g. change of tab spacing, eol, etc.)
  • made corresponding changes to the documentation
  • added change to CHANGELOG.md
  • [n/a] added tests that prove my fix is effective or that my feature works (for core features)

Reviewer checklist

I have:

  • performed a review of the code
  • tested that the software still works as expected
  • checked updates to documentation
  • checked that the CHANGELOG is updated

…s, including dataset, requirements, and instructions in the README
@StephanieKemna StephanieKemna self-assigned this Oct 2, 2025
@StephanieKemna StephanieKemna added the documentation Improvements or additions to documentation label Oct 2, 2025
Copy link
Collaborator

@KristofferSkare KristofferSkare left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like a good solution to get the code to generate the example onnx files/models into the repo. I think it should be fine just like this since the code seems unmodified.

However, I am a bit unsure if we should add the data used to train the model to the repo since it is pretty easy to download for the user, and this is a bit of a niche thing most users will not do. I think that is the only thing missing before I approve

@KristofferSkare KristofferSkare self-requested a review October 3, 2025 08:59
Copy link
Collaborator

@KristofferSkare KristofferSkare left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approve as my only comment was discussed and resolved

@StephanieKemna StephanieKemna merged commit 7c682f1 into main Oct 6, 2025
10 checks passed
@StephanieKemna StephanieKemna deleted the task/104-add-mlfmu-examples branch October 6, 2025 12:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Python code for MLFMU examples

3 participants