fix navigation

2024-11-21 21:58:47 +00:00 · 2024-01-09 11:52:02 +01:00 · 2024-01-09 11:52:02 +01:00 · cce5d2b31e
parent a6f231a00f
commit cce5d2b31e
5 changed files with 8 additions and 2 deletions
--- a/docs/contributing/index.md
+++ b/docs/contributing/index.md
--- a/docs/home/index.md
+++ b/docs/home/index.md
--- a/docs/training_utils/index.md
+++ b/docs/training_utils/index.md
@ -1 +1,7 @@
-# Training Utils
+# Training Utils
+
+Very minimalistic training utilities for PyTorch, its main purpose is to provide a simple way to abstract the training loop
+and its configuration. It is meant to be used with Refiners, but it can be used with any PyTorch model.
+
+## Quickstart
+
--- a/docs/training_utils/trainer.md
+++ b/docs/training_utils/trainer.md
--- a/mkdocs.yml
+++ b/mkdocs.yml
@ -24,7 +24,7 @@ extra_css:
  - stylesheets/extra.css
 nav:
  - Home: 
-    - home/index.md
+    - index.md
    - home/adapters.md
  - Getting started: getting_started.md
  - Models: