add Refiners theme and basic nav to documentation

This commit is contained in:
limiteinductive 2024-01-08 18:35:18 +01:00 committed by Benjamin Trom
parent 60981b79a6
commit da3ed8690a
11 changed files with 95 additions and 2 deletions

View file

@ -0,0 +1 @@
# Contributing

BIN
docs/assets/dropy_logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

1
docs/fluxion/index.md Normal file
View file

@ -0,0 +1 @@
# Fluxion

43
docs/getting_started.md Normal file
View file

@ -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.

1
docs/models/index.md Normal file
View file

@ -0,0 +1 @@
# Foundational Models

View file

View file

View file

@ -0,0 +1 @@
# Training Utils

View file

@ -1,4 +1,50 @@
site_name: Refiners site_name: "Refiners Documentation"
theme: theme:
favicon: assets/dropy_logo.png
name: material 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:
- home/index.md
- home/adapters.md
- Getting started: getting_started.md
- Models:
- models/index.md
- models/stable_diffusion.md
- models/segment_anything.md
- Fluxion:
- fluxion/index.md
- Training utils:
- training_utils/index.md
- Contributing:
- contributing/index.md
repo_name: Refiners
repo_url: https://github.com/finegrain-ai/refiners
copyright: © 2023 Lagon Technologies
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