Skip to content

Commit e13cac9

Browse files
authored
Merge pull request #44 from meta-llama/name-migration
Name migration
2 parents 8bf5d70 + e2241e9 commit e13cac9

45 files changed

Lines changed: 88 additions & 2282 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
name: 🐛 Bug Report
2-
description: Report a bug to help us improve llama-prompt-ops
2+
description: Report a bug to help us improve prompt-ops
33
labels: ["bug"]
44
body:
55
- type: markdown
66
attributes:
77
value: >
8-
Thanks for taking the time to report a bug! Please search [existing issues](https://github.com/justinai/llama-prompt-ops/issues) first to avoid duplicates.
8+
Thanks for taking the time to report a bug! Please search [existing issues](https://github.com/meta-llama/prompt-ops/issues) first to avoid duplicates.
99
1010
- type: textarea
1111
id: bug-description
@@ -26,7 +26,7 @@ body:
2626
label: How to reproduce
2727
description: Steps to reproduce the issue, including any commands or code.
2828
placeholder: |
29-
1. Run `llama-prompt-ops optimize --config configs/facility.yaml`
29+
1. Run `prompt-ops optimize --config configs/facility.yaml`
3030
2. See error...
3131
3232
```bash
@@ -42,7 +42,7 @@ body:
4242
description: Your Python version and any relevant system info.
4343
placeholder: |
4444
- Python version: 3.9.0
45-
- llama-prompt-ops version: 0.0.8
45+
- prompt-ops version: 0.0.8
4646
- OS: macOS 14.0
4747
validations:
4848
required: false

.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: 🚀 Feature Request
2-
description: Suggest a new feature for llama-prompt-ops
2+
description: Suggest a new feature for prompt-ops
33
labels: ["enhancement"]
44
body:
55
- type: textarea

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to llama-prompt-ops
1+
# Contributing to prompt-ops
22
We want to make contributing to this project as easy and transparent as
33
possible.
44

@@ -23,4 +23,4 @@ We use GitHub issues to track public bugs. Please ensure your description is cle
2323
Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue.
2424

2525
## License
26-
By contributing to llama-prompt-ops, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.
26+
By contributing to prompt-ops, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.

MANIFEST.in

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
recursive-include src/llama_prompt_ops *.py
2-
recursive-include src/llama_prompt_ops/interfaces *.py
3-
recursive-include src/llama_prompt_ops/core *.py
4-
recursive-include src/llama_prompt_ops/templates *
1+
recursive-include src/prompt_ops *.py
2+
recursive-include src/prompt_ops/interfaces *.py
3+
recursive-include src/prompt_ops/core *.py
4+
recursive-include src/prompt_ops/templates *

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
1-
<h1 align="center"> Llama Prompt Ops </h1>
1+
<h1 align="center"> Prompt Ops </h1>
22

3-
## What is llama-prompt-ops?
3+
## What is prompt-ops?
44
<p align="center">
5-
<a href="https://pypi.org/project/llama-prompt-ops/"><img src="https://img.shields.io/pypi/v/llama-prompt-ops.svg" /></a>
5+
<a href="https://pypi.org/project/prompt-ops/"><img src="https://img.shields.io/pypi/v/prompt-ops.svg" /></a>
66
</p>
77
<p align="center">
8-
<a href="https://llama.developer.meta.com/?utm_source=llama-prompt-ops&utm_medium=readme&utm_campaign=main"><img src="https://img.shields.io/badge/Llama_API-Join_Waitlist-brightgreen?logo=meta" /></a>
9-
<a href="https://llama.developer.meta.com/docs?utm_source=llama-prompt-ops&utm_medium=readme&utm_campaign=main"><img src="https://img.shields.io/badge/Llama_API-Documentation-4BA9FE?logo=meta" /></a>
8+
<a href="https://llama.developer.meta.com/?utm_source=prompt-ops&utm_medium=readme&utm_campaign=main"><img src="https://img.shields.io/badge/Llama_API-Join_Waitlist-brightgreen?logo=meta" /></a>
9+
<a href="https://llama.developer.meta.com/docs?utm_source=prompt-ops&utm_medium=readme&utm_campaign=main"><img src="https://img.shields.io/badge/Llama_API-Documentation-4BA9FE?logo=meta" /></a>
1010

1111
</p>
1212

1313
<p align="center">
14-
<a href="https://github.com/meta-llama/llama-models/blob/main/models/?utm_source=llama-prompt-ops&utm_medium=readme&utm_campaign=main"><img alt="Llama Model cards" src="https://img.shields.io/badge/Llama_OSS-Model_cards-green?logo=meta" /></a>
15-
<a href="https://www.llama.com/docs/overview/?utm_source=llama-prompt-ops&utm_medium=readme&utm_campaign=main"><img alt="Llama Documentation" src="https://img.shields.io/badge/Llama_OSS-Documentation-4BA9FE?logo=meta" /></a>
14+
<a href="https://github.com/meta-llama/llama-models/blob/main/models/?utm_source=prompt-ops&utm_medium=readme&utm_campaign=main"><img alt="Llama Model cards" src="https://img.shields.io/badge/Llama_OSS-Model_cards-green?logo=meta" /></a>
15+
<a href="https://www.llama.com/docs/overview/?utm_source=prompt-ops&utm_medium=readme&utm_campaign=main"><img alt="Llama Documentation" src="https://img.shields.io/badge/Llama_OSS-Documentation-4BA9FE?logo=meta" /></a>
1616
<a href="https://huggingface.co/meta-llama"><img alt="Hugging Face meta-llama" src="https://img.shields.io/badge/Hugging_Face-meta--llama-yellow?logo=huggingface" /></a>
1717

1818
</p>
1919
<p align="center">
2020
<a href="https://github.com/meta-llama/synthetic-data-kit"><img alt="Llama Tools Syntethic Data Kit" src="https://img.shields.io/badge/Llama_Tools-synthetic--data--kit-orange?logo=meta" /></a>
21-
<a href="https://github.com/meta-llama/llama-prompt-ops"><img alt="Llama Tools Syntethic Data Kit" src="https://img.shields.io/badge/Llama_Tools-llama--prompt--ops-orange?logo=meta" /></a>
21+
<a href="https://github.com/meta-llama/prompt-ops"><img alt="Llama Tools Syntethic Data Kit" src="https://img.shields.io/badge/Llama_Tools-prompt--ops-orange?logo=meta" /></a>
2222
<a href="https://github.com/meta-llama/llama-cookbook"><img alt="Llama Cookbook" src="https://img.shields.io/badge/Llama_Cookbook-llama--cookbook-orange?logo=meta" /></a>
2323
</p>
2424

2525

2626

27-
llama-prompt-ops is a Python package that **automatically optimizes prompts** for Llama models. It transforms prompts that work well with other LLMs into prompts that are optimized for Llama models, improving performance and reliability.
27+
prompt-ops is a Python package that **automatically optimizes prompts** for Llama models. It transforms prompts that work well with other LLMs into prompts that are optimized for Llama models, improving performance and reliability.
2828

2929
**Key Benefits:**
3030
- **No More Trial and Error**: Stop manually tweaking prompts to get better results
@@ -34,7 +34,7 @@ llama-prompt-ops is a Python package that **automatically optimizes prompts** fo
3434

3535
## Requirements
3636

37-
To get started with llama-prompt-ops, you'll need:
37+
To get started with prompt-ops, you'll need:
3838

3939
- Existing System Prompt: Your existing system prompt that you want to optimize
4040
- Existing Query-Response Dataset: A JSON file containing query-response pairs (as few as 50 examples) for evaluation and optimization (see [prepare your dataset](#preparing-your-data) below)
@@ -50,7 +50,7 @@ To get started with llama-prompt-ops, you'll need:
5050
│ │ │
5151
▼ ▼ ▼
5252
┌────────────────────────────────────────────────────────────────────┐
53-
llama-prompt-ops migrate │
53+
│ prompt-ops migrate │
5454
└────────────────────────────────────────────────────────────────────┘
5555
5656
@@ -91,11 +91,11 @@ conda create -n prompt-ops python=3.10
9191
conda activate prompt-ops
9292

9393
# Install from PyPI
94-
pip install llama-prompt-ops
94+
pip install prompt-ops
9595

9696
# OR install from source
97-
git clone https://github.com/meta-llama/llama-prompt-ops.git
98-
cd llama-prompt-ops
97+
git clone https://github.com/meta-llama/prompt-ops.git
98+
cd prompt-ops
9999
pip install -e .
100100

101101
```
@@ -105,7 +105,7 @@ pip install -e .
105105
This will create a directory called my-project with a sample configuration and dataset in the current folder.
106106

107107
```bash
108-
llama-prompt-ops create my-project
108+
prompt-ops create my-project
109109
cd my-project
110110
```
111111

@@ -122,7 +122,7 @@ You can get an OpenRouter API key by creating an account at [OpenRouter](https:/
122122
The optimization will take about 5 minutes.
123123

124124
```bash
125-
llama-prompt-ops migrate # defaults to config.yaml if --config not specified
125+
prompt-ops migrate # defaults to config.yaml if --config not specified
126126
```
127127

128128
Done! The optimized prompt will be saved to the `results` directory with performance metrics comparing the original and optimized versions.
@@ -141,7 +141,7 @@ Below is an example of a transformed system prompt from proprietary LM to Llama:
141141

142142
## Preparing Your Data
143143

144-
To use llama-prompt-ops for prompt optimization, you'll need to prepare a dataset with your prompts and expected responses. The standard format is a JSON file structured like this:
144+
To use prompt-ops for prompt optimization, you'll need to prepare a dataset with your prompts and expected responses. The standard format is a JSON file structured like this:
145145

146146
```json
147147
[
@@ -156,15 +156,15 @@ To use llama-prompt-ops for prompt optimization, you'll need to prepare a datase
156156
]
157157
```
158158

159-
If your data matches this format, you can use the built-in [`StandardJSONAdapter`](src/llama_prompt_ops/core/datasets.py) which will handle it automatically.
159+
If your data matches this format, you can use the built-in [`StandardJSONAdapter`](src/prompt_ops/core/datasets.py) which will handle it automatically.
160160

161161
### Custom Data Formats
162162

163163
If your data is formatted differently, and there isn't a built-in dataset adapter, you can create a custom dataset adapter by extending the `DatasetAdapter` class. See the [Dataset Adapter Selection Guide](docs/dataset_adapter_selection_guide.md) for more details.
164164

165165
## Multiple Inference Provider Support
166166

167-
llama-prompt-ops supports various inference providers and endpoints to fit your infrastructure needs. See our [detailed guide on inference providers](./docs/inference_providers.md) for configuration examples with:
167+
prompt-ops supports various inference providers and endpoints to fit your infrastructure needs. See our [detailed guide on inference providers](./docs/inference_providers.md) for configuration examples with:
168168

169169
- OpenRouter (cloud-based API)
170170
- vLLM (local deployment)
@@ -174,7 +174,7 @@ llama-prompt-ops supports various inference providers and endpoints to fit your
174174

175175
For more detailed information, check out these resources:
176176

177-
- [Quick Start Guide](docs/basic/readme.md): Get up and running with llama-prompt-ops in 5 minutes
177+
- [Quick Start Guide](docs/basic/readme.md): Get up and running with prompt-ops in 5 minutes
178178
- [Intermediate Configuration Guide](docs/intermediate/readme.md): Learn how to configure datasets, metrics, and optimization strategies
179179
- [Dataset Adapter Selection Guide](docs/dataset_adapter_selection_guide.md): Choose the right adapter for your dataset format
180180
- [Metric Selection Guide](docs/metric_selection_guide.md): Select appropriate evaluation metrics for your use case

configs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# llama-prompt-ops Configuration Files
1+
# prompt-ops Configuration Files
22

3-
This directory contains example YAML configuration files for the llama-prompt-ops tool. These configuration files define how llama-prompt-ops processes your data, optimizes prompts, and evaluates results.
3+
This directory contains example YAML configuration files for the prompt-ops tool. These configuration files define how prompt-ops processes your data, optimizes prompts, and evaluates results.

configs/facility-simple.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ model:
1717

1818
# Metric configuration (simplified but maintains compatibility)
1919
metric:
20-
class: "llama_prompt_ops.core.metrics.FacilityMetric"
20+
class: "prompt_ops.core.metrics.FacilityMetric"
2121
strict_json: false
2222
output_field: "answer"
2323

configs/facility.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ model:
1717

1818
## name the data adapter take in N params
1919
dataset:
20-
adapter_class: "llama_prompt_ops.core.datasets.ConfigurableJSONAdapter"
20+
adapter_class: "prompt_ops.core.datasets.ConfigurableJSONAdapter"
2121
path: "../use-cases/facility-support-analyzer/dataset.json"
2222
train_size: 0.7
2323
validation_size: 0.15
@@ -33,7 +33,7 @@ system_prompt:
3333
outputs: ["answer"]
3434

3535
metric:
36-
class: "llama_prompt_ops.core.metrics.FacilityMetric"
36+
class: "prompt_ops.core.metrics.FacilityMetric"
3737
strict_json: false
3838
output_field: "answer"
3939

configs/hotpotqa.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ model:
55
max_tokens: 40960
66

77
dataset:
8-
adapter_class: "src/llama_prompt_ops/datasets/hotpotqa/adapter.py"
8+
adapter_class: "src/prompt_ops/datasets/hotpotqa/adapter.py"
99
path: "../use-cases/hotpotqa/hotpotqa_sample.json"
1010
train_size: 0.07
1111
validation_size: 0.07
@@ -28,7 +28,7 @@ system_prompt:
2828
outputs: ["answer"]
2929

3030
metric:
31-
class: "src/llama_prompt_ops/datasets/hotpotqa/metric.py"
31+
class: "src/prompt_ops/datasets/hotpotqa/metric.py"
3232
output_field: "answer"
3333
passage_weight: 0.5
3434

docs/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# llama-prompt-ops Getting Started Guide
1+
# prompt-ops Getting Started Guide
22

3-
Welcome to llama-prompt-ops! This guide will help you understand what's supported out of the box and how to get started quickly.
3+
Welcome to prompt-ops! This guide will help you understand what's supported out of the box and how to get started quickly.
44

55
## Quick Start: Choose Your Path
66

@@ -34,7 +34,7 @@ See our [detailed metric selection guide](./metric_selection_guide.md) for more
3434

3535
## Multiple Inference Provider Support
3636

37-
llama-prompt-ops supports various inference providers and endpoints to fit your infrastructure needs. See our [detailed guide on inference providers](./inference_providers.md) for configuration examples with:
37+
prompt-ops supports various inference providers and endpoints to fit your infrastructure needs. See our [detailed guide on inference providers](./inference_providers.md) for configuration examples with:
3838

3939
- OpenRouter (cloud-based API)
4040
- vLLM (local deployment)

0 commit comments

Comments
 (0)