Skip to content

Commit 6a42f01

Browse files
committed
simplify the uv installation and add an optional bitsandbytes install for gpu deployment
1 parent 68fe308 commit 6a42f01

File tree

2 files changed

+14
-19
lines changed

2 files changed

+14
-19
lines changed

README.md

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,12 @@ WRAVAL helps in evaluating LLMs for writing assistant tasks like summarization,
44

55
## Quick start
66

7-
> Disclaimer: the deploy action requires a machine that supports bitsandbytes and CUDA.
8-
9-
Before installing, execute the following to ensure correct dependencies:
10-
117
```bash
12-
pip install uv
13-
uv pip compile pyproject.toml -o requirements.txt
14-
```
15-
16-
```bash
17-
pip install -e .
8+
uv pip install .
189
wraval generate
1910
```
2011

21-
## Install with uv
22-
23-
```bash
24-
uv venv
25-
source .venv/bin/activate
26-
uv pip install -e .
27-
wraval generate
28-
```
12+
> Disclaimer: the deploy action requires a machine that supports bitsandbytes and CUDA. See below.
2913
3014
## Step by step
3115

@@ -63,6 +47,15 @@ wraval human_judge
6347

6448
> Note: ideally different models are used for each step, to avoid bias.
6549
50+
### 5. Deploy a Sagemaker Endpoint to be used by the steps above.
51+
52+
> Use a machine with CUDA support
53+
54+
```bash
55+
uv pip install ".[gpu]"
56+
wraval deploy -m ...
57+
```
58+
6659
An additional notebook is provided to benchmark models on translation tasks on open datasets [here](Haiku_translate.ipynb).
6760

6861
## Motivation

pyproject.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,16 @@ dependencies = [
2727
"sagemaker==2.244.2",
2828
"numpy",
2929
"requests",
30-
"bitsandbytes==0.45.5",
3130
"accelerate",
3231
"torchvision"
3332
]
3433

3534
[project.scripts]
3635
wraval = "wraval.main:main"
3736

37+
[project.optional-dependencies]
38+
gpu = ["bitsandbytes==0.45.5"]
39+
3840
[tool.setuptools]
3941
package-dir = {"" = "src"}
4042
include-package-data = true

0 commit comments

Comments
 (0)