promptwizard
v1.0.0
L'assistant d'invite est un package pour évaluer les invites personnalisées en utilisant diverses méthodes d'évaluation. Il vous permet de fournir vos propres invites ou de les générer automatiquement, puis d'obtenir les résultats dans un fichier JSON.
Pour utiliser l'assistant rapide, vous devez installer le package et toutes ses dépendances à l'aide de PIP
pip install promptwizardAlternativement, clone le référentiel à l'aide de Git Clone https://github.com/leniolabs/promptwiz.git
Pour exécuter l'assistant rapide, vous devrez configurer et spécifier votre clé API OpenAI. Vous pouvez en générer un sur https://platform.openai.com/account/api-Keys. Après avoir obtenu une touche API, spécifiez-le à l'aide de la variable d'environnement OpenAI_API_KEY. Veuillez être conscient des coûts associés à l'utilisation de l'API lors de l'exécution d'évalues.
Avant d'utiliser l'assistant rapide, vous devrez faire défini vos variables d'environnement. Vous avez deux options valides, faites défini votre OPENAI_API_KEY dans un .env dans le bon dossier, ou, si vous décidez d'utiliser azure vous devez définir correctement votre OPENAI_API_TYPE comme azure OPENAI_API_BASE et OPENAI_API_VERSION dans votre .env en plus de l' OPENAI_API_KEY .
Vous avez deux alternatives d'utilisation.
Si vous souhaitez utiliser des fichiers YAML:
Assurez-vous d'avoir le fichier YAML avec les invites que vous souhaitez évaluer. Le fichier YAML doit suivre la structure appropriée.
promptwizard YAML_FILE_PATHpromptwizard YAML_FILE_PATH --env_path .env_FILE_PATHRépondez «y» lorsqu'on vous a demandé si vous voulez continuer.
output.json dans le même dossier que le fichier YAML. Si vous choisissez la méthode ELO pour l'évaluation rapide, un tracé de dispersion scatter_plot.png sera également enregistré dans le même dossier que le fichier YAML. Un plus grand nombre de fichiers seront également générés si vous avez indiqué dans votre fichier YAML que vous souhaitez effectuer des itérations.Si la variable "invites" n'est pas définie dans le fichier YAML, le programme générera automatiquement des invites pour l'évaluation.
Exécutez le package passant votre fichier YAML en tant que paramètre:
promptwizard YAML_FILE_PATHRépondez «y» lorsqu'on vous a demandé si vous voulez continuer.
output.json dans le même dossier que le dossier YAML. Si vous choisissez la méthode ELO pour l'évaluation rapide, un tracé de dispersion scatter_plot.png sera également enregistré dans le même dossier que le fichier YAML.Vous pouvez également l'utiliser dans votre script Python:
import promptwizardEt utiliser les différentes fonctions que PromptWizard peut vous fournir, comme par exemple:
# 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]
Si vous le souhaitez, vous pouvez également spécifier le nombre d'itérations que vous souhaitez effectuer sur vos invites fournies ou celles qui seront générées automatiquement pour obtenir des invites qui obtiennent un comportement optimal pour le modèle de langue. D'un autre côté, l'utilisation de fonctions pour itérer les invites pour votre script Python est disponible:
from promptwizard.prompt_generation import iteration
results = iteration.iterations(test_cases, method= ' Elo ' , prompts=old_prompts, number_of_prompts=3)Nous vous fournissons une explication de la structure valide de vos fichiers YAML et de certaines limites pour certaines variables. Nous vous recommandons de le lire attentivement avant d'exécuter une évaluation.
Ce qui suit est la structure que vos fichiers YAML devraient avoir.
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."""Dans le cas où le fichier YAML que vous souhaitez évaluer a des erreurs dans sa structure, ne vous inquiétez pas. Avant d'être évalué par l'ingénieur rapide, votre fichier sera validé et vous recevrez une notification indiquant où vous devez y apporter des corrections afin d'être évaluée avec succès.
N'oubliez pas que lorsque vous générez vos invites, vous pouvez utiliser la clé de constraints pour demander explicitement que les invites que vous allez générer ont une caractéristique spéciale, par exemple, «générer des invites d'une longueur ne dépassant pas 20 mots».
Si vous voulez savoir combien il en coûtera pour exécuter votre évaluation, entrez simplement:
promptwizard YAML_FILE_PATHEt répondez simplement à «n» lorsqu'on vous a demandé si vous voulez continuer.
Sinon, répondez «y» et exécutez votre évaluation et vous recevrez le coût approximatif, ainsi que le véritable coût final à la fin. Dans le fichier JSON final, en plus de voir les principales invites avec les meilleurs résultats, vous aurez également ces mêmes informations sur les coûts et le nombre de jetons efficacement consommés pour GPT-3.5-Turbo et GPT-4.
Alternativement, vous pouvez effectuer ce qui suit dans votre script Python:
from promptwizard.approximate_cost import cost
print(cost.approximate_cost(test_cases, method, prompts_value))Et vous allez voir un coût approximatif pour votre éventuelle évaluation.
Si vous souhaitez voir des exemples d'utilisation, nous fournissons le cahier Colab suivant pour que vous puissiez explorer les différentes façons d'utiliser PromptWizard. (https://colab.research.google.com/drive/1iw2y43923veohkpuhogenwy1y81rw8i?usp=sharing)
PromptWizard est fabriqué avec amour par Leniolabs et une communauté croissante de contributeurs. Nous créons des expériences numériques avec vos idées. Entrer en contact! De plus, si vous avez des questions ou des commentaires sur PromptWizard, n'hésitez pas à nous contacter à [email protected]. Nous serions ravis de vous entendre!
