diff --git a/README.md b/README.md index 5393fac..34e96cd 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,10 @@ ReZero trains a small language model to develop effective search behaviors inste ## Quick Demo 🚀 +
+ ReZero Demo +
+ Run the interactive web interface to see ReZero in action: ```bash @@ -22,12 +26,24 @@ This will launch a Gradio interface where you can interact with the model and te ## Setup 🛠️ -Clone and install: - ```bash +# Clone the repository git clone https://github.com/menloresearch/ReZero cd ReZero + +# Create virtual environment +python -m venv .venv + +# Activate the environment +source .venv/bin/activate + +# Install dependencies +pip install --upgrade pip pip install -e . + +# Set up environment variables (required for websearch demo) +cp .env.example .env +# Edit .env and add your Tavily API key if you want to use the websearch demo ``` ## Data and Training 🧠 @@ -38,6 +54,12 @@ All necessary training data is included in the `data/` folder. To train: python train_grpo.py ``` +If you want to regenerate the data, please run: + +```bash +python scripts/generate_data.py +``` + ## Models 🤖 You can find our models on Hugging Face 🤗! We're committed to open-source and easy access for the research community. diff --git a/assets/demo.gif b/assets/demo.gif new file mode 100644 index 0000000..f2646c2 Binary files /dev/null and b/assets/demo.gif differ