Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Ssukriti authored Jul 3, 2024
1 parent fcba45f commit 5d58ab4
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ This repo provides basic tuning scripts with support for specific models. The re

## Installation

### 1. Install from wheel
```
pip install fms-hf-tuning
```
Expand All @@ -29,6 +30,12 @@ pip install git+https://github.com/foundation-model-stack/fms-acceleration.git#s
```
`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 below](#fms-acceleration).

### 2. Build from source

We have committed a `poetry.lock` file to allow reproducible enviornments. If building from source, you can clone the repository and use poetry to install as mentioned in [development docs](/CONTRIBUTING.md#development)

If building in a dockerfile use `poetry export --format requirements.txt` can install same dependencies from the lock file. Maintainers regularly update the lock file.

## Data format
We support two data formats:

Expand Down

0 comments on commit 5d58ab4

Please sign in to comment.