promptwizard
v1.0.0
El asistente rápido es un paquete para evaluar las indicaciones personalizadas utilizando varios métodos de evaluación. Le permite proporcionar sus propias indicaciones o generarlas automáticamente y luego obtener los resultados en un archivo JSON.
Para usar el Asistente de indicación, debe instalar el paquete y todas sus dependencias utilizando PIP
pip install promptwizardAlternativamente, clone el repositorio usando Git Clone https://github.com/leniolabs/prompptwiz.git
Para ejecutar el asistente de pronta, deberá configurar y especificar su tecla API OpenAI. Puede generar uno en https://platform.openai.com/account/api-keys. Después de obtener una tecla API, especifíquela utilizando la variable de entorno OpenAI_API_KEY. Tenga en cuenta los costos asociados con el uso de la API al ejecutar Evals.
Antes de usar el Asistente de inmediato, deberá definir sus variables de entorno. Tiene dos opciones válidas, tiene su OPENAI_API_KEY definida en un .env en la carpeta correcta, o, si decide usar azure necesita definir su OPENAI_API_TYPE como azure y su OPENAI_API_BASE y OPENAI_API_VERSION correctamente en su .env además de OPENAI_API_KEY .
Tienes dos alternativas de uso.
Si desea usar archivos YAML:
Asegúrese de tener el archivo YAML con las indicaciones que desea evaluar. El archivo YAML debe seguir la estructura adecuada.
promptwizard YAML_FILE_PATHpromptwizard YAML_FILE_PATH --env_path .env_FILE_PATHResponda 'y' cuando se le preguntó si desea continuar.
output.json en la misma carpeta que el archivo YAML. Si elige el método ELO para la evaluación rápida, una gráfica de dispersión scatter_plot.png también se guardará en la misma carpeta que el archivo YAML. También se generará una mayor cantidad de archivos si ha indicado en su archivo YAML que desea realizar iteraciones.Si la variable "indicaciones" no se define en el archivo YAML, el programa generará automáticamente indicaciones para la evaluación.
Ejecute el paquete que pasa su archivo YAML como parámetro:
promptwizard YAML_FILE_PATHResponda 'y' cuando se le preguntó si desea continuar.
output.json en la misma carpeta que la carpeta YAML. Si elige el método ELO para la evaluación rápida, una gráfica de dispersión scatter_plot.png también se guardará en la misma carpeta que el archivo YAML.También puede usarlo en su script de Python:
import promptwizardY use las diversas funciones que PromptWizard puede proporcionarle, como por ejemplo:
# 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 lo desea, también puede especificar el número de iteraciones que desea realizar en sus indicaciones proporcionadas o las que se generarán automáticamente para obtener indicaciones que logran un comportamiento óptimo para el modelo de lenguaje. Por otro lado, el uso de funciones para iterar las indicaciones para su script de Python está disponible:
from promptwizard.prompt_generation import iteration
results = iteration.iterations(test_cases, method= ' Elo ' , prompts=old_prompts, number_of_prompts=3)Le proporcionamos una explicación de la estructura válida de sus archivos YAML y ciertas limitaciones para algunas variables dentro de él. Le recomendamos que lo lea cuidadosamente antes de ejecutar una evaluación.
La siguiente es la estructura que deberían tener sus archivos YAML.
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."""En caso de que el archivo YAML que desea evaluar tiene errores en su estructura, no se preocupe. Antes de ser evaluado por el ingeniero rápido, su archivo será validado y recibirá una notificación que indica dónde necesita hacer correcciones para ser evaluada con éxito.
Recuerde que cuando genera sus indicaciones, puede usar la clave constraints para solicitar explícitamente que las indicaciones que generará tienen una característica especial, por ejemplo, 'generar indicaciones de una longitud que no exceden las 20 palabras'.
Si desea saber cuánto costará ejecutar su evaluación, simplemente ingrese:
promptwizard YAML_FILE_PATHy simplemente responda 'n' cuando se le pregunta si desea continuar.
De lo contrario, responda 'Y' y ejecute su evaluación y recibirá el costo aproximado, junto con el costo final real al final. En el archivo JSON final, además de ver las mejores indicaciones con los mejores resultados, también tendrá esta misma información sobre los costos y el número de tokens consumidos efectivamente para GPT-3.5-TURBO y GPT-4.
Alternativamente, puede hacer lo siguiente en su script de Python:
from promptwizard.approximate_cost import cost
print(cost.approximate_cost(test_cases, method, prompts_value))Y verá un costo aproximado para su posible evaluación.
Si desea ver ejemplos de uso, le proporcionamos el siguiente cuaderno Colab para que explore las diferentes formas en que puede usar PromptWizard. (https://colab.research.google.com/drive/1iw2y43923vecohkpuhogenwy1y81rw8i?usp=sharing)
Leniolabs y una creciente comunidad de contribuyentes elaboran PractWizard con amor y una creciente comunidad de contribuyentes. Construimos experiencias digitales con sus ideas. ¡Ponte en contacto! Además, si tiene alguna pregunta o comentarios sobre PromptWizard, no dude en contactarnos en [email protected]. ¡Nos encantaría saber de ti!
