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

Commit 70f4fe0

Browse files
committed
add models in apis
1 parent f89c749 commit 70f4fe0

File tree

3 files changed

+59
-36
lines changed

3 files changed

+59
-36
lines changed

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ makedocs(;
1515
),
1616
pages=[
1717
"Home" => "index.md",
18+
"APIs" => "apis.md"
1819
],
1920
)
2021

docs/src/apis.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
## Index
2+
3+
```@index
4+
```
5+
6+
## Layers
7+
8+
### Spectral convolutional layer
9+
10+
```math
11+
F(s) = \mathcal{F} \{ v(x) \} \\
12+
F'(s) = g(F(s)) \\
13+
v'(x) = \mathcal{F}^{-1} \{ F'(s) \}
14+
```
15+
16+
where ``v(x)`` and ``v'(x)`` denotes input and output function, ``\mathcal{F} \{ \cdot \}``, ``\mathcal{F}^{-1} \{ \cdot \}`` are Fourier transform, inverse Fourier transform, respectively. Function ``g`` is a linear transform for lowering Fouier modes.
17+
18+
```@docs
19+
SpectralConv
20+
```
21+
22+
Reference: [Fourier Neural Operator for Parametric Partial Differential Equations](https://arxiv.org/abs/2010.08895)
23+
24+
---
25+
26+
### Fourier operator layer
27+
28+
```math
29+
v_{t+1}(x) = \sigma(W v_t(x) + \mathcal{K} \{ v_t(x) \} )
30+
```
31+
32+
where ``v_t(x)`` is the input function for ``t``-th layer and ``\mathcal{K} \{ \cdot \}`` denotes spectral convolutional layer. Activation function ``\sigma`` can be arbitrary non-linear function.
33+
34+
```@docs
35+
FourierOperator
36+
```
37+
38+
Reference: [Fourier Neural Operator for Parametric Partial Differential Equations](https://arxiv.org/abs/2010.08895)
39+
40+
## Models
41+
42+
### Fourier neural operator
43+
44+
```@docs
45+
FourierNeuralOperator
46+
```
47+
48+
Reference: [Fourier Neural Operator for Parametric Partial Differential Equations](https://arxiv.org/abs/2010.08895)
49+
50+
---
51+
52+
### Markov neural operator
53+
54+
```@docs
55+
MarkovNeuralOperator
56+
```
57+
58+
Reference: [Markov Neural Operators for Learning Chaotic Systems](https://arxiv.org/abs/2106.06898)

docs/src/index.md

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -8,39 +8,3 @@ Documentation for [NeuralOperators](https://github.com/foldfelis/NeuralOperators
88

99
[Example of `MarkovNeuralOperator`](assets/notebook/mno.jl.html)
1010

11-
```@index
12-
```
13-
14-
## Layers
15-
16-
### Spectral convolutional layer
17-
18-
```math
19-
F(s) = \mathcal{F} \{ v(x) \} \\
20-
F'(s) = g(F(s)) \\
21-
v'(x) = \mathcal{F}^{-1} \{ F'(s) \}
22-
```
23-
24-
where ``v(x)`` and ``v'(x)`` denotes input and output function, ``\mathcal{F} \{ \cdot \}``, ``\mathcal{F}^{-1} \{ \cdot \}`` are Fourier transform, inverse Fourier transform, respectively. Function ``g`` is a linear transform for lowering Fouier modes.
25-
26-
```@docs
27-
SpectralConv
28-
```
29-
30-
Reference: [Fourier Neural Operator for Parametric Partial Differential Equations](https://arxiv.org/abs/2010.08895)
31-
32-
---
33-
34-
### Fourier operator layer
35-
36-
```math
37-
v_{t+1}(x) = \sigma(W v_t(x) + \mathcal{K} \{ v_t(x) \} )
38-
```
39-
40-
where ``v_t(x)`` is the input function for ``t``-th layer and ``\mathcal{K} \{ \cdot \}`` denotes spectral convolutional layer. Activation function ``\sigma`` can be arbitrary non-linear function.
41-
42-
```@docs
43-
FourierOperator
44-
```
45-
46-
Reference: [Fourier Neural Operator for Parametric Partial Differential Equations](https://arxiv.org/abs/2010.08895)

0 commit comments

Comments
 (0)