From 952b71e55a37097b67976cfa371b038a75aa830d Mon Sep 17 00:00:00 2001
From: ArvinZhuang <shengyaozhuang@gmail.com>
Date: Thu, 17 Oct 2024 14:13:36 +1000
Subject: [PATCH] update instruction

---
 README.md           | 22 ++++++++++++++++++++++
 retrieval/README.md |  2 --
 sts/README.md       |  2 --
 3 files changed, 22 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 834e5be..a210098 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,23 @@
 # Starbucks
+Starbucks: Improved Training for 2D Matryoshka Embeddings
+
+### General guidelines
+Our codebase is built on top of torch and transformers.
+
+We recommend using a conda environment to install the required dependencies.
+To install the required dependencies:
+
+```bash
+conda create -n starbucks python=3.10
+conda activate starbucks
+
+pip install torch
+pip install transformers datasets peft
+pip install deepspeed accelerate
+```
+
+For SMAE pre-training, see [smae](smae/README.md).
+
+For SRL fine-tuning on retrieval task, see [retrieval](retrieval/README.md).
+
+For SRL fine-tuning on STS task, see [sts](sts/README.md).
\ No newline at end of file
diff --git a/retrieval/README.md b/retrieval/README.md
index 6be0199..5fa6676 100644
--- a/retrieval/README.md
+++ b/retrieval/README.md
@@ -5,8 +5,6 @@ Our training code for passage retrieval is based on [Tevatron](https://github.co
 
 To install Tevatron:
 ```bash
-pip install transformers datasets peft
-pip install deepspeed accelerate
 pip install faiss-cpu # or 'conda install pytorch::faiss-gpu' for faiss gpu search
 pip install wandb # for logging
 git clone https://github.com/texttron/tevatron.git
diff --git a/sts/README.md b/sts/README.md
index 8b94521..ea70ff6 100644
--- a/sts/README.md
+++ b/sts/README.md
@@ -10,8 +10,6 @@ This repo supports for three types of fine-tuning:
 ## Installation
 ```bash
 pip install sentence_transformers
-pip install datasets
-pip install torch
 ```