Skip to content

Commit

Permalink
beef up readme
Browse files Browse the repository at this point in the history
  • Loading branch information
heyjustinai committed Jan 16, 2025
1 parent 62b5367 commit 5730a84
Showing 1 changed file with 37 additions and 4 deletions.
41 changes: 37 additions & 4 deletions end-to-end-use-cases/prompt-migration/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,41 @@
# prompt-migrator
# Prompt Migration

First, install Rye: https://rye.astral.sh/guide/installation/
## Overview

The prompt migration toolkit helps you assess and adapt prompts across different language models, ensuring consistent performance and reliability. It includes benchmarking capabilities and evaluation tools to measure the effectiveness of prompt migrations.

## Project Structure

- `notebooks/`: Contains Jupyter notebooks for interactive prompt migration examples
- `harness.ipynb`: Main notebook demonstrating the prompt migration workflow
- `benchmarks/`: Tools and scripts for performance evaluation
- `environment.yml`: Conda environment specification with all required dependencies

## Setup Instructions

1. Install dependencies using Conda:
```bash
conda env create -f environment.yml
conda activate prompt-migration
```
rye sync
. .venv/bin/activate

## Key Dependencies

- Python 3.10
- DSPy: For prompt engineering and evaluation
- LM-eval: Evaluation framework for language models
- PyTorch and Transformers: For model inference

## Getting Started

1. Activate your environment using Conda as described above
2. Start Jupyter notebook server:
```bash
jupyter notebook
```
3. Navigate to the `notebooks/harness.ipynb` notebook in your browser
4. Use the benchmarking tools in the `benchmarks/` directory to evaluate your migrations

## License

This project is part of the Llama Recipes collection. Please refer to the main repository's license for usage terms.

0 comments on commit 5730a84

Please sign in to comment.