Documentation facelift

.github/workflows/deploy-mkdocs.yml

@@ -0,0 +1,29 @@
+name: ci
+on:
+  push:
+    branches:
+      - master
+      - 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
+      - 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

README.md

@@ -450,28 +450,25 @@ For example, currently the [`curvature.CurvlinopsInterface`](https://github.com/
 
 ## Documentation
 
-The documentation is available [here](https://aleximmer.github.io/Laplace) or can be generated and/or viewed locally:
+The documentation is available [here](https://aleximmer.github.io/Laplace) or can be 
+generated and/or viewed locally:
 
 **With `uv`**
 
 ```bash
 # assuming the repository was cloned
 uv sync --all-extras
-# create docs and write to html
-uv run bash update_docs.sh
-# .. or serve the docs directly
-uv run pdoc --http 0.0.0.0:8080 laplace --template-dir template
+# serve the docs on a liveserver
+uv run mkdocs serve
 ```
 
 **With `pip`**
 
 ```bash
 # assuming the repository was cloned
 pip install -e ".[dev]"
-# create docs and write to html
-bash update_docs.sh
-# .. or serve the docs directly
-pdoc --http 0.0.0.0:8080 laplace --template-dir template
+# serve the docs on a liveserver
+mkdocs serve
 ```
 
 ## Contributing
@@ -481,7 +478,9 @@ Pull requests are very welcome. Please follow these guidelines:
 1. Follow the [development setup](#setup-dev-environment).
 2. Use [ruff](https://github.com/astral-sh/ruff) as autoformatter. Please refer to the following [makefile](https://github.com/aleximmer/Laplace/blob/main/makefile) and run it via `make ruff`. Please note that the order of `ruff check --fix` and `ruff format` is important!
 3. Also use [ruff](https://github.com/astral-sh/ruff) as linter. Please manually fix all linting errors/warnings before opening a pull request.
-4. Fully document your changes in the form of Python docstrings, typehinting, and (if applicable) code/markdown examples in the `./examples` subdirectory.
+4. Fully document your changes in the form of Python docstrings, typehinting.
+5. Add tutorial-style documentation in both `docs/` (in the form of markdown files) 
+    and `examples/` (in the form of runnable scripts) dirs.
 5. Provide as many test cases as possible. Make sure all test cases pass.
 
 Issues, bug reports, and ideas are also very welcome!

docs/api_reference/baselaplace.md

@@ -0,0 +1,4 @@
+::: laplace.baselaplace
+    options:
+        members:
+            - BaseLaplace

docs/api_reference/curvatures.md

@@ -0,0 +1,17 @@
+::: laplace.curvature
+    options:
+        members:
+            - CurvatureInterface
+            - GGNInterface
+            - EFInterface
+            - AsdlInterface
+            - AsdlGGN
+            - AsdlEF
+            - AsdlHessian
+            - BackPackInterface
+            - BackPackGGN
+            - BackPackEF
+            - CurvlinopsInterface
+            - CurvlinopsGGN
+            - CurvlinopsEF
+            - CurvlinopsHessian

docs/api_reference/enums.md

@@ -0,0 +1 @@
+::: laplace.utils.enums

docs/api_reference/functionallaplace.md

@@ -0,0 +1,4 @@
+::: laplace.baselaplace
+    options:
+        members:
+            - FunctionalLaplace

docs/api_reference/laplace.md

@@ -0,0 +1,4 @@
+::: laplace.laplace
+    options:
+        members:
+            - Laplace

docs/api_reference/lllaplace.md

@@ -0,0 +1,7 @@
+::: laplace.lllaplace
+    options:
+        members:
+            - LLLaplace
+            - DiagLLLaplace
+            - KronLLLaplace
+            - FullLLLaplace

docs/api_reference/marglik_training.md

@@ -0,0 +1,4 @@
+::: laplace.marglik_training
+    options:
+        members:
+            - marglik_training

docs/api_reference/parametriclaplace.md

@@ -0,0 +1,8 @@
+::: laplace.baselaplace
+    options:
+        members:
+            - ParametricLaplace
+            - DiagLaplace
+            - KronLaplace
+            - LowRankLaplace
+            - FullLaplace

docs/api_reference/subnetlaplace.md

@@ -0,0 +1,6 @@
+::: laplace.subnetlaplace
+    options:
+        members:
+            - SubnetLaplace
+            - DiagSubnetLaplace
+            - FullSubnetLaplace

docs/api_reference/utils.md

@@ -0,0 +1,30 @@
+::: laplace.utils
+    options:
+        members: 
+            - "get_nll"
+            - "validate"
+            - "parameters_per_layer"
+            - "invsqrt_precision"
+            - "kron"
+            - "diagonal_add_scalar"
+            - "symeig"
+            - "block_diag"
+            - "normal_samples"
+            - "SoDSampler"
+            - "_is_batchnorm"
+            - "_is_valid_scalar"
+            - "expand_prior_precision"
+            - "fix_prior_prec_structure"
+            - "FeatureExtractor"
+            - "Kron"
+            - "KronDecomposed"
+            - "fit_diagonal_swag_var"
+            - "SubnetMask"
+            - "RandomSubnetMask"
+            - "LargestMagnitudeSubnetMask"
+            - "LargestVarianceDiagLaplaceSubnetMask"
+            - "LargestVarianceSWAGSubnetMask"
+            - "ParamNameSubnetMask"
+            - "ModuleNameSubnetMask"
+            - "LastLayerSubnetMask"
+            - "RunningNLLMetric"