promptwizard
v1.0.0
Приглашенный мастер - это пакет для оценки пользовательских подсказок с использованием различных методов оценки. Это позволяет вам предоставлять свои собственные подсказки или автоматически генерировать их, а затем получить результаты в файле JSON.
Для использования бытового мастера вам нужно установить пакет и все его зависимости, используя PIP
pip install promptwizardВ качестве альтернативы, клонировать репозиторий, используя Git Clone https://github.com/leniolabs/promptwiz.git
Чтобы запустить мастер на приглашении, вам нужно будет настроить и указать свой ключ API OpenAI. Вы можете генерировать один по адресу https://platform.openai.com/account/api-keys. После того, как вы получите ключ API, укажите его, используя переменную среды OpenAI_API_KEY. Пожалуйста, имейте в виду затраты, связанные с использованием API при запуске Evals.
Перед использованием приглашенного мастера вам нужно будет определить переменные среды. OPENAI_API_TYPE .env OPENAI_API_VERSION OPENAI_API_KEY действительных варианта OPENAI_API_BASE ваш OPENAI_API_KEY azure azure .env
У вас есть две альтернативы использования.
Если вы хотите использовать файлы YAML:
Убедитесь, что у вас есть файл YAML с подсказками, которые вы хотите оценить. Файл YAML должен следовать надлежащей структуре.
promptwizard YAML_FILE_PATHpromptwizard YAML_FILE_PATH --env_path .env_FILE_PATHОтветьте «y», когда спросили, хотите ли вы продолжить.
output.json в той же папке, что и файл YAML. Если вы выберете метод ELO для быстрого оценки, рассеянный график scatter_plot.png Большее количество файлов также будет сгенерировано, если вы указали в своем файле YAML, что вы хотите выполнить итерации.Если переменная «подсказок» не определена в файле YAML, программа автоматически генерирует подсказки для оценки.
Запустите пакет, передав ваш файл YAML в качестве параметра:
promptwizard YAML_FILE_PATHОтветьте «y», когда спросили, хотите ли вы продолжить.
output.json в той же папке, что и в папке YAML. Если вы выберете метод ELO для быстрого оценки, рассеянный график scatter_plot.pngВы также можете использовать его в своем сценарии Python:
import promptwizardИ используйте различные функции, которые может предоставить вам rackwizard, например:
# 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]
Если вы хотите, вы также можете указать количество итераций, которые вы хотите выполнить в предоставленных своих подсказках, или те, которые будут созданы автоматически для получения подсказок, которые достигают оптимального поведения для языковой модели. С другой стороны, использование функций для итерационных подсказок для вашего сценария Python доступно:
from promptwizard.prompt_generation import iteration
results = iteration.iterations(test_cases, method= ' Elo ' , prompts=old_prompts, number_of_prompts=3)Мы предоставляем вам объяснение действительной структуры ваших файлов YAML и определенных ограничений для некоторых переменных в нем. Мы рекомендуем вам внимательно прочитать его перед проведением оценки.
Ниже приведена структура, которую должны иметь ваши файлы 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."""В случае, если файл YAML, который вы хотите оценить, имеет ошибки в своей структуре, не волнуйтесь. Перед тем, как быть оцененным инженером -быстрого инженера, ваш файл будет подтвержден, и вы получите уведомление, указывающее, где вам необходимо внести в него исправление для успешной оценки.
Помните, что когда вы генерируете свои подсказки, вы можете использовать ключ constraints , чтобы явно запросить, чтобы подсказки, которые вы собираетесь генерировать, имели особую характеристику, например, «генерировать подсказки длины, не превышающую 20 слов».
Если вы хотите знать, сколько это будет стоить для запуска вашей оценки, просто введите:
promptwizard YAML_FILE_PATHИ просто ответьте «n», когда спросили, хотите ли вы продолжить.
В противном случае ответьте «y» и запустите свою оценку, и вы получите приблизительную стоимость, а также реальную конечную стоимость в конце. В финальном файле JSON, в дополнение к тому, что у вас есть наилучшие результаты, у вас также будет та же информация о затратах и количестве токенов, эффективно потребляемых как для GPT-3.5-Turbo, так и для GPT-4.
В качестве альтернативы, вы можете сделать следующее в своем сценарии Python:
from promptwizard.approximate_cost import cost
print(cost.approximate_cost(test_cases, method, prompts_value))И вы увидите приблизительную стоимость вашей возможной оценки.
Если вы хотите увидеть примеры использования, мы предоставляем следующую ноутбук Colab, чтобы вы могли изучить различные способы использования rackwizard. (https://colab.research.google.com/drive/1iw2y43923vecohkpuhogenwy1y81rw8i?usp=sharing)
rampwizard создан с любовью со стороны лиолабах и растущим сообществом участников. Мы создаем цифровой опыт с вашими идеями. Свяжитесь с нами! Кроме того, если у вас есть какие -либо вопросы или отзывы о Quickwizard, пожалуйста, свяжитесь с нами по адресу [email protected]. Мы хотели бы услышать от вас!
