Skip to content

Commit

Permalink
docs: how to install optional dependency groups
Browse files Browse the repository at this point in the history
Signed-off-by: Vassilis Vassiliadis <[email protected]>
  • Loading branch information
VassilisVassiliadis committed Jun 25, 2024
1 parent cb44402 commit c0ebb5d
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,24 @@ python3 -m venv venv
poetry install --with dev
```


> Note: After installing, if you wish to use [FlashAttention](https://github.com/Dao-AILab/flash-attention), then you need to install these requirements:
```
poetry install --with dev,flash-attn
```

If you wish to use [aim](https://github.com/aimhubio/aim), then you need to install it:
```
poetry install --with aim
```

If you wish to use [fms-acceleration](https://github.com/foundation-model-stack/fms-acceleration), you need to install it.
```
poetry install --with fms-accel
```
`fms-acceleration` is a collection of plugins that packages that accelerate fine-tuning / training of large models, as part of the `fms-hf-tuning` suite. For more details on see [this section below](#fms-acceleration).

<details>
<summary>Linting</summary>

Expand Down

0 comments on commit c0ebb5d

Please sign in to comment.