promptwizard
v1.0.0
Prompt Wizardは、さまざまな評価方法を使用してカスタムプロンプトを評価するためのパッケージです。これにより、独自のプロンプトを提供したり、自動的に生成してから、JSONファイルで結果を取得できます。
プロンプトウィザードを使用するには、PIPを使用してパッケージとそのすべての依存関係をインストールする必要があります
pip install promptwizardまたは、git clone https://github.com/leniolabs/promptwiz.gitを使用してリポジトリをクローンします
プロンプトウィザードを実行するには、OpenAI APIキーを設定して指定する必要があります。 https://platform.openai.com/account/api-keysで1つを生成できます。 APIキーを取得したら、OpenAI_API_KEY環境変数を使用して指定します。実行中のAPIの使用に関連するコストに注意してください。
プロンプトウィザードを使用する前に、環境変数を定義する必要があります。 2 .envの有効OPENAI_API_KEYオプションがあり、 OPENAI_API_KEY正しいフォルダーの.envで定義するか、 azureを使用する場合は、 OPENAI_API_TYPE OPENAI_API_BASE azureとして定義する必要がありますOPENAI_API_VERSION
2つの使用法があります。
YAMLファイルを使用する場合：
評価するプロンプトを備えたYAMLファイルがあることを確認してください。 YAMLファイルは、適切な構造に従う必要があります。
promptwizard YAML_FILE_PATHpromptwizard YAML_FILE_PATH --env_path .env_FILE_PATH続行するかどうかを尋ねられたときに「Y」と応答します。
output.jsonファイルに保存されます。迅速な評価のためにELOメソッドを選択すると、Sprcition Plot scatter_plot.pngもYAMLファイルと同じフォルダーに保存されます。 YAMLファイルに反復を実行することを示した場合、より多くのファイルも生成されます。「プロンプト」変数がYAMLファイルで定義されていない場合、プログラムは評価のプロンプトを自動的に生成します。
YAMLファイルをパラメーターとして渡すパッケージを実行します。
promptwizard YAML_FILE_PATH続行するかどうかを尋ねられたときに「Y」と応答します。
output.jsonファイルに保存されます。迅速な評価のためにELOメソッドを選択すると、Sprcition Plot scatter_plot.pngもYAMLファイルと同じフォルダーに保存されます。Pythonスクリプトで使用することもできます。
import promptwizardまた、PromptWizardが提供できるさまざまな機能を使用してください。たとえば、次のようなものです。
# 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ノートブックを提供して、PromptWizardを使用できるさまざまな方法を検討します。 （https://colab.research.google.com/drive/1iw2y43923vecohkpuhogenwy1y81rw8i？usp = sharing）
PromptWizardは、Leniolabsと貢献者の成長するコミュニティによって愛を込めて作られています。私たちはあなたのアイデアでデジタルエクスペリエンスを構築します。連絡してください！また、PromptWizardについて質問やフィードバックがある場合は、[email protected]までお気軽にお問い合わせください。ご連絡をお待ちしております！
