From 1af9ed112cafcaa965d2d4b2a04ad9de4b81b035 Mon Sep 17 00:00:00 2001 From: Ibrahim Hadzic Date: Fri, 13 Oct 2023 22:26:31 -0700 Subject: [PATCH] Set md-nav to correct color in slate --- docs/assets/extra.css | 7 +++++-- docs/index.md | 11 +++++------ mkdocs.yml | 3 ++- 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/assets/extra.css b/docs/assets/extra.css index 5cae799..ab8451e 100644 --- a/docs/assets/extra.css +++ b/docs/assets/extra.css @@ -4,11 +4,14 @@ color: #14181e; } - [data-md-color-scheme="slate"] { +[data-md-color-scheme="slate"] { --md-primary-fg-color: #459AA3; --md-accent-fg-color: #459AA3; --md-default-bg-color: #14181e; - } +} +[data-md-color-scheme="slate"] .md-nav { + --md-typeset-a-color: #459AA3; +} @media only screen and (min-width: 75.25em) { .md-main__inner { diff --git a/docs/index.md b/docs/index.md index 2aa3f39..570749f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,6 +11,7 @@ hide:
+
```bash pip install project-lighter @@ -24,21 +25,18 @@ pip install project-lighter Say goodbye to messy scripts and notebooks. Lighter is here to help you organize your experiments and make them reproducible. - -## Demo - -Here is a comparison between a PyTorch Lightning script and its Lighter equivalent. - -Lighter is: +## Features 1. **Structured** - the pre-defined structure ensures that your experiments are standardized, organized, and reproducible. 2. **Boilerplate-free** - forget about writing training logic over and over. `LighterSystem` handles it for you and is compatible with any task, from classification to self-supervised learning. 3. **Readable** - wondering what learning rate or architecture was used? Just glance at the config. 4. **Easily modifiable** - override parameters from CLI or using another config. Leave `argparse` and hardcoding in the past. +## Comparison
+

PyTorch Lightning

```bash title="Terminal" python cifar10.py ``` @@ -99,6 +97,7 @@ Lighter is:
+

Lighter

```bash title="Terminal" lighter fit --config_file cifar10.yaml ``` diff --git a/mkdocs.yml b/mkdocs.yml index ddff8cf..fead1da 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -40,7 +40,8 @@ plugins: - mkdocstrings nav: - - 'index.md' + - Home: + - 'Lighter': 'index.md' - 'Basics': - '5 Minute Example': 'basics/5-minute-example.md' - 'Config': 'basics/config.md'