From c0ebb5d22d880e93f5aaed5554a28ef2cb14ecd3 Mon Sep 17 00:00:00 2001 From: Vassilis Vassiliadis Date: Tue, 25 Jun 2024 15:25:56 +0100 Subject: [PATCH] docs: how to install optional dependency groups Signed-off-by: Vassilis Vassiliadis --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 952b8e75e..49ce34aed 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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). +
Linting