refiners/README.md
Cédric Deltheil 428c2ddcec
Some checks are pending
CI / lint_and_typecheck (push) Waiting to run
Deploy docs to GitHub Pages / Deploy docs (push) Waiting to run
Spell checker / Spell check (push) Waiting to run
ella: refresh README and mkdocs
Follow up of #389
2024-09-04 14:03:12 +02:00

6.8 KiB

Finegrain Refiners Library

The simplest way to train and run adapters on top of foundation models

Manifesto | Docs | Guides | Discussions | Discord


dependencies - Rye linting - Ruff packaging - Hatch PyPI - Python Version PyPI - Status license
code bounties Discord HuggingFace - Refiners HuggingFace - Finegrain

Latest News 🔥

Installation

The current recommended way to install Refiners is from source using Rye:

git clone "git@github.com:finegrain-ai/refiners.git"
cd refiners
rye sync --all-features

Documentation

Refiners comes with a MkDocs-based documentation website available at https://refine.rs. You will find there a quick start guide, a description of the key concepts, as well as in-depth foundation model adaptation guides.

Awesome Adaptation Papers

If you're interested in understanding the diversity of use cases for foundation model adaptation (potentially beyond the specific adapters supported by Refiners), we suggest you take a look at these outstanding papers:

Projects using Refiners

Credits

We took inspiration from these great projects:

Citation

@misc{the-finegrain-team-2023-refiners,
  author = {Benjamin Trom and Pierre Chapuis and Cédric Deltheil},
  title = {Refiners: The simplest way to train and run adapters on top of foundation models},
  year = {2023},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/finegrain-ai/refiners}}
}