promptwizard
v1.0.0
المعالج المطالب هو حزمة لتقييم المطالبات المخصصة باستخدام طرق التقييم المختلفة. يسمح لك بتوفير المطالبات الخاصة بك أو إنشاءها تلقائيًا ثم الحصول على النتائج في ملف JSON.
لاستخدام معالج موجه ، تحتاج إلى تثبيت الحزمة وجميع تبعياتها باستخدام PIP
pip install promptwizardبدلاً من ذلك ، استنساخ المستودع باستخدام git clone https://github.com/leniolabs/promptwiz.git
لتشغيل معالج موجه ، ستحتاج إلى إعداد وتحديد مفتاح Openai API الخاص بك. يمكنك إنشاء واحدة على https://platform.openai.com/account/api- keys. بعد الحصول على مفتاح API ، حدده باستخدام متغير بيئة OpenAI_API_KEY. يرجى العلم بالتكاليف المرتبطة باستخدام واجهة برمجة التطبيقات عند تشغيل EVALS.
قبل استخدام المعالج السريع ، ستحتاج إلى تحديد متغيرات البيئة الخاصة بك. لديك خياران صالحان ، هل تم تعريف OPENAI_API_KEY في .env في المجلد الصحيح ، أو ، إذا قررت استخدام azure OPENAI_API_KEY فأنت بحاجة إلى تحديد OPENAI_API_TYPE كما azure و OPENAI_API_BASE و OPENAI_API_VERSION بشكل صحيح في .env
لديك اثنين من البديل الاستخدام.
إذا كنت ترغب في استخدام ملفات Yaml:
تأكد من أن لديك ملف yaml مع المطالبات التي تريد تقييمها. يجب أن يتبع ملف yaml الهيكل المناسب.
promptwizard YAML_FILE_PATHpromptwizard YAML_FILE_PATH --env_path .env_FILE_PATHالرد على 'y' عندما سئل عما إذا كنت تريد المتابعة.
output.json في نفس المجلد مثل ملف yaml. إذا اخترت طريقة ELO للتقييم المطري ، فسيتم حفظ مؤامرة Scatter scatter_plot.png في نفس المجلد مثل ملف Yaml. سيتم أيضًا إنشاء عدد أكبر من الملفات إذا كنت قد أوضحت في ملف YAML الخاص بك أنك تريد تنفيذ التكرارات.إذا لم يتم تعريف متغير "المطالبات" في ملف YAML ، فسيقوم البرنامج تلقائيًا بإنشاء مطالبات للتقييم.
قم بتشغيل الحزمة التي تمرر ملف yaml الخاص بك كمعلمة:
promptwizard YAML_FILE_PATHالرد على 'y' عندما سئل عما إذا كنت تريد المتابعة.
output.json في نفس المجلد مثل مجلد YAML. إذا اخترت طريقة ELO للتقييم المطري ، فسيتم حفظ مؤامرة Scatter scatter_plot.png في نفس المجلد مثل ملف Yaml.يمكنك أيضًا استخدامه في نص Python الخاص بك:
import promptwizardواستخدام الوظائف المختلفة التي يمكن أن توفر لك orderwizard ، مثل على سبيل المثال:
# 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 التالي لك لاستكشاف الطرق المختلفة التي يمكنك استخدامها. (https://colab.research.google.com/drive/1iw2y43923vechkpuhogenwy1y81rw8i؟usp=sharing)
تم تصميم Dormwizard بالحب من قبل Leniolabs ومجتمع متزايد من المساهمين. نحن نبني تجارب رقمية مع أفكارك. تواصل! أيضًا ، إذا كان لديك أي أسئلة أو تعليقات حول Promswizard ، فلا تتردد في الاتصال بنا على [email protected]. نود أن نسمع منك!
