[DOC] Add changelog, limitations, and fill in tutorial links on RTD (#50

)

README.md

@@ -26,7 +26,9 @@ The main feature is a `torch.optim.Optimizer` which works like most PyTorch opti
   data-parallel](https://pytorch.org/tutorials/intermediate/ddp_tutorial.html)
   (DDP) training[^1]
 
-The pre-conditioner matrices support different structures that allow to reduce cost ([overview](TODO Insert link to example)).
+The pre-conditioner matrices support different structures that allow to reduce
+cost
+([overview](https://singd.readthedocs.io/en/latest/generated/gallery/example_05_structures/)).
 
 ## Installation
 
@@ -42,10 +44,21 @@ The pre-conditioner matrices support different structures that allow to reduce c
 
 ## Usage
 
- - [Basic example](TODO Insert link to example)
- - Examples for [supported features](TODO Insert link to gallery)
- - [Advanced example](TODO Insert link to example)
- - [Supported structures](TODO Insert link to example)
+ - [Basic
+   example](https://singd.readthedocs.io/en/latest/generated/gallery/example_01_basic/)
+ - Examples for [supported
+   features](https://singd.readthedocs.io/en/latest/generated/gallery/)
+ - [Advanced
+   example](https://singd.readthedocs.io/en/latest/generated/gallery/example_04_advanced/)
+ - [Supported
+   structures](https://singd.readthedocs.io/en/latest/generated/gallery/example_05_structures/)
+
+## Limitations
+
+- `SINGD` does not support graph neural networks (GNN)
+
+- The code has stabilized only recently. Expect things to break and help us
+  improve by filing issues.
 
 ## Citation
 

changelog

@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+### Changed
+
+### Deprecated
+
+### Fixed
+
+## [0.0.1] - 2023-10-31
+
+Initial release
+
+[unreleased]: https://github.com/f-dangel/singd/compare/v0.0.1...HEAD
+[0.0.1]: https://github.com/f-dangel/singd/releases/tag/v0.0.1

docs/examples/example_05_structures.py

@@ -28,8 +28,9 @@
 # $\mathbf{m}_\mathbf{K}$, while the second entry specifies the structure of
 # $\mathbf{C}$ and its momentum $\mathbf{m}_\mathbf{C}$ (see the [paper](TODO
 # Insert link to arXiv submission) for details). It is even possible to specify
-# structures on a per-layer basis (see [this](TODO Insert link to param groups
-# example) example).
+# structures on a per-layer basis (see
+# [this](https://singd.readthedocs.io/en/latest/generated/gallery/example_03_param_groups/)
+# example).
 #
 # The following structures are available: