Merge pull request #2 from Ceyron/expand-docs

Expand docs

docs/api/arch/conv.md

@@ -0,0 +1,7 @@
+# Feed-Forward Conv Net
+
+::: pdequinox.arch.ConvNet
+    options:
+        members:
+            - __init__
+            - __call__

docs/api/arch/dilated.md

@@ -0,0 +1,9 @@
+# Dilated ResNet
+
+A sequential convolutional architecture employing dilated convolutions for long-range interactions.
+
+::: pdequinox.arch.DilatedResNet
+    options:
+        members:
+            - __init__
+            - __call__

docs/api/arch/fno.md

@@ -0,0 +1,9 @@
+# Fourier Neural Operator (FNO)
+
+A Fourier pseudo-spectral architecture.
+
+::: pdequinox.arch.ClassicFNO
+    options:
+        members:
+            - __init__
+            - __call__

docs/api/arch/mlp.md

@@ -0,0 +1,7 @@
+# Multi-Layer Perceptron (MLP)
+
+::: pdequinox.arch.MLP
+    options:
+        members:
+            - __init__
+            - __call__

docs/api/arch/resnet.md

@@ -0,0 +1,15 @@
+# (Convolutional) ResNet
+
+::: pdequinox.arch.ClassicResNet
+    options:
+        members:
+            - __init__
+            - __call__
+
+---
+
+::: pdequinox.arch.ModernResNet
+    options:
+        members:
+            - __init__
+            - __call__

docs/api/arch/unet.md

@@ -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__

docs/api/arch_constructors.md

@@ -0,0 +1,15 @@
+# Architectural Constructors
+
+::: pdequinox.Sequential
+    options:
+        members:
+            - __init__
+            - __call__
+
+---
+
+::: pdequinox.Hierarchical
+    options:
+        members:
+            - __init__
+            - __call__

docs/api/block_factories.md

@@ -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__

docs/api/blocks.md

@@ -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__

docs/api/conv.md

@@ -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__

docs/api/sample_data.md

@@ -0,0 +1,3 @@
+# Sample Data
+
+::: pdequinox.sample_data

docs/api/utils.md

@@ -0,0 +1,15 @@
+# Utilities
+
+::: pdequinox.dataloader
+
+---
+
+::: pdequinox.cycling_dataloader
+
+---
+
+::: pdequinox.extract_from_ensemble
+
+---
+
+::: pdequinox.combine_to_ensemble