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.

Sign up for GitHub

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

Prepare MLFMU for open-source release #75

Merged
merged 3 commits into from
Nov 8, 2024
+82 −985
Merged

Prepare MLFMU for open-source release #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d3612dc
Remove mentions to internal tools and changelog from python template
Jorgelmh Nov 8, 2024
21a5778
Remove second pyspark model from ml_model
Jorgelmh Nov 8, 2024
61e095c
Change innersource to opensource and remove non-existing tagged releases
Jorgelmh Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 0 additions & 104 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,107 +103,3 @@ The changelog format is based on [Keep a Changelog](https://keepachangelog.com/e
* Updated to upload-artifact@v4 (from upload-artifact@v3)
* Updated to download-artifact@v4 (from download-artifact@v3)
* Updated to dictIO>=0.3.4 (from dictIO>=0.3.1)

## [0.1.6] - 2024-02-20

### Changed

* Moved all project configuration from setup.cfg to pyproject.toml
* Moved all tox configuration from setup.cfg to tox.ini.
* Moved pytest configuration from pyproject.toml to pytest.ini
* Deleted setup.cfg

### Dependencies

* updated to black[jupyter]==24.1 (from black[jupyter]==23.12)
* updated to ruff==0.2.1 (from ruff==0.1.8)
* updated to pyright==1.1.350 (from pyright==1.1.338)
* updated to sourcery==1.15 (from sourcery==1.14)
* updated to dictIO>=0.3.1 (from dictIO>=0.2.9)

## [0.1.5] - 2023-11-08

### Changed

* incorporated latest updates introduced in other repo

## [0.1.4] - 2023-09-25

### Dependencies

* Updated dependencies to latest versions

## [0.1.3] - 2023-08-24

### Changed

* GitHub workflow publish_release.yml: corrected smaller errors
* Explicitly removed .env file from remote repository
* Updated README.md to include guidance on how to create a .env file locally
* dependencies: updated packages in requirements-dev.txt to latest versions

## [0.1.2] - 2023-06-22

### Changed

* Modularized GitHub workflows
* requirements-dev.txt: Updated dependencies to latest versions
* setup.cfg: indicated supported Python versions as py310 and py311 <br>
(from formerly py39 and py310)
* GitHub workflows: changed default Python version from 3.10 to 3.11

## [0.1.1] - 2023-05-02

### Changed

* requirements-dev.txt: Updated dependencies to latest versions

## [0.1.0] - 2023-02-21

### Changed

* pyproject.toml: Changed ruff configuration to by default allow Uppercase variable names in functions. <br>
(As this is a very common case in science calculus)
* README.md: Changed install infos for development setup to pip install requirements-dev.txt (not requirements.txt)

## [0.0.1] - 2023-02-21

* Initial release

### Added

* added this

### Changed

* changed that

### Dependencies

* updated to some_package_on_pypi>=0.1.0

### Fixed

* fixed issue #12345

### Deprecated

* following features will soon be removed and have been marked as deprecated:
* function x in module z

### Removed

* following features have been removed:
* function y in module z

<!-- Markdown link & img dfn's -->
[unreleased]: https://github.com/dnv-innersource/mlfmu/compare/v0.1.6...HEAD
[0.1.6]: https://github.com/dnv-innersource/mlfmu/releases/tag/v0.1.5...v0.1.6
[0.1.5]: https://github.com/dnv-innersource/mlfmu/releases/tag/v0.1.4...v0.1.5
[0.1.4]: https://github.com/dnv-innersource/mlfmu/releases/tag/v0.1.3...v0.1.4
[0.1.3]: https://github.com/dnv-innersource/mlfmu/releases/tag/v0.1.2...v0.1.3
[0.1.2]: https://github.com/dnv-innersource/mlfmu/releases/tag/v0.1.1...v0.1.2
[0.1.1]: https://github.com/dnv-innersource/mlfmu/releases/tag/v0.1.0...v0.1.1
[0.1.0]: https://github.com/dnv-innersource/mlfmu/releases/tag/v0.0.1...v0.1.0
[0.0.1]: https://github.com/dnv-innersource/mlfmu/releases/tag/v0.0.1
[mlfmu]: https://github.com/dnv-innersource/mlfmu
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[![pypi](https://img.shields.io/pypi/v/mlfmu.svg?color=blue)](https://pypi.python.org/pypi/mlfmu)
[![versions](https://img.shields.io/pypi/pyversions/mlfmu.svg?color=blue)](https://pypi.python.org/pypi/mlfmu)
[![license](https://img.shields.io/pypi/l/mlfmu.svg)](https://github.com/dnv-innersource/mlfmu/blob/main/LICENSE)
![ci](https://img.shields.io/github/actions/workflow/status/dnv-innersource/mlfmu/.github%2Fworkflows%2Fnightly_build.yml?label=ci)
[![docs](https://img.shields.io/github/actions/workflow/status/dnv-innersource/mlfmu/.github%2Fworkflows%2Fpush_to_release.yml?label=docs)][mlfmu_docs]
[![license](https://img.shields.io/pypi/l/mlfmu.svg)](https://github.com/dnv-opensource/mlfmu/blob/main/LICENSE)
![ci](https://img.shields.io/github/actions/workflow/status/dnv-opensource/mlfmu/.github%2Fworkflows%2Fnightly_build.yml?label=ci)
[![docs](https://img.shields.io/github/actions/workflow/status/dnv-opensource/mlfmu/.github%2Fworkflows%2Fpush_to_release.yml?label=docs)][mlfmu_docs]

# mlfmu

Expand Down Expand Up @@ -175,7 +175,7 @@ We use conan for building the FMU. For the conan building to work later on, you
Clone the mlfmu repository into your local development directory:

```sh
git clone https://github.com/dnv-innersource/mlfmu path/to/your/dev/mlfmu
git clone https://github.com/dnv-opensource/mlfmu path/to/your/dev/mlfmu
git submodule update --init --recursive
```

Expand Down Expand Up @@ -302,7 +302,7 @@ Hee Jong Park - [@LinkedIn](https://www.linkedin.com/in/heejongpark/) - <hee.jon

## Contributing

1. Fork it (<https://github.com/dnv-innersource/mlfmu/fork>) (Note: this is currently disabled for this repo. For development, continue with the next step.)
1. Fork it (<https://github.com/dnv-opensource/mlfmu/fork>) (Note: this is currently disabled for this repo. For development, continue with the next step.)
2. Create an issue in your GitHub repo
3. Create your branch based on the issue number and type (`git checkout -b issue-name`)
4. Evaluate and stage the changes you want to commit (`git add -i`)
Expand All @@ -323,7 +323,7 @@ This code is distributed under the BSD 3-Clause license. See [LICENSE](LICENSE)
It makes use of [cpp-fmu], which is distributed under the MPL license at <https://github.com/viproma/cppfmu>.

<!-- Markdown link & img dfn's -->
[mlfmu_docs]: https://dnv-innersource.github.io/mlfmu/README.html
[mlfmu_docs]: https://dnv-opensource.github.io/mlfmu/README.html
[cpp-fmu]: https://github.com/viproma/cppfmu
[Open Simulation Platform]: https://opensimulationplatform.com/
[Simulation Trust Center]: https://store.veracity.com/simulation-trust-center
Binary file removed examples/wind_to_power_pyspark/ml_model/rf_model.onnx
View file
Open in desktop
Binary file not shown.
922 changes: 62 additions & 860 deletions ...s/wind_to_power_pyspark/ml_model/wind-turbine-power-prediction-gbtregressor-pyspark.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ packages = [

[project]
name = "mlfmu"
version = "1.0"
version = "1.0.0"
description = "Export ML models represented as ONNX files to Functional-Mockup-Units (FMU)"
readme = "README.md"
requires-python = ">= 3.10"
Expand Down Expand Up @@ -63,11 +63,11 @@ dependencies = [
]

[project.urls]
Homepage = "https://github.com/dnv-innersource/mlfmu"
Documentation = "https://dnv-innersource.github.io/mlfmu/README.html"
Repository = "https://github.com/dnv-innersource/mlfmu.git"
Issues = "https://github.com/dnv-innersource/mlfmu/issues"
Changelog = "https://github.com/dnv-innersource/mlfmu/blob/main/CHANGELOG.md"
Homepage = "https://github.com/dnv-opensource/mlfmu"
Documentation = "https://dnv-opensource.github.io/mlfmu/README.html"
Repository = "https://github.com/dnv-opensource/mlfmu.git"
Issues = "https://github.com/dnv-opensource/mlfmu/issues"
Changelog = "https://github.com/dnv-opensource/mlfmu/blob/main/CHANGELOG.md"


[tool.uv]
Expand Down
14 changes: 7 additions & 7 deletions ruff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ select = [
]
ignore = [
# Ruff lint rules temporarily ignored, but which should be reactivated and resolved in the future.
"D100", # Missing docstring in public module <- TODO @MVx: reactivate and resolve docstring issues @CLAROS, 2024-10-15
"D101", # Missing docstring in public class <- TODO @MVx: reactivate and resolve docstring issues @CLAROS, 2024-10-15
"D102", # Missing docstring in public method <- TODO @MVx: reactivate and resolve docstring issues @CLAROS, 2024-10-15
"D103", # Missing docstring in public function <- TODO @MVx: reactivate and resolve docstring issues @CLAROS, 2024-10-15
"D104", # Missing docstring in public package <- TODO @MVx: reactivate and resolve docstring issues @CLAROS, 2024-10-15
"D105", # Missing docstring in magic method <- TODO @MVx: reactivate and resolve docstring issues @CLAROS, 2024-10-15
"D107", # Missing docstring in __init__ <- TODO @MVx: reactivate and resolve docstring issues @CLAROS, 2024-10-15
"D100", # Missing docstring in public module
"D101", # Missing docstring in public class
"D102", # Missing docstring in public method
"D103", # Missing docstring in public function
"D104", # Missing docstring in public package
"D105", # Missing docstring in magic method
"D107", # Missing docstring in __init__
# Ruff lint rules considered as too strict and hence ignored
"ANN101", # Missing type annotation for `self` argument in instance methods (NOTE: also listed as deprecated by Ruff)
"ANN102", # Missing type annotation for `cls` argument in class methods (NOTE: also listed as deprecated by Ruff)
Expand Down
3 changes: 1 addition & 2 deletions tests/types/test_fmu_component.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
# TODO @MVx: Write tests for the FMUComponent class.
# CLAROS, 2024-10-15