-
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
49 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,50 @@ | ||
| # NeuralOperators | ||
| # NeuralOperators.jl | ||
|
|
||
| NeuralOperators built using [Lux.jl](https://lux.csail.mit.edu/). | ||
| For a version built using an old-generation framework [Flux.jl](https://fluxml.ai/), see | ||
| [NeuralOperators.jl](https://docs.sciml.ai/NeuralOperators/stable/), though that version | ||
| will be soon replaced by this one. | ||
| [](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged) | ||
| [](https://docs.sciml.ai/NeuralOperators/stable/) | ||
|
|
||
| [](https://codecov.io/gh/SciML/NeuralOperators.jl) | ||
| [](https://github.com/SciML/NeuralOperators.jl/actions?query=workflow%3ACI) | ||
| [](https://buildkite.com/julialang/neuraloperators-dot-jl) | ||
|
|
||
| [](https://github.com/SciML/ColPrac) | ||
| [](https://github.com/SciML/SciMLStyle) | ||
|
|
||
| NeuralOperators.jl is a package written in Julia to provide the architectures for learning | ||
| mapping between function spaces, and learning grid invariant solution of PDEs. Checkout the | ||
| [documentation](https://docs.sciml.ai/NeuralOperators/stable/) for tutorials and API | ||
| reference. | ||
|
|
||
| ## Installation | ||
|
|
||
| On Julia 1.10+, you can install `NeuralOperators.jl` by running | ||
|
|
||
| ```julia | ||
| import Pkg | ||
| Pkg.add("NeuralOperators") | ||
| ``` | ||
|
|
||
| ## Citation | ||
|
|
||
| If you found this library to be useful in academic work, then please cite: | ||
|
|
||
| ```bibtex | ||
| @software{pal2023lux, | ||
| author = {Pal, Avik}, | ||
| title = {{Lux: Explicit Parameterization of Deep Neural Networks in Julia}}, | ||
| month = apr, | ||
| year = 2023, | ||
| note = {If you use this software, please cite it as below.}, | ||
| publisher = {Zenodo}, | ||
| version = {v0.5.0}, | ||
| doi = {10.5281/zenodo.7808904}, | ||
| url = {https://doi.org/10.5281/zenodo.7808904} | ||
| } | ||
| @thesis{pal2023efficient, | ||
| title = {{On Efficient Training \& Inference of Neural Differential Equations}}, | ||
| author = {Pal, Avik}, | ||
| year = {2023}, | ||
| school = {Massachusetts Institute of Technology} | ||
| } | ||
| ``` |
6f1cc2cThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@JuliaRegistrator register
6f1cc2cThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Registration pull request created: JuliaRegistries/General/116243
Tip: Release Notes
Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.
To add them here just re-invoke and the PR will be updated.
Tagging
After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.
This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via: