Add mkdocs (#1)

Ceyron · web-flow · commit 4af1f7b748d3 · 2024-06-25T09:20:01.000+02:00
* Add barebone setup for mkdocs

* Move resources under docs

* Copy readme into docs index

* Add notebooks and example notebook

* Add high-level trainers

* Add callbacks to high-level API

* Add low-level utilities

* Add sample data

* Add base classes to documentation

* Add favicon

* Placeholder for background markdowns
diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
@@ -0,0 +1,34 @@
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install .
+          python -m pip install -r docs/requirements.txt
+
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 <h1 align="center">
-  <img src="img/trainax_logo.png" width="400">
+  <img src="docs/imgs/trainax_logo.png" width="400">
   <br>
     Trainax
   <br>
@@ -19,7 +19,7 @@
 </p>
 
 <p align="center">
-    <img src="img/sample_two_step_supervised.svg" width="400">
+    <img src="docs/imgs/sample_two_step_supervised.svg" width="400">
 </p>
 
 ## Installation
diff --git a/docs/api/callbacks.md b/docs/api/callbacks.md
@@ -0,0 +1,48 @@
+# Callbacks
+
+::: trainax.callback.SaveNetwork
+    options:
+        members:
+            - __init__
+
+---
+
+::: trainax.callback.GetNetwork
+    options:
+        members:
+            - __init__
+
+---
+
+::: trainax.callback.WeightNorm
+    options:
+        members:
+            - __init__
+
+---
+
+::: trainax.callback.Loss
+    options:
+        members:
+            - __init__
+
+---
+
+::: trainax.callback.GradNorm
+    options:
+        members:
+            - __init__
+
+---
+
+::: trainax.callback.CompositeCallback
+    options:
+        members:
+            - __init__
+
+---
+
+::: trainax.callback.BaseCallback
+    options:
+        members:
+            - __init__
diff --git a/docs/api/configuration/base.md b/docs/api/configuration/base.md
@@ -0,0 +1,7 @@
+# Base Configuration
+
+::: trainax.configuration.BaseConfiguration
+    options:
+        members:
+            - __init__
+            - __call__
diff --git a/docs/api/configuration/composite.md b/docs/api/configuration/composite.md
@@ -0,0 +1,7 @@
+# Composite Configuration
+
+::: trainax.configuration.Composite
+    options:
+        members:
+            - __init__
+            - __call__
diff --git a/docs/api/configuration/diverted_chain.md b/docs/api/configuration/diverted_chain.md
@@ -0,0 +1,15 @@
+# Diverted-Chain
+
+::: trainax.configuration.DivertedChainBranchOne
+    options:
+        members:
+            - __init__
+            - __call__
+
+---
+
+::: trainax.configuration.DivertedChain
+    options:
+        members:
+            - __init__
+            - __call__
diff --git a/docs/api/configuration/mix_chain.md b/docs/api/configuration/mix_chain.md
@@ -0,0 +1,7 @@
+# Mixed-Chain
+
+::: trainax.configuration.MixChainPostPhysics
+    options:
+        members:
+            - __init__
+            - __call__
diff --git a/docs/api/configuration/residuum.md b/docs/api/configuration/residuum.md
@@ -0,0 +1,7 @@
+# Residuum
+
+::: trainax.configuration.Residuum
+    options:
+        members:
+            - __init__
+            - __call__
diff --git a/docs/api/configuration/supervised.md b/docs/api/configuration/supervised.md
@@ -0,0 +1,7 @@
+# Supervised
+
+::: trainax.configuration.Supervised
+    options:
+        members:
+            - __init__
+            - __call__
diff --git a/docs/api/general_trainer.md b/docs/api/general_trainer.md
@@ -0,0 +1,7 @@
+# General Trainer
+
+::: trainax.GeneralTrainer
+    options:
+        members:
+            - __init__
+            - __call__
diff --git a/docs/api/loss.md b/docs/api/loss.md
@@ -0,0 +1,39 @@
+# Losses
+
+::: trainax.loss.MSELoss
+    options:
+        members:
+            - __init__
+            - __call__
+
+---
+
+::: trainax.loss.Normalized_MSELoss
+    options:
+        members:
+            - __init__
+            - __call__
+
+---
+
+::: trainax.loss.MAELoss
+    options:
+        members:
+            - __init__
+            - __call__
+
+---
+
+::: trainax.loss.Normalized_MAELoss
+    options:
+        members:
+            - __init__
+            - __call__
+
+---
+
+::: trainax.loss.BaseLoss
+    options:
+        members:
+            - __init__
+            - __call__
diff --git a/docs/api/sample_data.md b/docs/api/sample_data.md
@@ -0,0 +1,3 @@
+# Sample Data
+
+::: trainax.sample_data.advection_1d_periodic
diff --git a/docs/api/trainer/diverted_chain.md b/docs/api/trainer/diverted_chain.md
@@ -0,0 +1,7 @@
+# Diverted Chain
+
+::: trainax.trainer.DivertedChainBranchOneTrainer
+    options:
+        members:
+            - __init__
+            - __call__
diff --git a/docs/api/trainer/mixed_chain.md b/docs/api/trainer/mixed_chain.md
@@ -0,0 +1,3 @@
+# Mixed-Chain
+
+Placeholder for now
diff --git a/docs/api/trainer/residuum.md b/docs/api/trainer/residuum.md
@@ -0,0 +1,7 @@
+# Residuum
+
+::: trainax.trainer.ResiduumTrainer
+    options:
+        members:
+            - __init__
+            - __call__
diff --git a/docs/api/trainer/supervised.md b/docs/api/trainer/supervised.md
@@ -0,0 +1,7 @@
+# Supervised Trainer
+
+::: trainax.trainer.SupervisedTrainer
+    options:
+        members:
+            - __init__
+            - __call__
diff --git a/docs/api/trajectory_mixing.md b/docs/api/trajectory_mixing.md
@@ -0,0 +1,23 @@
+# Trajectory Mixing
+
+::: trainax.TrajectorySubStacker
+    options:
+        members:
+            - __init__
+            - __call__
+
+---
+
+::: trainax.PermutationMixer
+    options:
+        members:
+            - __init__
+            - __call__
+
+<!-- ---
+
+::: trainax.TrajectoryMixer
+    options:
+        members:
+            - __init__
+            - __call__ -->
diff --git a/docs/background/relation_diverted_chain_and_residuum.md b/docs/background/relation_diverted_chain_and_residuum.md
@@ -0,0 +1,3 @@
+# On the relation between diverted chain and residuum
+
+TODO
diff --git a/docs/examples/FOU_one_step_learning_is_convex.ipynb b/docs/examples/FOU_one_step_learning_is_convex.ipynb
diff --git a/docs/examples/configuration_showcase.ipynb b/docs/examples/configuration_showcase.ipynb
diff --git a/docs/examples/using_callbacks.ipynb b/docs/examples/using_callbacks.ipynb
@@ -0,0 +1,25 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Placeholder for now"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}
diff --git a/docs/imgs/sample_two_step_supervised.svg b/docs/imgs/sample_two_step_supervised.svg
diff --git a/docs/imgs/syringe-solid.png b/docs/imgs/syringe-solid.png
diff --git a/docs/imgs/trainax_logo.png b/docs/imgs/trainax_logo.png
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/javascripts/mathjax.js b/docs/javascripts/mathjax.js
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/mkdocs.yml b/mkdocs.yml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Sample Data`
	`2`	`+`
	`3`	`+::: trainax.sample_data.advection_1d_periodic`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Mixed-Chain`
	`2`	`+`
	`3`	`+Placeholder for now`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# On the relation between diverted chain and residuum`
	`2`	`+`
	`3`	`+TODO`