mirror of
https://github.com/finegrain-ai/refiners.git
synced 2024-11-24 23:28:45 +00:00
document use of Poetry (main branch) instead of pip
This commit is contained in:
parent
0dfdd0d419
commit
eb88cde7ac
18
README.md
18
README.md
|
@ -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
|
||||
|
|
Loading…
Reference in a new issue