You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/bug.yml
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
1
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
3
3
labels: ["bug"]
4
4
body:
5
5
- type: markdown
6
6
attributes:
7
7
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.
9
9
10
10
- type: textarea
11
11
id: bug-description
@@ -26,7 +26,7 @@ body:
26
26
label: How to reproduce
27
27
description: Steps to reproduce the issue, including any commands or code.
28
28
placeholder: |
29
-
1. Run `llama-prompt-ops optimize --config configs/facility.yaml`
29
+
1. Run `prompt-ops optimize --config configs/facility.yaml`
30
30
2. See error...
31
31
32
32
```bash
@@ -42,7 +42,7 @@ body:
42
42
description: Your Python version and any relevant system info.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Contributing to llama-prompt-ops
1
+
# Contributing to prompt-ops
2
2
We want to make contributing to this project as easy and transparent as
3
3
possible.
4
4
@@ -23,4 +23,4 @@ We use GitHub issues to track public bugs. Please ensure your description is cle
23
23
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.
24
24
25
25
## 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.
<ahref="https://github.com/meta-llama/llama-models/blob/main/models/?utm_source=llama-prompt-ops&utm_medium=readme&utm_campaign=main"><imgalt="Llama Model cards"src="https://img.shields.io/badge/Llama_OSS-Model_cards-green?logo=meta" /></a>
<ahref="https://github.com/meta-llama/llama-models/blob/main/models/?utm_source=prompt-ops&utm_medium=readme&utm_campaign=main"><imgalt="Llama Model cards"src="https://img.shields.io/badge/Llama_OSS-Model_cards-green?logo=meta" /></a>
<ahref="https://huggingface.co/meta-llama"><imgalt="Hugging Face meta-llama"src="https://img.shields.io/badge/Hugging_Face-meta--llama-yellow?logo=huggingface" /></a>
17
17
18
18
</p>
19
19
<palign="center">
20
20
<ahref="https://github.com/meta-llama/synthetic-data-kit"><imgalt="Llama Tools Syntethic Data Kit"src="https://img.shields.io/badge/Llama_Tools-synthetic--data--kit-orange?logo=meta" /></a>
21
-
<ahref="https://github.com/meta-llama/llama-prompt-ops"><imgalt="Llama Tools Syntethic Data Kit"src="https://img.shields.io/badge/Llama_Tools-llama--prompt--ops-orange?logo=meta" /></a>
21
+
<ahref="https://github.com/meta-llama/prompt-ops"><imgalt="Llama Tools Syntethic Data Kit"src="https://img.shields.io/badge/Llama_Tools-prompt--ops-orange?logo=meta" /></a>
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.
28
28
29
29
**Key Benefits:**
30
30
-**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
34
34
35
35
## Requirements
36
36
37
-
To get started with llama-prompt-ops, you'll need:
37
+
To get started with prompt-ops, you'll need:
38
38
39
39
- Existing System Prompt: Your existing system prompt that you want to optimize
40
40
- 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:
This will create a directory called my-project with a sample configuration and dataset in the current folder.
106
106
107
107
```bash
108
-
llama-prompt-ops create my-project
108
+
prompt-ops create my-project
109
109
cd my-project
110
110
```
111
111
@@ -122,7 +122,7 @@ You can get an OpenRouter API key by creating an account at [OpenRouter](https:/
122
122
The optimization will take about 5 minutes.
123
123
124
124
```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
126
126
```
127
127
128
128
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:
141
141
142
142
## Preparing Your Data
143
143
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:
145
145
146
146
```json
147
147
[
@@ -156,15 +156,15 @@ To use llama-prompt-ops for prompt optimization, you'll need to prepare a datase
156
156
]
157
157
```
158
158
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.
160
160
161
161
### Custom Data Formats
162
162
163
163
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.
164
164
165
165
## Multiple Inference Provider Support
166
166
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:
168
168
169
169
- OpenRouter (cloud-based API)
170
170
- vLLM (local deployment)
@@ -174,7 +174,7 @@ llama-prompt-ops supports various inference providers and endpoints to fit your
174
174
175
175
For more detailed information, check out these resources:
176
176
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
178
178
-[Intermediate Configuration Guide](docs/intermediate/readme.md): Learn how to configure datasets, metrics, and optimization strategies
179
179
-[Dataset Adapter Selection Guide](docs/dataset_adapter_selection_guide.md): Choose the right adapter for your dataset format
180
180
-[Metric Selection Guide](docs/metric_selection_guide.md): Select appropriate evaluation metrics for your use case
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.
Copy file name to clipboardExpand all lines: docs/README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# llama-prompt-ops Getting Started Guide
1
+
# prompt-ops Getting Started Guide
2
2
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.
4
4
5
5
## Quick Start: Choose Your Path
6
6
@@ -34,7 +34,7 @@ See our [detailed metric selection guide](./metric_selection_guide.md) for more
34
34
35
35
## Multiple Inference Provider Support
36
36
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:
0 commit comments