Migrate neural network-based indicators to new repository #1701

sloede · 2023-11-02T16:38:03Z

As discussed at the last Trixi.jl meeting, we will move the currently unmaintained neural network-based indicators to a new repository, https://github.com/trixi-framework/TrixiSmartShockFinder.jl, for archival purposes.

See also the counterpart PR: trixi-framework/TrixiSmartShockFinder.jl#1

github-actions · 2023-11-02T16:38:22Z

Review checklist

This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.

Purpose and scope

The PR has a single goal that is clear from the PR title and/or description.
All code changes represent a single set of modifications that logically belong together.
No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.

Code quality

The code can be understood easily.
Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
There are no redundancies that can be removed by simple modularization/refactoring.
There are no leftover debug statements or commented code sections.
The code adheres to our conventions and style guide, and to the Julia guidelines.

Documentation

New functions and types are documented with a docstring or top-level comment.
Relevant publications are referenced in docstrings (see example for formatting).
Inline comments are used to document longer or unusual code sections.
Comments describe intent ("why?") and not just functionality ("what?").
If the PR introduces a significant change or new feature, it is documented in NEWS.md.

Testing

The PR passes all tests.
New or modified lines of code are covered by tests.
New or modified tests run in less then 10 seconds.

Performance

There are no type instabilities or memory allocations in performance-critical parts.
If the PR intent is to improve performance, before/after time measurements are posted in the PR.

Verification

The correctness of the code was verified using appropriate tests.
If new equations/methods are added, a convergence test has been run and the results
are posted in the PR.

Created with ❤️ by the Trixi.jl community.

codecov · 2023-11-02T18:18:28Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c79fa43) 72.65% compared to head (3408d2c) 81.14%.
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1701      +/-   ##
==========================================
+ Coverage   72.65%   81.14%   +8.49%     
==========================================
  Files         431      423       -8     
  Lines       34637    34230     -407     
==========================================
+ Hits        25164    27775    +2611     
+ Misses       9473     6455    -3018

Flag	Coverage Δ
unittests	`81.14% <ø> (+8.49%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
src/Trixi.jl	`42.86% <ø> (-0.62%)`	⬇️
src/solvers/dgsem_tree/indicators.jl	`89.69% <ø> (+16.45%)`	⬆️
src/solvers/dgsem_tree/indicators_1d.jl	`97.92% <ø> (+79.17%)`	⬆️
src/solvers/dgsem_tree/indicators_2d.jl	`96.93% <ø> (+49.47%)`	⬆️

... and 142 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

ranocha

Thanks! We should also

update NEWS.md
make a breaking release with it
update all issues tracking breaking changes accordingly

NEWS.md

sloede · 2023-11-03T16:36:40Z

This looks ready from my side. Thus, a review would be great. Please do not merge it until trixi-framework/TrixiSmartShockFinder.jl#1 was also approved.

NEWS.md

ranocha

Thanks! I changed the base to the new v0.6 development branch you have set up.

sloede · 2023-11-06T16:01:26Z

Thanks! I changed the base to the new v0.6 development branch you have set up.

Thanks! Can we merge this to the v0.6 staging branch once the tests pass?

ranocha · 2023-11-06T18:50:38Z

Sure - but some tests failed as in all other PRs as well...

ranocha · 2023-11-07T06:21:58Z

I will merge this now but we should spend some time to figure out why the tests fail...

* Remove all neural network indicator stuff from `src/` * Migrate neural network tests * Migrate neural network examples * Migrate test dependencies * Update NEWS.md * Fix typo * Remove Requires.jl-based use of Flux.jl * Fix formatting * Add migration of indicators to section with breaking changes --------- Co-authored-by: Hendrik Ranocha <[email protected]>

* Breaking changes HLL MHD * format * format examples * hlle * fix * news, tests, example changes * fmt * remove left-right-biased flux from test * Set version to v0.6.0 * Migrate neural network-based indicators to new repository (#1701) * Remove all neural network indicator stuff from `src/` * Migrate neural network tests * Migrate neural network examples * Migrate test dependencies * Update NEWS.md * Fix typo * Remove Requires.jl-based use of Flux.jl * Fix formatting * Add migration of indicators to section with breaking changes --------- Co-authored-by: Hendrik Ranocha <[email protected]> * fix hlle noncartesian 2d * remove parantheses * correct test vals * Make parabolic terms nonexperimental (#1714) * Make parabolic terms non-experimental * Make NSE a separate item * Add MPI to supported features * Mention that parabolic terms are now officially supported in NEWS.md Co-authored-by: Hendrik Ranocha <[email protected]> * Deprecate some `DGMultiMesh` constructors (#1709) * remove previously deprecated functions * fix typo in NEWS.md about deprecation vs removal * fix literate tutorial * removing other deprecation * format * Revert "fix typo in NEWS.md about deprecation vs removal" This reverts commit 6b03020. * add gradient variable type parameter to `AbstractEquationsParabolic` (#1409) * add gradient variable type parameter * fix parabolic literate test * remove trailing comment * remove unnecessary abstract type * move gradient variable structs * formatting * fix dropped changes * try to fix doc tests * fixing navier stokes 1D * formatting * remove duplicate GradientVariablesPrimitive/Entropy definition * update news * bring downloads back * fix failing test * fmt --------- Co-authored-by: Michael Schlottke-Lakemper <[email protected]> Co-authored-by: Hendrik Ranocha <[email protected]>

* Remove all neural network indicator stuff from `src/` * Migrate neural network tests * Migrate neural network examples * Migrate test dependencies * Update NEWS.md * Fix typo * Remove Requires.jl-based use of Flux.jl * Fix formatting * Add migration of indicators to section with breaking changes --------- Co-authored-by: Hendrik Ranocha <[email protected]>

* Breaking changes HLL MHD * format * format examples * hlle * fix * news, tests, example changes * fmt * remove left-right-biased flux from test * Set version to v0.6.0 * Migrate neural network-based indicators to new repository (#1701) * Remove all neural network indicator stuff from `src/` * Migrate neural network tests * Migrate neural network examples * Migrate test dependencies * Update NEWS.md * Fix typo * Remove Requires.jl-based use of Flux.jl * Fix formatting * Add migration of indicators to section with breaking changes --------- Co-authored-by: Hendrik Ranocha <[email protected]> * fix hlle noncartesian 2d * remove parantheses * correct test vals * Make parabolic terms nonexperimental (#1714) * Make parabolic terms non-experimental * Make NSE a separate item * Add MPI to supported features * Mention that parabolic terms are now officially supported in NEWS.md Co-authored-by: Hendrik Ranocha <[email protected]> * Deprecate some `DGMultiMesh` constructors (#1709) * remove previously deprecated functions * fix typo in NEWS.md about deprecation vs removal * fix literate tutorial * removing other deprecation * format * Revert "fix typo in NEWS.md about deprecation vs removal" This reverts commit 6b03020. * add gradient variable type parameter to `AbstractEquationsParabolic` (#1409) * add gradient variable type parameter * fix parabolic literate test * remove trailing comment * remove unnecessary abstract type * move gradient variable structs * formatting * fix dropped changes * try to fix doc tests * fixing navier stokes 1D * formatting * remove duplicate GradientVariablesPrimitive/Entropy definition * update news * bring downloads back * fix failing test * fmt --------- Co-authored-by: Michael Schlottke-Lakemper <[email protected]> Co-authored-by: Hendrik Ranocha <[email protected]>

Remove all neural network indicator stuff from src/

399ea3d

sloede mentioned this pull request Nov 2, 2023

[WIP] Migrate neural network-based indicators to new repository trixi-framework/TrixiSmartShockFinder.jl#1

Draft

sloede added 3 commits November 3, 2023 10:05

Migrate neural network tests

91b6cc5

Migrate neural network examples

7f184ad

Migrate test dependencies

4c61aaa

ranocha requested changes Nov 3, 2023

View reviewed changes

Update NEWS.md

caa708d

ranocha reviewed Nov 3, 2023

View reviewed changes

NEWS.md Outdated Show resolved Hide resolved

sloede added 3 commits November 3, 2023 11:44

Fix typo

7a78710

Remove Requires.jl-based use of Flux.jl

6f53bf1

Merge branch 'main' into msl/migrate-nn-based-indicators

dac05cb

sloede requested a review from ranocha November 3, 2023 16:36

Fix formatting

3627acb

This was referenced Nov 4, 2023

Release v0.6 #1310

Closed

Add new non-conservative flux for standard and two-layer shallow water equations #1508

Merged

ranocha requested changes Nov 6, 2023

View reviewed changes

NEWS.md Show resolved Hide resolved

Add migration of indicators to section with breaking changes

3408d2c

sloede added the breaking label Nov 6, 2023

Merge branch 'main' into msl/migrate-nn-based-indicators

4b79e1d

ranocha changed the base branch from main to v0.6-dev November 6, 2023 15:57

ranocha approved these changes Nov 6, 2023

View reviewed changes

sloede changed the title ~~[WIP] Migrate neural network-based indicators to new repository~~ Migrate neural network-based indicators to new repository Nov 6, 2023

sloede marked this pull request as ready for review November 6, 2023 16:00

ranocha merged commit 61c80ba into v0.6-dev Nov 7, 2023
28 of 30 checks passed

ranocha deleted the msl/migrate-nn-based-indicators branch November 7, 2023 06:22

sloede mentioned this pull request Nov 7, 2023

Staging for breaking release v0.6.0 #1705

Merged

2 tasks

This was referenced Feb 5, 2024

CompatHelper: bump compat for Flux to 0.14 for package test, (keep existing compat) #1568

Closed

CompatHelper: bump compat for Flux to 0.13 for package test, (keep existing compat) #1370

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate neural network-based indicators to new repository #1701

Migrate neural network-based indicators to new repository #1701

sloede commented Nov 2, 2023 •

edited

Loading

github-actions bot commented Nov 2, 2023

codecov bot commented Nov 2, 2023 •

edited

Loading

ranocha left a comment •

edited by sloede

Loading

sloede commented Nov 3, 2023

ranocha left a comment

sloede commented Nov 6, 2023

ranocha commented Nov 6, 2023 •

edited

Loading

ranocha commented Nov 7, 2023

Migrate neural network-based indicators to new repository #1701

Migrate neural network-based indicators to new repository #1701

Conversation

sloede commented Nov 2, 2023 • edited Loading

github-actions bot commented Nov 2, 2023

Review checklist

Purpose and scope

Code quality

Documentation

Testing

Performance

Verification

codecov bot commented Nov 2, 2023 • edited Loading

Codecov Report

ranocha left a comment • edited by sloede Loading

Choose a reason for hiding this comment

sloede commented Nov 3, 2023

ranocha left a comment

Choose a reason for hiding this comment

sloede commented Nov 6, 2023

ranocha commented Nov 6, 2023 • edited Loading

ranocha commented Nov 7, 2023

sloede commented Nov 2, 2023 •

edited

Loading

codecov bot commented Nov 2, 2023 •

edited

Loading

ranocha left a comment •

edited by sloede

Loading

ranocha commented Nov 6, 2023 •

edited

Loading