mirror of
https://github.com/finegrain-ai/refiners.git
synced 2024-11-13 00:28:14 +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
|
### 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
|
```bash
|
||||||
# inference only
|
poetry install --all-extras
|
||||||
pip install refiners
|
|
||||||
```
|
```
|
||||||
|
|
||||||
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
|
```bash
|
||||||
# inference + training
|
poetry run pip install --upgrade torch torchvision
|
||||||
pip install 'refiners[training]'
|
```
|
||||||
|
|
||||||
|
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
|
### Hello World
|
||||||
|
|
Loading…
Reference in a new issue