Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

68 update readme for interface vector inputs #69

Merged
merged 7 commits into from
Nov 4, 2024

Conversation

MelihAkdag
Copy link
Collaborator

@MelihAkdag MelihAkdag commented Oct 23, 2024

Description

Resolves #68

  1. I updated the ReadMe file by changing the interface.json definition section. I included how to define an input vector.
    Also I pointed out where to find more information about the other sections for the interface schema.

  2. I also included the new example (wind power prediction model using Pyspark + Onnx + MLFMU under the examples directory. I included the jupyter notebook where I created the ML model, original dataset, final onnx model, interface.json, final fmu.

Developer Checklist (before requesting PR review)

  • My code follows the style guidelines of this project
  • My changes generate no new warnings
  • Any dependent changes have been merged and published in downstream modules

I have:

  • commented my code, particularly in hard-to-understand areas
  • performed a self-review of my own code
  • 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
  • added tests that prove my fix is effective or that my feature works (for core features)

Reviewer checklist

I have:

  • 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

@StephanieKemna StephanieKemna self-requested a review October 23, 2024 14:04
Copy link
Collaborator

@StephanieKemna StephanieKemna left a comment

Choose a reason for hiding this comment

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

Thanks, I expect this will be great! Just cannot test it right now .. so awaiting that.
Commented on some other aspects here. Also, changes should be added to CHANGELOG.

docs/source/CHANGELOG.md Show resolved Hide resolved
examples/wind_to_power/config/WindToPower.fmu Outdated Show resolved Hide resolved
@StephanieKemna
Copy link
Collaborator

@MelihAkdag we can merge main into this branch, and resolve conflicts? then I can test to run everything. Do you wanna do the merging and all, before I test, or want me to merge and resolve conflicts and test?

@StephanieKemna StephanieKemna added the enhancement New feature or request label Oct 31, 2024
@MelihAkdag MelihAkdag merged commit 01e4e95 into main Nov 4, 2024
10 checks passed
@MelihAkdag MelihAkdag deleted the 68-update-readme-for-interface-vector-inputs branch November 4, 2024 09:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Updating Readme
3 participants