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

document use of Poetry (main branch) instead of pip

Browse source
This commit is contained in:
Pierre Chapuis 2023-09-13 15:17:22 +02:00
parent 0dfdd0d419
commit eb88cde7ac
1 changed files with 13 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -192,16 +192,24 @@ for layer in vit.layers(fl.Attention):
### Install
Refiners is still an early stage project so we recommend using the `main` branch directly with [Poetry](https://python-poetry.org).
If you just want to use Refiners directly, clone the repository and run:
```bash
# inference only
pip install refiners
poetry install --all-extras
```
Or:
There is currently [a bug with PyTorch 2.0.1 and Poetry](https://github.com/pytorch/pytorch/issues/100974), to work around it run:
```bash
# inference + training
pip install 'refiners[training]'
poetry run pip install --upgrade torch torchvision
```
If you want to depend on Refiners in your project which uses Poetry, you can do so:
```bash
poetry add git+ssh://git@github.com:finegrain-ai/refiners.git#main
```
### Hello World