o RTh@s8ddlZddlZddlmZmZmZmZddlmZddlm Z GdddeZ ddZ d d Z d d gfd dZdN)AnyCallable NamedTupleOptional)assert_has_pandas)pandasc@seZdZUeed<dZeeed<dZeeed<dZee e ge fed<dZ eeed<dZ ee e ge fed<dZ eeed<dS) RemediationnameN immediate_msg necessary_msg necessary_fn optional_msg optional_fn error_msg)__name__ __module__ __qualname__str__annotations__r rr r rrr rrrrT/home/air/segue/gemini/backup/venv/lib/python3.10/site-packages/openai/validators.pyr s rcCs8d}t||kr dnd}dt|d|}td|dS)z This validator will only print out the number of examples and recommend to the user to increase the number of examples if less than 100. dz. In general, we recommend having at least a few hundred examples. We've found that performance tends to linearly increase for every doubling of the number of examplesz - Your file contains z prompt-completion pairs num_examplesr r )lenr)df MIN_EXAMPLESoptional_suggestionr rrrnum_examples_validators  rcsddd}d}d}d}|jvr7dd|jDvr1fdd}|}dd }d d }nd d }td ||||dS)z[ This validator will ensure that the necessary column is present in the dataframe. cs2fdd|jD}|j|didd|S)Ncs g|] }t|kr|qSrrlower.0ccolumnrr )s zInecessary_column_validator..lower_case_column..rT)columnsinplace)r(renamer!)rr&colsrr%rlower_case_column(sz5necessary_column_validator..lower_case_columnNcSsg|]}t|qSrr r"rrrr'3z.necessary_column_validator..c |SNr)rr,necessary_columnrrlower_case_column_creator5 z=necessary_column_validator..lower_case_column_creatorz - The `z ` column/key should be lowercasezLower case column name to ``z^` column/key is missing. Please make sure you name your columns/keys appropriately, then retryr1)r r r r r)r(r)rr1r r r rr2rr0rnecessary_column_validator#s(   r5prompt completioncsg}d}d}d}t|jdkrLfdd|jD}d}|D]fdd|D}t|dkr9|dd d 7}qd ||}d |}fd d}td|||dS)zK This validator will remove additional columns from the dataframe. Ncsg|]}|vr|qSrrr"fieldsrrr'Rr-z/additional_column_validator..rcsg|]}|vr|qSrrr")acrrr'Ur-rz9 WARNING: Some of the additional columns/keys contain `z<` in their name. These will be ignored, and the column/key `z`` will be used instead. This could also result from a duplicate column/key in the provided file.zh - The input file should contain exactly two columns/keys per row. Additional columns/keys present are: z Remove additional columns/keys: cs|Sr/rxr9rrr [sz1additional_column_validator..necessary_fnadditional_columnr r r r )rr(r)rr:additional_columnsr r r warn_messagedupsr)r;r:radditional_column_validatorIs*   rCcsd}d}d}|dds|rG|dk|B}|j|}dd|}fdd}d t|d d }td |||d S)zA This validator will ensure that no completion is empty. NcSs|dkS)Nrrr<rrrnsz+non_empty_field_validator..rz - `z?` column/key should not contain empty strings. These are rows: cs||dkjgdS)Nrsubset)dropnar<fieldrrr ssz/non_empty_field_validator..necessary_fnRemove z rows with empty sempty_r?)applyanyisnull reset_indexindextolistrr)rrIr r r empty_rows empty_indexesrrHrnon_empty_field_validatorfs& rUcs|jd}|j|}d}d}d}t|dkr9dt|ddd|}dt|d }fd d }td |||d S)zY This validator will suggest to the user to remove duplicate rows if they exist. rENr - There are z duplicated -z sets. These are rows: rJz duplicate rowscs |jdS)NrE)drop_duplicatesr<r9rrr z.duplicated_rows_validator..optional_fnduplicated_rowsr r r r) duplicatedrPrQrRrjoinr)rr:rZduplicated_indexesr r rrr9rduplicated_rows_validators    r_cs|d}d}d}t|}|dkr6dd|tdkr6dtdd}d td }fd d }td |||dS)zW This validator will suggest to the user to remove examples that are too long. Nopen-ended generationcSs$|jdddd}|j|S)NcSst|jt|jdkS)Ni')rr6r7r<rrrrDr-zClong_examples_validator..get_long_indexes..)axis)rMrPrQrR)d long_examplesrrrget_long_indexessz1long_examples_validator..get_long_indexesrrVz. examples that are very long. These are rows: zf For conditional generation, and for classification the examples shouldn't be longer than 2048 tokens.rJz long examplescs8|}|krtjdt|d|d||S)NzeThe indices of the long examples has changed as a result of a previously applied recommendation. The z? long examples to be dropped are now at the following indices:  )sysstdoutwriterdrop)r=long_indexes_to_dropre long_indexesrrrs  z,long_examples_validator..optional_fnrdr[)infer_task_typerr)rr r rft_typerrlrlong_examples_validators"  rpc sld}d}d}d}dgd}|D]}|dkr |jjdr q|jjj|ddr,q|dd}t|}|d krBtd d Sd d t|jdd} |j| kr`d| d}td |dS| dkr| dd} d| d}t | dkr~|d|d7}|jjdt |  jj| ddr|d| d7}nd}| dkrd|d}fdd}td||||d S)!z This validator will suggest to add a common suffix to the prompt if one doesn't already exist in case of classification or conditional generation. Nz ### => ) ->z ### z === z --- z ===> z ---> rqrfFregex\nr` common_suffixr cS|d|7<|SNr6rr=suffixrrr add_suffixz2common_prompt_suffix_validator..add_suffixrzxfixzAll prompts are identical: `zt` Consider leaving the prompts blank if you want to do open-ended generation, otherwise ensure prompts are differentr rrz - All prompts end with suffix `r4 R. This suffix seems very long. Consider replacing with a shorter suffix, such as `z5 WARNING: Some of your prompts contain the suffix `zZ` more than once. We strongly suggest that you review your prompts and add a unique suffixa - Your data does not contain a common separator at the end of your prompts. Having a separator string appended to the end of the prompt makes it clearer to the fine-tuned model where the completion should begin. See https://platform.openai.com/docs/guides/fine-tuning/preparing-your-dataset for more detail and examples. If you intend to do open-ended generation, then you should leave the prompts emptyzAdd a suffix separator `z` to all promptscr.r/rr<r{suggested_suffixrrrr3z3common_prompt_suffix_validator..optional_fncommon_completion_suffixr r r rr) r6rcontainsrNreplacernrget_common_xfixallr) rrr r rsuffix_options suffix_optiondisplay_suggested_suffixrorucommon_suffix_new_line_handledrrrcommon_prompt_suffix_validators`        rcsd}d}d}d}t|jdddkrtddSdd |jkr(tddSdkrId d }|tkrI|d 7}d d}fdd}td|||dS)zd This validator will suggest to remove a common prefix from the prompt if a long one exist. Nprefixr}r common_prefixrvcSs|djt|d|d<|Srxrr)r=rrrrremove_common_prefixsz.remove_common_prefixz" - All prompts start with prefix `r4z. Fine-tuning doesn't require the instruction specifying the task, or a few-shot example scenario. Most of the time you should only add the input data into the prompt, and the desired output into the completionRemove prefix `z` from all promptscs |Sr/rr<rrrrr(r3z3common_prompt_prefix_validator..optional_fncommon_prompt_prefixr[)rr6rrrrMAX_PREFIX_LENr r rrrrcommon_prompt_prefix_validator s,     rcsd}t|jddtdkoddkt|kr tddSdd |jkr0tddSd d }d d }fdd}td|||dS)zh This validator will suggest to remove a common prefix from the completion if a long one exist. rr}r rrvcSs2|djt|d|d<|rd|d|d<|S)Nr7rr)r=r ws_prefixrrrr>sz@common_completion_prefix_validator..remove_common_prefixz& - All completions start with prefix `z_`. Most of the time you should only add the output data into the completion, without any prefixrz` from all completionscs |Sr/rr<rrrrrrLrYz7common_completion_prefix_validator..optional_fncommon_completion_prefixr[)rr7rrrrrrr"common_completion_prefix_validator3s"     rc s^d}d}d}d}t|}|dks|dkrtddSt|jdd}|j|kr6d|d |d }td|d Sd gd }|D]}|jjj|ddrLq>|dd} dd|dkr|dd} d| d }t |dkrw|d| d 7}|jjdt | jj|ddr|d|d7}nd}|dkrd| d}fdd}td||||d S)!z This validator will suggest to add a common suffix to the completion if one doesn't already exist in case of classification or conditional generation. Nr`classificationrurvrzr}z All completions are identical: `zJ` Ensure completions are different, otherwise the model will just repeat `r4rz [END]) rf.z ENDz***z+++z&&&z$$$z@@@z%%%FrrrfrtcSrwNr7rryrrrr{}r|z6common_completion_suffix_validator..add_suffixrz$ - All completions end with suffix `rrz9 WARNING: Some of your completions contain the suffix `zU` more than once. We suggest that you review your completions and add a unique endingaH - Your data does not contain a common ending at the end of your completions. Having a common ending string appended to the end of the completion makes it clearer to the fine-tuned model where the completion should end. See https://platform.openai.com/docs/guides/fine-tuning/preparing-your-dataset for more detail and examples.zAdd a suffix ending `z` to all completionscr.r/rr<rrrrr3z7common_completion_suffix_validator..optional_fnrr) rnrrr7rrrrNrr) rrr r rrorurrrrrrr"common_completion_suffix_validatorWsZ        rcCs\dd}d}d}d}|jjdddks |jjdddkr&d}d}|}td |||d S) z This validator will suggest to add a space at the start of the completion if it doesn't already exist. This helps with tokenization. cSs|ddd|d<|S)Nr7cSs|ddkr d|Sd|S)Nrrrrr<rrrrDszLcompletions_space_start_validator..add_space_start..)rMr<rrradd_space_startsz:completions_space_start_validator..add_space_startNrarrz - The completion should start with a whitespace character (` `). This tends to produce better results due to the tokenization we use. See https://platform.openai.com/docs/guides/fine-tuning/preparing-your-dataset for more detailsz=Add a whitespace character to the beginning of the completioncompletion_space_startr[)r7rnuniquevaluesr)rrr rr rrr!completions_space_start_validators,rcsnfdd}|dd}|dd}|d|kr5tddd d d d |d SdS)zt This validator will suggest to lowercase the column values, if more than a third of letters are uppercase. cs|j|<|Sr/r r<r%rr lower_casesz(lower_case_validator..lower_casecStdd|DS)Ncs$|] }|r|rdVqdSraN)isalphaisupperr"rrr "9lower_case_validator....sumr<rrrrDz&lower_case_validator..cSr)Ncsrr)rislowerr"rrrrrrrr<rrrrDrr8rz - More than a third of your `z%` column/key is uppercase. Uppercase zs tends to perform worse than a mixture of case encountered in normal language. We recommend to lower case the data if that makes sense in your domain. See https://platform.openai.com/docs/guides/fine-tuning/preparing-your-dataset for more detailsz'Lowercase all your data in column/key `r4r[N)rMrr)rr&r count_upper count_lowerrr%rlower_case_validators"     rc Cstd}d}d}d}d}tj|rTz|ds$|drI|dr-dnd\}}d|d}d|d }tj||td  d }n|d rqd }d}t |} | j } t | dkrf|d7}tj |td d }n|drd}d}t|d} | } tjdd| dD|td d }Wdn1swYn|drtj|dtd d }t |dkrd}d}tj|td d }na n_|drz"tj|dtd d }t |dkrtj|td d }nd }d}Wn4tytj|td d }Yn!wd!}d"|vr)|d#|d$|d"d%d&7}n|d#|d'7}Wn'ttfyS|d"d%}d(|d)|d*|d+}Ynwd,|d-}td.|||d/}||fS)0z This function will read a file saved in .csv, .json, .txt, .xlsx or .tsv format using pandas. - for .xlsx it will read the first sheet - for .txt it will assume completions and split on newline Nz.csvz.tsv)CSV,)TSV z= - Based on your file extension, your file is formatted as a z filez Your format `z` will be converted to `JSONL`)sepdtyperz.xlsxzH - Based on your file extension, your file is formatted as an Excel filez/Your format `XLSX` will be converted to `JSONL`raz - Your Excel file contains more than one sheet. Please either save as csv or ensure all data is present in the first sheet. WARNING: Reading only the first sheet...)rz.txtz9 - Based on your file extension, you provided a text filez.Your format `TXT` will be converted to `JSONL`rcSsg|]}d|gqS)rr)r#linerrrr'sz#read_any_format..rf)r(r.jsonlT)linesrz^ - Your JSONL file appears to be in a JSON format. Your file will be converted to JSONL formatz/Your format `JSON` will be converted to `JSONL`z.jsonz^ - Your JSON file appears to be in a JSONL format. Your file will be converted to JSONL formatz]Your file must have one of the following extensions: .CSV, .TSV, .XLSX, .TXT, .JSON or .JSONLrz Your file `z` ends with the extension `.z` which is not supported.z` is missing a file extension.z Your file `z!` does not appear to be in valid z9 format. Please ensure your file is formatted as a valid z file.zFile z does not exist.read_any_format)r r r r)rospathisfiler!endswithpdread_csvrfillna ExcelFile sheet_namesr read_excelopenread DataFramesplit read_json ValueError TypeErrorupperr) fnamer: remediationr r rrfile_extension_str separatorxlssheetsfcontentrrrrs        " rcCs,t|}d}|dkrd|d}td|dS)z This validator will infer the likely fine-tuning format of the data, and display it to the user if it is classification. It will also suggest to use ada and explain train/validation split benefits. NrzK - Based on your data it seems like you're trying to fine-tune a model for z - For classification, we recommend you try one of the faster and cheaper models, such as `ada` - For classification, you can estimate the expected model performance by keeping a held out dataset, which is not used for trainingrr)rnr)rror rrrformat_inferrer_validator7s   rcCsb|jdurtjd|jd|jdtd|jdur%tj|j|jdur/||}|S)zs This function will apply a necessary remediation to a dataframe, or print an error message if one exists. Nz ERROR in z validator: z Aborting...ra) rrgstderrrir exitr rhr )rrrrrapply_necessary_remediationCs     rcCs.tj||rtjddStdkS)NzY Tn)rgrhriinputr!) input_text auto_acceptrrraccept_suggestionSs  rcCs\d}d|jd}|jdurt||r||}d}|jdur*tjd|jd||fS)zc This function will apply an optional remediation to a dataframe, based on the user input. Fz- [Recommended] z [Y/n]: NTz- [Necessary] rf)r rrr rgrhri)rrroptional_appliedrrrrapply_optional_remediation[s    rcCsjt|}d}|dkrt|}|d}n |jdd}|d}dd}||d }tjd |d d S) z? Estimate the time it'll take to fine-tune the dataset g?rg ףp= ?T)rQg|?5^?cSsd|dkr t|ddS|dkrt|dddS|dkr(t|dddSt|dddS) N<r8z secondsiz minutesiQz hoursz days)round)timerrr format_timewsz.estimate_fine_tuning_time..format_timez:Once your model starts training, it'll approximately take z~ to train a `curie` model, and less for `ada` and `babbage`. Queue will approximately take half an hour per job ahead of you. N)rnr memory_usagerrgrhri)r ft_format expected_timersizer time_stringrrrestimate_fine_tuning_timejs   rcsd|rddgndg}d} |dkrd|dndfdd |D}td d |Ds-|S|d 7}q ) N_train_validrrTz ()cs,g|]}tjdd|dqS)r _preparedr)rrsplitext)r#rzr index_suffixrrr'sz!get_outfnames..css|] }tj|VqdSr/)rrr)r#rrrrrsz get_outfnames..ra)rN)rrsuffixesicandidate_fnamesrrr get_outfnamess rcCs.|j}d}|dkr|jjd}||fS)Nr8r)r7r value_countsrQ)r n_classes pos_classrrrget_classification_hyperparamss rc Cs~t|}t|jdd}t|jdd}d}d}|dkr!t||r!d}d} |dd } |dd } t| d kr;d | d nd} d }|s\|s\tj d|d| d| d| d t |d*St||r7t ||} |rt| dkr{d| d vr{d| dvs}Jd}t t||t t|d}|j|dd}||j}|ddgj| d dddd|ddgj| dddddt|\}}| d7} |dkr| d|d7} n| d |7} nt| dksJ|ddgj| d dddd|rd!ndd"d#| }|rd$| ddnd}t| d krdnd%| d}tj d&|d'| d d|| d(|| d t |d*Stj d)d*S)+aQ This function will write out a dataframe to a file, if the user would like to proceed, and also offer a fine-tuning command with the newly created file. For classification it will optionally ask the user if they would like to split the data into train/valid files, and modify the suggested command to include the valid set. rzr}FzQ- [Recommended] Would you like to split into training and validation set? [Y/n]: rTrrfrtrz Make sure to include `stop=["z;"]` so that the generated texts ends at the expected place.z@ Your data will be written to a new JSONL file. Proceed [Y/n]: zK You can use your file for fine-tuning: > openai api fine_tunes.create -t ""ue After you’ve fine-tuned a model, remember that your prompt has to end with the indicator string `zX` for the model to start generating completions, rather than continuing with the prompt.r8trainvalidraig?*)r random_stater6r7records)rorient force_asciiz! --compute_classification_metricsz" --classification_positive_class "z --classification_n_classes rKz to `z` and `z -v "ucAfter you’ve fine-tuned a model, remember that your prompt has to end with the indicator string `z Wrote modified filezd` Feel free to take a look! Now use that file when fine-tuning: > openai api fine_tunes.create -t "z z#Aborting... did not write the file N)rnrr6r7rrrrgrhrirrmaxintsamplerjrQto_jsonrr])rrany_remediationsrrcommon_prompt_suffixrrradditional_params%common_prompt_suffix_new_line_handled)common_completion_suffix_new_line_handledoptional_ending_stringfnamesMAX_VALID_EXAMPLESn_traindf_traindf_validrr files_string valid_stringseparator_reminderrrrwrite_out_filesr       (         ( rcCs>d}t|jjdkrdSt|jt||krdSdS)z> Infer the likely fine-tuning task type from the data rr`rzconditional generation)rr6rrr7unique)rCLASSIFICATION_THRESHOLDrrrrns rnrzcCsnd} |dkr|jt|d dn |jdt|d}|dkr' |S||jdkr1 |S|jd}q)zQ Finds the longest common suffix or prefix of all the values in a series rTrzraNr)rrrr)seriesr~ common_xfix common_xfixesrrrrs  rcCs2tddddtttttddddtttt t gS)NcS t|dSrxr5r<rrrrD z get_validators..cSr%rr&r<rrrrDr'cSr%rxrr<rrrrDr'cSr%rr(r<rrrrDr') rrCrUrr_rprrrrrrrrrget_validatorss r)c Csg}|dur |||D]}||}|dur!||t||}q tdd|D}tdd|D} d} |rPtjd|D]}t|||\}} | pM| } q@ntjd| pY| } |||| |dS)NcSs$g|]}|jdus|jdur|qSr/)r r r#rrrrr'6s   z$apply_validators..cSsg|] }|jdur|qSr/)r r*rrrr'>s  Fz? Based on the analysis we will perform the following actions: z No remediations found. )appendrrNrgrhrir) rrr validatorsrwrite_out_file_funcoptional_remediations validator&any_optional_or_necessary_remediationsany_necessary_appliedany_optional_appliedr!any_optional_or_necessary_appliedrrrapply_validators$sB     r4)r7)rz)%rrgtypingrrrropenai.datalib.pandas_helperrrrrrr5rCrUr_rprrrrrrrrrrrrrrrrnrr)r4rrrrs>   & (L'$L\ M