Skip to content

Commit 6f1cc2c

Browse files
committed
docs: update README
1 parent 7f9d22b commit 6f1cc2c

File tree

1 file changed

+49
-5
lines changed

1 file changed

+49
-5
lines changed

README.md

Lines changed: 49 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,50 @@
1-
# NeuralOperators
1+
# NeuralOperators.jl
22

3-
NeuralOperators built using [Lux.jl](https://lux.csail.mit.edu/).
4-
For a version built using an old-generation framework [Flux.jl](https://fluxml.ai/), see
5-
[NeuralOperators.jl](https://docs.sciml.ai/NeuralOperators/stable/), though that version
6-
will be soon replaced by this one.
3+
[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
4+
[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/NeuralOperators/stable/)
5+
6+
[![codecov](https://codecov.io/gh/SciML/NeuralOperators.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/SciML/NeuralOperators.jl)
7+
[![Build Status](https://github.com/SciML/NeuralOperators.jl/workflows/CI/badge.svg)](https://github.com/SciML/NeuralOperators.jl/actions?query=workflow%3ACI)
8+
[![Build status](https://badge.buildkite.com/dd09599b08f61de1b5c7960aacd5390554c53e3b54f1407ba1.svg?branch=main)](https://buildkite.com/julialang/neuraloperators-dot-jl)
9+
10+
[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor%27s%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
11+
[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
12+
13+
NeuralOperators.jl is a package written in Julia to provide the architectures for learning
14+
mapping between function spaces, and learning grid invariant solution of PDEs. Checkout the
15+
[documentation](https://docs.sciml.ai/NeuralOperators/stable/) for tutorials and API
16+
reference.
17+
18+
## Installation
19+
20+
On Julia 1.10+, you can install `NeuralOperators.jl` by running
21+
22+
```julia
23+
import Pkg
24+
Pkg.add("NeuralOperators")
25+
```
26+
27+
## Citation
28+
29+
If you found this library to be useful in academic work, then please cite:
30+
31+
```bibtex
32+
@software{pal2023lux,
33+
author = {Pal, Avik},
34+
title = {{Lux: Explicit Parameterization of Deep Neural Networks in Julia}},
35+
month = apr,
36+
year = 2023,
37+
note = {If you use this software, please cite it as below.},
38+
publisher = {Zenodo},
39+
version = {v0.5.0},
40+
doi = {10.5281/zenodo.7808904},
41+
url = {https://doi.org/10.5281/zenodo.7808904}
42+
}
43+
44+
@thesis{pal2023efficient,
45+
title = {{On Efficient Training \& Inference of Neural Differential Equations}},
46+
author = {Pal, Avik},
47+
year = {2023},
48+
school = {Massachusetts Institute of Technology}
49+
}
50+
```

0 commit comments

Comments
 (0)