Skip to content

Commit 6e0d7f0

Browse files
Restructure documentation (#507)
* Restructure documentation Fixes #504 * fix typo * another typo
1 parent 61870b3 commit 6e0d7f0

File tree

3 files changed

+29
-69
lines changed

3 files changed

+29
-69
lines changed

docs/make.jl

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,37 @@ makedocs(
1212
canonical="https://diffeqflux.sciml.ai/stable/"),
1313
pages=[
1414
"DiffEqFlux.jl: Generalized Physics-Informed and Scientific Machine Learning (SciML)" => "index.md",
15-
"Basic Parameter Fitting Tutorials" => Any[
15+
"Ordinary Differential Equation (ODE) Tutorials" => Any[
1616
"examples/optimization_ode.md",
17-
"examples/optimization_sde.md",
18-
"examples/lotka_volterra.md",
19-
"examples/delay_diffeq.md",
20-
"examples/pde_constrained.md",
2117
"examples/stiff_ode_fit.md",
22-
],
23-
"Neural ODE and SDE Tutorials" => Any[
2418
"examples/neural_ode_sciml.md",
2519
"examples/neural_ode_flux.md",
2620
"examples/mnist_neural_ode.md",
27-
"examples/neural_sde.md",
2821
"examples/augmented_neural_ode.md",
2922
"examples/collocation.md",
3023
"examples/neural_gde.md",
24+
"examples/exogenous_input.md",
3125
"examples/normalizing_flows.md"
3226
],
27+
28+
"Stochastic Differential Equation (SDE) Tutorials" => Any[
29+
"examples/optimization_sde.md",
30+
"examples/neural_sde.md",
31+
],
32+
"Delay Differential Equation (DDE) Tutorials" => Any[
33+
"examples/delay_diffeq.md",
34+
],
35+
"Differential-Algebraic Equation (DAE) Tutorials" => Any[
36+
"examples/physical_constraints.md",
37+
],
38+
"Partial Differential Equation (PDE) Tutorials" => Any[
39+
"examples/pde_constrained.md",
40+
],
41+
"Hybrid and Jump Equation Tutorials" => Any[
42+
"examples/hybrid_diffeq.md",
43+
"examples/bouncing_ball.md",
44+
"examples/jump.md",
45+
],
3346
"Bayesian Estimation Tutorials" => Any[
3447
"examples/turing_bayesian.md",
3548
"examples/BayesianNODE_NUTS.md",
@@ -43,20 +56,13 @@ makedocs(
4356
"examples/second_order_adjoints.md",
4457
"examples/minibatch.md",
4558
],
46-
"Hybrid and Jump Tutorials" => Any[
47-
"examples/hybrid_diffeq.md",
48-
"examples/bouncing_ball.md",
49-
"examples/jump.md",
50-
],
5159
"Optimal and Model Predictive Control Tutorials" => Any[
5260
"examples/optimal_control.md",
5361
"examples/feedback_control.md",
5462
"examples/SDE_control.md",
5563
],
56-
"Universal Differential Equations and Physical Constraints Tutorials" => Any[
64+
"Universal Differential Equations and Physical Layer Tutorials" => Any[
5765
"examples/universal_diffeq.md",
58-
"examples/exogenous_input.md",
59-
"examples/physical_constraints.md",
6066
"examples/tensor_layer.md",
6167
"examples/hamiltonian_nn.md"
6268
],

docs/src/examples/lotka_volterra.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

docs/src/examples/pde_constrained.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Partial Differential Equation Constrained Optimization
1+
# Partial Differential Equation (PDE) Constrained Optimization
22

3-
This example uses a prediction model to optimize the one-dimensional Burgers' Equation.
3+
This example uses a prediction model to optimize the one-dimensional Heat Equation.
44
(Step-by-step description below)
55

66
```julia
@@ -40,15 +40,15 @@ function d2dx(u,dx)
4040
end
4141

4242
## ODE description of the Physics:
43-
function burgers(u,p,t)
43+
function heat(u,p,t)
4444
# Model parameters
4545
a0, a1 = p
4646
dx,Nx = xtrs #[1.0,3.0,0.125,100]
4747
return 2.0*a0 .* u + a1 .* d2dx(u, dx)
4848
end
4949

5050
# Testing Solver on linear PDE
51-
prob = ODEProblem(burgers,u0,tspan,p)
51+
prob = ODEProblem(heat,u0,tspan,p)
5252
sol = solve(prob,Tsit5(), dt=dt,saveat=t);
5353

5454
plot(x, sol.u[1], lw=3, label="t0", size=(800,500))
@@ -162,13 +162,13 @@ function d2dx(u,dx)
162162
end
163163
```
164164

165-
### Burgers' Differential Equation
165+
### Heat Differential Equation
166166

167167
Next, we setup our desired set of equations in order to define our problem.
168168

169169
```julia
170170
## ODE description of the Physics:
171-
function burgers(u,p,t)
171+
function heat(u,p,t)
172172
# Model parameters
173173
a0, a1 = p
174174
dx,Nx = xtrs #[1.0,3.0,0.125,100]
@@ -183,7 +183,7 @@ will compare to further on.
183183

184184
```julia
185185
# Testing Solver on linear PDE
186-
prob = ODEProblem(burgers,u0,tspan,p)
186+
prob = ODEProblem(heat,u0,tspan,p)
187187
sol = solve(prob,Tsit5(), dt=dt,saveat=t);
188188

189189
plot(x, sol.u[1], lw=3, label="t0", size=(800,500))

0 commit comments

Comments
 (0)