Skip to content
This repository was archived by the owner on Sep 28, 2024. It is now read-only.

Commit fe8a1fe

Browse files
committed
Update docs
1 parent f314f25 commit fe8a1fe

File tree

3 files changed

+6
-12
lines changed

3 files changed

+6
-12
lines changed

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@ model = Chain(
5757
# project back to the scalar field of interest space
5858
Dense(64, 128, gelu),
5959
Dense(128, 1),
60-
flatten
6160
)
6261
```
6362

docs/src/index.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ CurrentModule = NeuralOperators
99
| **Ground Truth** | **Inferenced** |
1010

1111
The demonstration shown above is Navier-Stokes equation learned by the `MarkovNeuralOperator` with only one time step information.
12-
Example can be found in [`example/FlowOverCircle`](../../example/FlowOverCircle).
12+
Example can be found in [`example/FlowOverCircle`](https://github.com/SciML/NeuralOperators.jl/tree/master/example/FlowOverCircle).
1313

1414
## Quick start
1515

@@ -36,7 +36,6 @@ model = Chain(
3636
# project back to the scalar field of interest space
3737
Dense(64, 128, gelu),
3838
Dense(128, 1),
39-
flatten
4039
)
4140
```
4241

@@ -53,7 +52,7 @@ model = FourierNeuralOperator(
5352
And then train as a Flux model.
5453

5554
```julia
56-
loss(𝐱, 𝐲) = Flux.Losses.mse(model(𝐱), 𝐲)
55+
loss(𝐱, 𝐲) = l₂loss(model(𝐱), 𝐲)
5756
opt = Flux.Optimiser(WeightDecay(1f-4), Flux.ADAM(1f-3))
5857
Flux.@epochs 50 Flux.train!(loss, params(model), data, opt)
5958
```
@@ -85,4 +84,4 @@ opt = ADAM(learning_rate)
8584
parameters = params(model)
8685
Flux.@epochs 400 Flux.train!(loss, parameters, [(xtrain, ytrain, grid)], opt, cb=evalcb)
8786
```
88-
A more complete example using DeepONet architecture to solve Burgers' equation can be found in the [examples](../../example/Burgers/src/Burgers_deeponet.jl).
87+
A more complete example using DeepONet architecture to solve Burgers' equation can be found in the [examples](https://github.com/SciML/NeuralOperators.jl/blob/master/example/Burgers/src/Burgers_deeponet.jl).

docs/src/introduction.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,19 @@ an operator mapping from infinite-dimensional space ``(u, t)`` to infinite-dimen
88
Neural operator learns a continuous function between two continuous function spaces.
99
The kernel can be trained on different geometry, including regular Euclidean space or a graph topology.
1010

11-
## Fourier Neural Operators
11+
## [Fourier Neural Operators](https://github.com/SciML/NeuralOperators.jl/blob/master/src/model.jl)
1212

1313
Fourier neural operator (FNO) learns a neural operator with Dirichlet kernel to form a Fourier transformation.
1414
It performs Fourier transformation across infinite-dimensional function spaces and learns better than neural operator.
1515

16-
## Markov Neural Operators
16+
## [Markov Neural Operators](https://github.com/SciML/NeuralOperators.jl/blob/master/src/model.jl)
1717

1818
Markov neural operator (MNO) learns a neural operator with Fourier operators.
1919
With only one time step information of learning, it can predict the following few steps with low loss
2020
by linking the operators into a Markov chain.
2121

22-
## Deep Operator Network
22+
## [Deep Operator Network](https://github.com/SciML/NeuralOperators.jl/blob/master/src/DeepONet.jl)
2323

2424
Deep operator network (DeepONet) learns a neural operator with the help of two sub-neural network structures described as the branch and the trunk network.
2525
The branch network is fed the initial conditions data, whereas the trunk is fed with the locations where the target(output) is evaluated from the corresponding initial conditions.
2626
It is important that the output size of the branch and trunk subnets is same so that a dot product can be performed between them.
27-
28-
Currently, the `OperatorKernel` layer is provided in this work.
29-
As for model, there are `FourierNeuralOperator` and `MarkovNeuralOperator` provided.
30-
Please take a glance at [them](apis.html#Models).

0 commit comments

Comments
 (0)