promptwizard
v1.0.0
O Promp Wizard é um pacote para avaliar os avisos personalizados usando vários métodos de avaliação. Ele permite fornecer seus próprios prompts ou gerá -los automaticamente e, em seguida, obtenha os resultados em um arquivo JSON.
Para usar o Assistente Prompt, você precisa instalar o pacote e todas as suas dependências usando PIP
pip install promptwizardComo alternativa, clone o repositório usando o git clone https://github.com/leniolabs/promptwiz.git
Para executar o Prompt Wizard, você precisará configurar e especificar sua chave de API do OpenAI. Você pode gerar um em https://platform.openai.com/account/api-keys. Depois de obter uma chave da API, especifique -a usando a variável de ambiente OpenAI_API_KEY. Esteja ciente dos custos associados ao uso da API ao executar o EVALS.
Antes de usar o Assistente Prompt, você precisará definir suas variáveis de ambiente. Você tem duas opções válidas, definir seu OPENAI_API_KEY em um .env na pasta correta ou, se você decidir usar azure , precisará definir seu OPENAI_API_TYPE como azure e seu OPENAI_API_BASE e OPENAI_API_VERSION corretamente no seu .env , além do OPENAI_API_KEY .
Você tem duas alternativas de uso.
Se você deseja usar arquivos YAML:
Certifique -se de ter o arquivo YAML com os avisos que deseja avaliar. O arquivo YAML deve seguir a estrutura adequada.
promptwizard YAML_FILE_PATHpromptwizard YAML_FILE_PATH --env_path .env_FILE_PATHResponda 'y' quando perguntado se você deseja continuar.
output.json na mesma pasta que o arquivo YAML. Se você escolher o método ELO para avaliação imediata, um plot scatter_plot.png também será salvo na mesma pasta que o arquivo YAML. Um número maior de arquivos também será gerado se você tiver indicado no seu arquivo YAML que deseja executar iterações.Se a variável "prompts" não estiver definida no arquivo YAML, o programa gerará automaticamente prompts para avaliação.
Execute o pacote que passa pelo seu arquivo YAML como parâmetro:
promptwizard YAML_FILE_PATHResponda 'y' quando perguntado se você deseja continuar.
output.json na mesma pasta que a pasta YAML. Se você escolher o método ELO para avaliação imediata, um plot scatter_plot.png também será salvo na mesma pasta que o arquivo YAML.Você também pode usá -lo em seu script python:
import promptwizardE use as várias funções que o Promptwizard pode fornecer, como por exemplo:
# 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]
Se desejar, você também pode especificar o número de iterações que deseja executar nos prompts fornecidos ou os que serão gerados automaticamente para obter prompts que alcançam o comportamento ideal para o modelo de idioma. Por outro lado, o uso de funções para iterar os avisos para o seu script python está disponível:
from promptwizard.prompt_generation import iteration
results = iteration.iterations(test_cases, method= ' Elo ' , prompts=old_prompts, number_of_prompts=3)Fornecemos uma explicação da estrutura válida dos seus arquivos YAML e certas limitações para algumas variáveis dentro dela. Recomendamos que você o leia cuidadosamente antes de executar uma avaliação.
A seguir, é apresentada a estrutura que seus arquivos YAML devem ter.
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."""Caso o arquivo YAML que você deseja avaliar tenha erros em sua estrutura, não se preocupe. Antes de ser avaliado pelo engenheiro rápido, seu arquivo será validado e você receberá uma notificação indicando onde precisa fazer correções para ser avaliado com sucesso.
Lembre -se de que, quando você gerar seus avisos, pode usar a chave constraints para solicitar explicitamente que os avisos que você gerará têm uma característica especial, por exemplo, 'gerar instruções de um comprimento não excedendo 20 palavras'.
Se você quiser saber quanto custará para executar sua avaliação, basta entrar:
promptwizard YAML_FILE_PATHE simplesmente responda 'n' quando perguntado se você deseja continuar.
Caso contrário, responda 'y' e execute sua avaliação e você receberá o custo aproximado, juntamente com o custo final real no final. No arquivo JSON final, além de ver os principais prompts com os melhores resultados, você também terá as mesmas informações sobre os custos e o número de tokens consumidos efetivamente para GPT-3.5-turbo e GPT-4.
Como alternativa, você pode fazer o seguinte em seu script Python:
from promptwizard.approximate_cost import cost
print(cost.approximate_cost(test_cases, method, prompts_value))E você verá um custo aproximado para sua possível avaliação.
Se você deseja ver exemplos de uso, fornecemos o seguinte notebook COLAB para explorar as diferentes maneiras pelas quais você pode usar o PromptWizard. (https://colab.research.google.com/drive/1iw2y43923vecohkpuhogenwy1y81rw8i?usp=sharing)
O PromptWizard é criado com amor por leniolabs e uma crescente comunidade de colaboradores. Construímos experiências digitais com suas idéias. Entre em contato! Além disso, se você tiver alguma dúvida ou feedback sobre o PromptWizard, não hesite em entrar em contato conosco em [email protected]. Gostaríamos muito de ouvir de você!
