Finegrain/refiners
1
0
Fork 0
mirror of https://github.com/finegrain-ai/refiners.git synced 2024-11-21 21:58:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

add more shields.io badges in README.md
Some checks failed
CI / lint_and_typecheck (push) Has been cancelled
Details
Spell checker / Spell check (push) Has been cancelled
Details

Browse source
This commit is contained in:
Laurent 2024-08-23 15:39:09 +00:00 committed by Laureηt
parent 7ca1774b5f
commit 0df5bdd2b6
2 changed files with 36 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -8,15 +8,25 @@
**The simplest way to train and run adapters on top of foundation models** **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 - 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) [![PyPI - Status](https://badge.fury.io/py/refiners.svg)](https://pypi.org/project/refiners/)
[![license](https://img.shields.io/badge/license-MIT-blue)](/LICENSE) [![license](https://img.shields.io/badge/license-MIT-blue)](/LICENSE) \
[![code bounties](https://img.shields.io/badge/code-bounties-blue)](https://finegrain.ai/bounties) [![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)
</div> </div>
## Latest News 🔥 ## Latest News 🔥

37
docs/index.md
View file

@ -3,19 +3,26 @@ title: A PyTorch microframework for foundation model adaptation
icon: material/water-outline icon: material/water-outline
--- ---
<h1 style="margin-bottom: 0;"></h1> ![Refiners logo](/assets/logo_light.png){: style="display: block; margin-left: auto; margin-right: auto; width: 400px;"}
<img src="/assets/logo_light.png" alt="Refiners logo" width="400px" style="display: block; margin-left: auto; margin-right: auto"/>
<div style="text-align: center"> <center>
<p>
<strong>The simplest way to train and run <a href="/concepts/adapter/">adapters</a> on top of foundation models.</strong> **The simplest way to train and run [adapters](/concepts/adapter/) on top of foundation models.**
</p>
<a href="https://pypi.org/project/refiners/"><img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/refiners"></a> [![dependencies - Rye](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/rye/main/artwork/badge.json)](https://rye.astral.sh)
<a href="https://badge.fury.io/py/refiners"><img alt="PyPI Status" src="https://badge.fury.io/py/refiners.svg"></a> [![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)
<a href="https://github.com/finegrain-ai/refiners/blob/main/LICENSE"><img alt="license" src="https://img.shields.io/badge/license-MIT-blue"></a> [![packaging - Hatch](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)
<a href="https://finegrain.ai/bounties"><img alt="code bounties" src="https://img.shields.io/badge/code-bounties-blue"></a> [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/refiners)](https://pypi.org/project/refiners/)
<a href="https://discord.gg/mCmjNUVV7d"><img alt="chat" src="https://img.shields.io/discord/1179456777406922913?logo=discord&amp;logoColor=white&amp;color=%235765F2"></a> [![PyPI - Status](https://badge.fury.io/py/refiners.svg)](https://badge.fury.io/py/refiners)
<p> [![license](https://img.shields.io/badge/license-MIT-blue)](/LICENSE) <br>
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. <a href="/home/why/">Read our manifesto</a>. [![code bounties](https://img.shields.io/badge/code-bounties-blue)](https://finegrain.ai/bounties)
</p> [![Discord](https://img.shields.io/discord/1179456777406922913?logo=discord&logoColor=white&color=%235765F2)](https://discord.gg/mCmjNUVV7d)
</div> [![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)
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](/home/why/).
</center>