Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

installation + run instructions #65

Merged
merged 2 commits into from
Jan 30, 2024
Merged

installation + run instructions #65

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1a3acd
installation + run instructions
AndreSlavescu Jan 29, 2024
3488861
zephyr example
AndreSlavescu Jan 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion README.md
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Zephyr scores better so just point to that instead :)

Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,28 @@ current_version = 0.2.3

## 📟 Instructions

More instructions to be added soon!
### Create Conda Environment

```bash
conda create -n rankllm python=3.10
conda activate rankllm
```

### Install Pytorch with CUDA
```bash
pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu118
```

### Install Dependencies
```bash
pip install -r requirements.txt
```

### Run end to end Test
```bash
python src/rank_llm/scripts/run_rank_llm.py --model_path=castorini/rank_vicuna_7b_v1 --top_k_candidates=100 --dataset=dl20 \
--retrieval_method=SPLADE++_EnsembleDistil_ONNX --prompt_mode=rank_GPT --context_size=4096 --variable_passages
```

## 🦙🐧 Model Zoo

Expand Down