Skip to content

Commit

Permalink
chore: remove fms-accel extra group
Browse files Browse the repository at this point in the history
Signed-off-by: Vassilis Vassiliadis <[email protected]>
  • Loading branch information
VassilisVassiliadis committed Jul 2, 2024
1 parent 4a3316e commit ca9ab4e
Show file tree
Hide file tree
Showing 4 changed files with 396 additions and 375 deletions.
6 changes: 1 addition & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,11 +119,7 @@ If you wish to use [aim](https://github.com/aimhubio/aim), then you need to inst
poetry install --extras aim
```

If you wish to use [fms-acceleration](https://github.com/foundation-model-stack/fms-acceleration), you need to install it.
```
poetry install --extras 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 see [this section in README.md](README.md#fms-acceleration).
If you wish to use [fms-acceleration](https://github.com/foundation-model-stack/fms-acceleration) follow the instructions in [this section of README.md](README.md#fms-acceleration).

<details>
<summary>Linting</summary>
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,7 @@ Equally you can pass in a JSON configuration for running tuning. See [build doc]

### FMS Acceleration

`fms-acceleration` is fuss-free approach to access a curated collection of acceleration plugins that acclerate your `tuning/sft-trainer.py` experience. Accelerations that apply to a variety of use-cases, e.g., PeFT / full-finetuning, are being planned for. As such, the accelerations are grouped into *plugins*; only install the plugins needed for the acceleration of interest. The plugins are housed in the [seperate repository found here](https://github.com/foundation-model-stack/fms-acceleration).
`fms-acceleration` is fuss-free approach to access a curated collection of acceleration plugins that accelerate your `tuning/sft-trainer.py` experience. Accelerations that apply to a variety of use-cases, e.g., PeFT / full-finetuning, are being planned for. As such, the accelerations are grouped into *plugins*; only install the plugins needed for the acceleration of interest. The plugins are housed in the [separate repository found here](https://github.com/foundation-model-stack/fms-acceleration).

To access `fms-acceleration` features the `[fms-accel]` dependency must first be installed:
```
Expand Down
Loading

0 comments on commit ca9ab4e

Please sign in to comment.