diff --git a/docs/assets/dropy_logo.png b/docs/assets/dropy_logo.png new file mode 100644 index 000000000..267006aac Binary files /dev/null and b/docs/assets/dropy_logo.png differ diff --git a/docs/assets/favicon.png b/docs/assets/favicon.png new file mode 100644 index 000000000..47cb161c4 Binary files /dev/null and b/docs/assets/favicon.png differ diff --git a/docs/contributing/index.md b/docs/contributing/index.md new file mode 100644 index 000000000..6d3f66599 --- /dev/null +++ b/docs/contributing/index.md @@ -0,0 +1 @@ +WIP \ No newline at end of file diff --git a/docs/adapters.md b/docs/fluxion/adapters.md similarity index 100% rename from docs/adapters.md rename to docs/fluxion/adapters.md diff --git a/docs/fluxion/index.md b/docs/fluxion/index.md new file mode 100644 index 000000000..6d3f66599 --- /dev/null +++ b/docs/fluxion/index.md @@ -0,0 +1 @@ +WIP \ No newline at end of file diff --git a/docs/getting_started.md b/docs/getting_started.md new file mode 100644 index 000000000..a3c32fdae --- /dev/null +++ b/docs/getting_started.md @@ -0,0 +1,43 @@ +# Getting Started + +Refiners is a micro framework on top of PyTorch with first class citizen APIs for foundation model adaptation. + + +## Installation + +Refiners requires Python 3.10 or later, its main dependency is PyTorch. + +### with git + +To get the latest version of the code, clone the repository: + +```bash +git clone https://github.com/finegrain-ai/refiners.git +``` + +Then install the package using pip: + +```bash +cd refiners +pip install . +``` + + +### with pip + +Refiners is available on PyPI and can be installed using pip: + +```bash +pip install refiners +``` + +## Run foundational models and adapters + +If you want to understand how to use Refiners with existing foundational models, please refer to the specific [Models](models/index.md) page. + + - [Stable Diffusion](/models/stable_diffusion) + - [Segment Anything](/models/segment_anything) + +## Write new foundational models and adapters + +To understand how to write new adapters or models with Refiners, please have a look at the [Fluxion](fluxion/index.md) documentation. \ No newline at end of file diff --git a/docs/models/index.md b/docs/models/index.md new file mode 100644 index 000000000..a3714bdda --- /dev/null +++ b/docs/models/index.md @@ -0,0 +1,3 @@ +# Foundational Models + +WIP \ No newline at end of file diff --git a/docs/models/latent_diffusion.md b/docs/models/latent_diffusion.md new file mode 100644 index 000000000..44b49c836 --- /dev/null +++ b/docs/models/latent_diffusion.md @@ -0,0 +1,3 @@ +# Latent Diffusion + +WIP \ No newline at end of file diff --git a/docs/models/segment_anything.md b/docs/models/segment_anything.md new file mode 100644 index 000000000..4b13c5022 --- /dev/null +++ b/docs/models/segment_anything.md @@ -0,0 +1,3 @@ +# Segment Anything + +WIP \ No newline at end of file diff --git a/docs/training_utils/index.md b/docs/training_utils/index.md new file mode 100644 index 000000000..7a911240a --- /dev/null +++ b/docs/training_utils/index.md @@ -0,0 +1,9 @@ +# 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 new file mode 100644 index 000000000..e69de29bb diff --git a/mkdocs.yml b/mkdocs.yml index ced975126..68b095316 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,52 @@ site_name: Refiners - +site_decription: A micro framework on top of PyTorch with first class citizen APIs for foundation model adaptation +repo_name: Refiners +repo_url: https://github.com/finegrain-ai/refiners +edit_uri: edit/main/docs/ +copyright: © Lagon Technologies theme: + favicon: assets/favicon.png name: material + palette: + primary: deep orange + accent: deep orange + features: + - navigation.tabs + - navigation.sections + - navigation.top + - navigation.tracking + - navigation.expand + - navigation.path + - toc.follow + - toc.integrate + - navigation.tabs.sticky +extra_css: + - stylesheets/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 +extra: + social: + - icon: fontawesome/brands/discord + link: https://discord.gg/mCmjNUVV7d + - icon: fontawesome/brands/github + link: https://github.com/finegrain-ai/refiners + - icon: fontawesome/brands/twitter + link: https://twitter.com/finegrain_ai + - icon: fontawesome/brands/linkedin + link: https://www.linkedin.com/company/finegrain-ai/ +markdown_extensions: + - toc: + permalink: true \ No newline at end of file