loganoz / horses3d

HORSES3D: A high-order discontinuous Galerkin solver for flow simulations and multi-physics applications
https://loganoz.github.io/horses3d/
MIT License
112 stars 24 forks source link

Add an ML library #144

Closed Andres-MG closed 1 year ago

Andres-MG commented 1 year ago

This PR adds a new library for machine learning algorithms. It only implements clustering methods so far (k-means and GMM), but others could be added in the future without interfering with the main HORSES3D code.

Andres-MG commented 1 year ago

The only test we can do with this code is with the shock-capturing sensor. I can add one and, if anytime in the future we add a generic sensor in HORSES3D, test that instead.

Regarding the docs, this is more on the developers' side. Since the docs we have are also for end users, I don't know where I should put the new functions' API. Maybe a new section at the end?

loganoz commented 1 year ago

Thanks @Andres-MG. Add the test case with the shock capturing example. The important thing is that the new part of the code is run with the test, not so much the application. About the documentation, I agree with you. Not much changes for the end user. Having these kind of explanations for developers make sense, but I don't know where to put them. Let's discuss it today at the meeting.

loganoz commented 1 year ago

Thanks @Andres-MG. Add the test case with the shock capturing example. The important thing is that the new part of the code is run with the test, not so much the application. About the documentation, I agree with you. Not much changes for the end user. Having these kind of explanations for developers make sense, but I don't know where to put them. Let's discuss it today at the meeting.