Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expand docs #2

Merged
merged 5 commits into from
Jul 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/api/arch/conv.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Feed-Forward Conv Net

::: pdequinox.arch.ConvNet
options:
members:
- __init__
- __call__
9 changes: 9 additions & 0 deletions docs/api/arch/dilated.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Dilated ResNet

A sequential convolutional architecture employing dilated convolutions for long-range interactions.

::: pdequinox.arch.DilatedResNet
options:
members:
- __init__
- __call__
9 changes: 9 additions & 0 deletions docs/api/arch/fno.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Fourier Neural Operator (FNO)

A Fourier pseudo-spectral architecture.

::: pdequinox.arch.ClassicFNO
options:
members:
- __init__
- __call__
7 changes: 7 additions & 0 deletions docs/api/arch/mlp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Multi-Layer Perceptron (MLP)

::: pdequinox.arch.MLP
options:
members:
- __init__
- __call__
15 changes: 15 additions & 0 deletions docs/api/arch/resnet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# (Convolutional) ResNet

::: pdequinox.arch.ClassicResNet
options:
members:
- __init__
- __call__

---

::: pdequinox.arch.ModernResNet
options:
members:
- __init__
- __call__
17 changes: 17 additions & 0 deletions docs/api/arch/unet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# UNet

A hierarchical multi-scale convolutional network.

::: pdequinox.arch.ClassicUNet
options:
members:
- __init__
- __call__

---

::: pdequinox.arch.ModernUNet
options:
members:
- __init__
- __call__
15 changes: 15 additions & 0 deletions docs/api/arch_constructors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Architectural Constructors

::: pdequinox.Sequential
options:
members:
- __init__
- __call__

---

::: pdequinox.Hierarchical
options:
members:
- __init__
- __call__
71 changes: 71 additions & 0 deletions docs/api/block_factories.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Block Factories

::: pdequinox.blocks.ClassicDoubleConvBlockFactory
options:
members:
- __init__
- __call__

---

::: pdequinox.blocks.ClassicResBlockFactory
options:
members:
- __init__
- __call__

---

::: pdequinox.blocks.ModernResBlockFactory
options:
members:
- __init__
- __call__

---

::: pdequinox.blocks.ClassicSpectralBlockFactory
options:
members:
- __init__
- __call__

---

::: pdequinox.blocks.DilatedResBlockFactory
options:
members:
- __init__
- __call__

---

::: pdequinox.blocks.LinearConvBlockFactory
options:
members:
- __init__
- __call__

---

::: pdequinox.blocks.LinearConvDownBlockFactory
options:
members:
- __init__
- __call__

---

::: pdequinox.blocks.LinearConvUpBlockFactory
options:
members:
- __init__
- __call__

---

::: pdequinox.blocks.BlockFactory
options:
members:
- __init__
- __call__
71 changes: 71 additions & 0 deletions docs/api/blocks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Blocks

::: pdequinox.blocks.ClassicDoubleConvBlock
options:
members:
- __init__
- __call__

---

::: pdequinox.blocks.ClassicResBlock
options:
members:
- __init__
- __call__

---

::: pdequinox.blocks.ModernResBlock
options:
members:
- __init__
- __call__

---

::: pdequinox.blocks.ClassicSpectralBlock
options:
members:
- __init__
- __call__

---

::: pdequinox.blocks.DilatedResBlock
options:
members:
- __init__
- __call__

---

::: pdequinox.blocks.LinearConvBlock
options:
members:
- __init__
- __call__

---

::: pdequinox.blocks.LinearConvDownBlock
options:
members:
- __init__
- __call__

---

::: pdequinox.blocks.LinearConvUpBlock
options:
members:
- __init__
- __call__

---

::: pdequinox.blocks.Block
options:
members:
- __init__
- __call__
34 changes: 34 additions & 0 deletions docs/api/conv.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Low-Level Convolution Routines

They wrap the `equinox.conv` module to provide an interface based on `"SAME"`
convolutions with variable boundary modes or implement spectral convolutions.

::: pdequinox.conv.PhysicsConv
options:
members:
- __init__
- __call__

---

::: pdequinox.conv.PhysicsConvTranspose
options:
members:
- __init__
- __call__

---

::: pdequinox.conv.SpectralConv
options:
members:
- __init__
- __call__

---

::: pdequinox.conv.PointwiseLinearConv
options:
members:
- __init__
- __call__
3 changes: 3 additions & 0 deletions docs/api/sample_data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Sample Data

::: pdequinox.sample_data
15 changes: 15 additions & 0 deletions docs/api/utils.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Utilities

::: pdequinox.dataloader

---

::: pdequinox.cycling_dataloader

---

::: pdequinox.extract_from_ensemble

---

::: pdequinox.combine_to_ensemble
Loading
Loading