diff --git a/README.md b/README.md index e27a87f..3dc748c 100644 --- a/README.md +++ b/README.md @@ -8,15 +8,25 @@ **The simplest way to train and run adapters on top of foundation models** -[**Manifesto**](https://refine.rs/home/why/) | [**Docs**](https://refine.rs) | [**Guides**](https://refine.rs/guides/adapting_sdxl/) | [**Discussions**](https://github.com/finegrain-ai/refiners/discussions) | [**Discord**](https://discord.gg/mCmjNUVV7d) +[**Manifesto**](https://refine.rs/home/why/) | +[**Docs**](https://refine.rs) | +[**Guides**](https://refine.rs/guides/adapting_sdxl/) | +[**Discussions**](https://github.com/finegrain-ai/refiners/discussions) | +[**Discord**](https://discord.gg/mCmjNUVV7d) ______________________________________________________________________ +[![dependencies - Rye](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/rye/main/artwork/badge.json)](https://github.com/astral-sh/rye) +[![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) +[![packaging - Hatch](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/refiners)](https://pypi.org/project/refiners/) -[![PyPI Status](https://badge.fury.io/py/refiners.svg)](https://badge.fury.io/py/refiners) -[![license](https://img.shields.io/badge/license-MIT-blue)](/LICENSE) +[![PyPI - Status](https://badge.fury.io/py/refiners.svg)](https://pypi.org/project/refiners/) +[![license](https://img.shields.io/badge/license-MIT-blue)](/LICENSE) \ [![code bounties](https://img.shields.io/badge/code-bounties-blue)](https://finegrain.ai/bounties) -[![chat](https://img.shields.io/discord/1179456777406922913?logo=discord&logoColor=white&color=%235765F2)](https://discord.gg/mCmjNUVV7d) +[![Discord](https://img.shields.io/discord/1179456777406922913?logo=discord&logoColor=white&color=%235765F2)](https://discord.gg/mCmjNUVV7d) +[![HuggingFace - Refiners](https://img.shields.io/badge/refiners-ffd21e?logo=huggingface&labelColor=555)](https://huggingface.co/refiners) +[![HuggingFace - Finegrain](https://img.shields.io/badge/finegrain-ffd21e?logo=huggingface&labelColor=555)](https://huggingface.co/finegrain) + ## Latest News 🔥 diff --git a/docs/index.md b/docs/index.md index 59d5bf9..955e19f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,19 +3,26 @@ title: A PyTorch microframework for foundation model adaptation icon: material/water-outline --- -
- +![Refiners logo](/assets/logo_light.png){: style="display: block; margin-left: auto; margin-right: auto; width: 400px;"} -- The simplest way to train and run adapters on top of foundation models. -
- - - - - -- At the era of foundation models, adaptation is quickly rising at the method of choice for bridging the last mile quality gap. We couldn't find a framework with first class citizen APIs for foundation model adaptation, so we created one. It's called Refiners, and we're building it on top of PyTorch, in the open, under the MIT License. Read our manifesto. -
-