promptwizard
v1.0.0
Eingabeaufforderung Assistent ist ein Paket zur Bewertung benutzerdefinierter Eingabeaufforderungen anhand verschiedener Bewertungsmethoden. Sie können Ihre eigenen Eingabeaufforderungen bereitstellen oder automatisch generieren und dann die Ergebnisse in einer JSON -Datei erhalten.
Um einen sofortigen Assistenten zu verwenden, müssen Sie das Paket und alle Abhängigkeiten mit PIP installieren
pip install promptwizardAlternativ klonen Sie das Repository mit Git Clone https://github.com/leniolabs/promptwiz.git
Um einen schnellen Assistenten auszuführen, müssen Sie Ihren OpenAI -API -Schlüssel einrichten und angeben. Sie können eine unter https://platform.openai.com/account/api-keys generieren. Nachdem Sie einen API -Schlüssel erhalten haben, geben Sie diese mit der Umgebungsvariablen openai_api_key an. Bitte beachten Sie die Kosten für die Verwendung der API beim Ausführen von Evalen.
Bevor Sie einen schnellen Assistenten verwenden, müssen Sie Ihre Umgebungsvariablen definieren lassen. Sie haben zwei gültige Optionen, lassen Sie Ihre OPENAI_API_KEY in einem .env im richtigen Ordner definieren oder, wenn Sie sich für azure entscheiden, Ihre OPENAI_API_TYPE als azure und Ihre OPENAI_API_BASE und OPENAI_API_VERSION in Ihrem .env zusätzlich zum OPENAI_API_KEY definieren müssen.
Sie haben zwei Nutzungsalternativen.
Wenn Sie YAML -Dateien verwenden möchten:
Stellen Sie sicher, dass Sie die YAML -Datei mit den Eingabeaufforderungen haben, die Sie bewerten möchten. Die YAML -Datei sollte der richtigen Struktur folgen.
promptwizard YAML_FILE_PATHpromptwizard YAML_FILE_PATH --env_path .env_FILE_PATHAntworte 'y', wenn Sie gefragt werden, ob Sie fortfahren möchten.
output.json in derselben Ordner wie die YAML -Datei gespeichert. Wenn Sie die ELO -Methode für die Eingabeaufforderung auswählen, wird auch ein Streudiagramm scatter_plot.png im selben Ordner wie die YAML -Datei gespeichert. Eine größere Anzahl von Dateien wird auch generiert, wenn Sie in Ihrer YAML -Datei angegeben haben, dass Sie Iterationen ausführen möchten.Wenn die Variable "Eingabeaufforderungen" in der YAML -Datei nicht definiert ist, generiert das Programm automatisch Eingabeaufforderungen für die Bewertung.
Führen Sie das Paket aus, das Ihre YAML -Datei als Parameter übergibt:
promptwizard YAML_FILE_PATHAntworte 'y', wenn Sie gefragt werden, ob Sie fortfahren möchten.
output.json im selben Ordner wie der YAML -Ordner gespeichert. Wenn Sie die ELO -Methode für die Eingabeaufforderung auswählen, wird auch ein Streudiagramm scatter_plot.png im selben Ordner wie die YAML -Datei gespeichert.Sie können es auch in Ihrem Python -Skript verwenden:
import promptwizardUnd verwenden Sie die verschiedenen Funktionen, die Sie mit dem forderungswizard zur Verfügung stellen können, z. B. zum Beispiel:
# Example of using PromptWizard
from promptwizard import prompt_generation
test_cases = [
{ ' input ' : ' How do you make a classic spaghetti carbonara? ' , ' output ' : ' REPLY ' },
{ ' input ' : " What is John Smith's phone number? " , ' output ' : ' NOT_REPLY ' },
]
description = " Decide whether the question should be answered or not. " # A short description of the type of task for the test cases.
system_gen_prompt = " " " Your job is to generate system prompts for GPT, given a description of the use-case and some test cases.
In your generated prompt, you should describe how the AI should behave in plain English. Include what it will see, and what it's allowed to output. Be creative with prompts to get the best possible results. The AI knows it's an AI -- you don't need to tell it this.
Remember that the prompt should only allow the AI to answer the answer and nothing else. No explanation is necessary.
You will be graded based on the performance of your prompt... but don't cheat! You cannot include specifics about the test cases in your prompt. Any prompts with examples will be disqualified. I repeat, do not include the test cases.
Most importantly, output NOTHING but the prompt. Do not include anything else in your message. " " " # Here you have to indicate to the LLM how your generated prompts should be. This example is useful if you later want to use the equals evaluation method.
# Create 4 prompts.
prompts = prompt_generation.generate_candidate_prompts(system_gen_prompt, test_cases, description)[0]
Wenn Sie möchten, können Sie auch die Anzahl der Iterationen angeben, die Sie an Ihren bereitgestellten Eingabeaufforderungen ausführen möchten, oder diejenigen, die automatisch generiert werden, um Eingabeaufforderungen zu erhalten, die ein optimales Verhalten für das Sprachmodell erreichen. Andererseits ist die Verwendung von Funktionen zur IT -Aufforderung für Ihr Python -Skript verfügbar:
from promptwizard.prompt_generation import iteration
results = iteration.iterations(test_cases, method= ' Elo ' , prompts=old_prompts, number_of_prompts=3)Wir geben Ihnen eine Erläuterung der gültigen Struktur Ihrer YAML -Dateien und bestimmte Einschränkungen für einige darin enthaltene Variablen. Wir empfehlen Ihnen, es sorgfältig zu lesen, bevor Sie eine Bewertung durchführen.
Das Folgende ist die Struktur, die Ihre YAML -Dateien haben sollten.
test:
cases: " " " Here, you have to put the test cases you are going to use to evaluate your prompts. If you are going to use the
Elo method to evaluate them, it should be just a list of strings. If you are going to use the methods classification,
equal or includes, it should be a list of tuples with two elements, where the first element is the test case and the
second element is the correct response to the test. Remember that if you decide to use classification, only a boolean
value is allowed as a response. the form of your test cases has to be, in case of selecting the Elo method:
-'Test1'
-'Test2'...
If you choose the methods Classification, Equals, Includes, Semantic Similarity or LogProbs they must be of the form:
-input: 'Test1'
output: 'Answer1'
-input: 'Test2'
output: 'Answer2'
In case the method is Function Calling:
-input: 'Test1'
output1: 'name_function'
output2: 'variable'
-input: 'Test2'
output1: 'name_function'
output2: 'variable'
If you choose Code Generation:
- input: 'Test1'
arguments: (arg1,) in case there is only one argument, (arg1, arg2,...) in case there are more than one argument.
output: res
and finally if you choose JSON Validation:
- input: 'Test1'
output: json_output " " "
description: " " " Here is the description of the type of task that summarizes the test cases. You only have to use this field if
you are going to use the 'Elo' method " " "
method: " " " Here, you select the evaluation method for your prompts. You must choose between 'Elo',
'Classification', 'Equals', 'Includes', 'Function Calling', 'Code Generation' 'JSON Validation', 'Semantic Similarity' and 'LogProbs'. " " "
model:
name: " " " The name of the GPT model you will use to evaluate the prompts. " " "
temperature: " " " The temperature of the GPT model you will use to evaluate the prompts. " " "
max_tokens: " " " The maximum number of tokens you will allow the GPT model to use to generate the response to the test. " " "
functions: " " " This field must only be filled out in case the 'Function Calling' method is intended to be used.
If another method is used, it must not be filled out. The structure is a JSON object. Let's break down the different components:
- Function Name (name): This is the identifier used to refer to this function within the context of your code.
- Function Description (description): A brief description of what the function does.
- Function Parameters (parameters): This section defines the input parameters that the function accepts.
- Type (type): The type of the parameter being defined.
- Properties (properties): This is an object containing properties that the input parameter object should have.
- File Type (file_type): This is a property of the parameter object.
- Enum (enum): An enumeration of allowed values for the 'file_type' property. (optional)
- Description (description): A description of what the 'file_type' property represents.
- Required (required): An array listing the properties that are required within the parameter object. (optional) " " "
function_call: " " " This field must only be filled out in case the 'Function Calling' method is intended to be
used. If another method is used, it must not be filled out. " " "
prompts: " " " You have two options, either provide your list of prompts or generate them following the instructions below. " " "
list: " " " A list of prompts you want to evaluate. If you want to generate them with the prompt generator, don't use this field.
Please provide a minimum number of 4 prompts. Your prompts must be listed as follows:
- 'Prompt1'
- 'Prompt2'... " " "
generation:
number: " " " The number of prompts you are going to evaluate. You need to provide this key value only if you are going to generate the prompts. Indicate the quantity of prompts you want to generate. Please provide a minimum number of 4 prompts. If you do not define this key by default, 4 prompts will be created. " " "
constraints: " " " If you are going to generate prompts, this optional feature allows you to add special characteristics to the prompts that will be generated. For example, if you want prompts with a maximum length of 50 characters, simply complete with 'Generate prompts with a maximum length of 50 characters'. If you don't want to use it, you don't need to have this key defined. " " "
description: " " " Here is the description of the type of task that summarizes the test cases. If you use the 'Elo' method you mustn't use this field. " " "
best_prompts: " " " The number of prompts you want to iterate over and on which you want to highlight the final results. the value must be between 2 and the number of prompts you provide (or generate) minus one. If you do not define this value the default value will be 2. " " "
model:
name: " " " The name of the GPT model you will use to generate the prompts. " " "
temperature: " " " The temperature of the GPT model you will use to generate the prompts. " " "
max_tokens: " " " The maximum number of tokens you will allow the GPT model to use to generate your prompts. " " "
iterations:
number: " " " The number of iterations you want to perform on the best prompts obtained in your initial testing to arrive at
prompts with better final results. If you don't want to try alternatives combining your best prompts just put 0. " " "
best_percentage: " " " Number between 0 and 100 indicating that iterations should be stopped if all 'best_prompts' equaled or exceeded the indicated accuracy. If this value is not defined, it will default to 100. " " "
model:
name: " " " The name of the GPT model you will use to generate the prompts. " " "
temperature: " " " The temperature of the GPT model you will use to generate the prompts. " " "
max_tokens: " " " The maximum number of tokens you will allow the GPT model to use to generate your prompts. " " "
You can not define these variables for ' model ' in case you want to keep the same variables that were used in ' generation ' , in case the ' generation ' field has not been used it will take the following default values:
name: ' gpt-4
temperature: 0.6
max_tokens: 300"""
timeout: """Timeout set for an API request. This time limit indicates how long the client should wait to receive a response before the request expires."""
n_retries: """Number of attempts that will be automatically made to resend an API request in case the initial request fails."""Wenn die YAML -Datei, die Sie bewerten möchten, Fehler in ihrer Struktur aufweist, mach dir keine Sorgen. Bevor Sie vom promptierten Ingenieur bewertet werden, wird Ihre Datei validiert, und Sie erhalten eine Benachrichtigung, die angibt, wo Sie Korrekturen vornehmen müssen, um erfolgreich bewertet zu werden.
Denken Sie daran, dass Sie bei der Erstellung Ihrer Eingabeaufforderungen den constraints verwenden können, um die Eingabeaufforderungen, die Sie generieren möchten, ein spezielles Merkmal haben, z.
Wenn Sie wissen möchten, wie viel es für die Ausführung Ihrer Bewertung kosten wird, geben Sie einfach ein:
promptwizard YAML_FILE_PATHund antworten Sie einfach 'n', wenn Sie gefragt werden, ob Sie fortfahren möchten.
Andernfalls antworten Sie "y" und führen Sie Ihre Bewertung durch, und Sie erhalten die ungefähren Kosten zusammen mit den realen endgültigen Kosten am Ende. In der endgültigen JSON-Datei haben Sie nicht nur die besten Eingaben mit den besten Ergebnissen, sondern auch die gleichen Informationen über die Kosten und die Anzahl der Token, die sowohl für GPT-3,5-Turbo als auch für GPT-4 effektiv konsumiert werden.
Alternativ können Sie Folgendes in Ihrem Python -Skript ausführen:
from promptwizard.approximate_cost import cost
print(cost.approximate_cost(test_cases, method, prompts_value))Und Sie werden ungefähre Kosten für Ihre mögliche Bewertung sehen.
Wenn Sie Verwendungsbeispiele sehen möchten, geben wir das folgende Colab -Notizbuch zur Verfügung, mit denen Sie die verschiedenen Möglichkeiten untersuchen können, wie Sie forderungswizard verwenden können. (https://colab.research.google.com/drive/1iw2y43923vecohkpuhogenwy1y81rw8i?usp=sharing)
PromptWizard wird von Leniolabs und einer wachsenden Gemeinschaft von Mitwirkenden mit Liebe hergestellt. Wir bauen digitale Erlebnisse mit Ihren Ideen auf. Sich in Verbindung setzen! Wenn Sie Fragen oder Feedback zu PromptWizard haben, kontaktieren Sie uns bitte unter [email protected]. Wir würden gerne von Ihnen hören!
