diff --git a/docs/fluxion/adapters.md b/docs/concepts/adapters.md similarity index 100% rename from docs/fluxion/adapters.md rename to docs/concepts/adapters.md diff --git a/docs/concepts/index.md b/docs/concepts/index.md new file mode 100644 index 0000000..85e6ff1 --- /dev/null +++ b/docs/concepts/index.md @@ -0,0 +1 @@ +# WIP diff --git a/docs/contributing/index.md b/docs/contributing/index.md deleted file mode 100644 index 6d3f665..0000000 --- a/docs/contributing/index.md +++ /dev/null @@ -1 +0,0 @@ -WIP \ No newline at end of file diff --git a/docs/fluxion/index.md b/docs/fluxion/index.md deleted file mode 100644 index 6d3f665..0000000 --- a/docs/fluxion/index.md +++ /dev/null @@ -1 +0,0 @@ -WIP \ No newline at end of file diff --git a/docs/guides/index.md b/docs/guides/index.md new file mode 100644 index 0000000..85e6ff1 --- /dev/null +++ b/docs/guides/index.md @@ -0,0 +1 @@ +# WIP diff --git a/docs/models/index.md b/docs/models/index.md deleted file mode 100644 index a3714bd..0000000 --- a/docs/models/index.md +++ /dev/null @@ -1,3 +0,0 @@ -# Foundational Models - -WIP \ No newline at end of file diff --git a/docs/models/latent_diffusion.md b/docs/models/latent_diffusion.md deleted file mode 100644 index 44b49c8..0000000 --- a/docs/models/latent_diffusion.md +++ /dev/null @@ -1,3 +0,0 @@ -# Latent Diffusion - -WIP \ No newline at end of file diff --git a/docs/models/segment_anything.md b/docs/models/segment_anything.md deleted file mode 100644 index 4b13c50..0000000 --- a/docs/models/segment_anything.md +++ /dev/null @@ -1,3 +0,0 @@ -# Segment Anything - -WIP \ No newline at end of file diff --git a/docs/training_utils/index.md b/docs/training_utils/index.md deleted file mode 100644 index 7a91124..0000000 --- a/docs/training_utils/index.md +++ /dev/null @@ -1,9 +0,0 @@ -# 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 - -WIP - diff --git a/docs/training_utils/trainer.md b/docs/training_utils/trainer.md deleted file mode 100644 index e69de29..0000000 diff --git a/mkdocs.yml b/mkdocs.yml index 46513f3..f3dcee8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -31,18 +31,15 @@ extra_css: nav: - Home: - index.md - - Getting started: getting_started.md - - Models: - - models/index.md - - models/latent_diffusion.md - - models/segment_anything.md - - Fluxion: - - fluxion/index.md - - fluxion/adapters.md - - Training utils: - - training_utils/index.md - - Contributing: - - contributing/index.md + - Getting started: + - getting_started.md + - Guides: + - guides/index.md + - Key Concepts: + - concepts/index.md + - concepts/adapters.md + - API Reference: + - index.md extra: social: - icon: fontawesome/brands/discord @@ -71,4 +68,4 @@ markdown_extensions: emoji_index: !!python/name:material.extensions.emoji.twemoji emoji_generator: !!python/name:material.extensions.emoji.to_svg - toc: - permalink: true \ No newline at end of file + permalink: true