o eM@sLddlmZddlZddlZddlZddlZddlZddlZddlm Z m Z ddl m Z ddl mZddlmZmZddlZddlZddlmZddlmZmZddlZddlmZdd lmZerhdd lmZed Gd d d e Z eGddde Z!eGddde Z"eGddde Z#Gddde#Z$GdddZ%dS)) annotationsN)ABCabstractmethod) OrderedDict)Path) TYPE_CHECKINGAny)utils)documentset_documentation_group)warn_deprecation) IOComponentZflaggingc@s2eZdZdZedddZe  ddddZd S)FlaggingCallbackz[ An abstract class for defining the methods that any FlaggingCallback should have. componentslist[IOComponent] flagging_dirstrcCdS)a This method should be overridden and ensure that everything is set up correctly for flag(). This method gets called once at the beginning of the Interface.launch() method. Parameters: components: Set of components that will provide flagged data. flagging_dir: A string, typically containing the path to the directory where the flagging file should be storied (provided as an argument to Interface.__init__()). Nselfrrrr?D:\Projects\ConvertPro\env\Lib\site-packages\gradio/flagging.pysetup"s zFlaggingCallback.setupN flag_data list[Any] flag_optionusername str | NonereturnintcCr)a This method should be overridden by the FlaggingCallback subclass and may contain optional additional arguments. This gets called every time the button is pressed. Parameters: interface: The Interface object that is being used to launch the flagging interface. flag_data: The data to be flagged. flag_option (optional): In the case that flagging_options are provided, the flag option that is being used. username (optional): The username of the user that is flagging the data, if logged in. Returns: (int) The total number of samples that have been flagged. Nr)rrrrrrrflag-szFlaggingCallback.flagrrrrrNrrrrrrrr )__name__ __module__ __qualname____doc__rrr!rrrrrs  rc@2eZdZdZddZddd Z ddddZd S)SimpleCSVLoggera A simplified implementation of the FlaggingCallback abstract class provided for illustrative purposes. Each flagged sample (both the input and output data) is logged to a CSV file on the machine running the gradio app. Example: import gradio as gr def image_classifier(inp): return {'cat': 0.3, 'dog': 0.7} demo = gr.Interface(fn=image_classifier, inputs="image", outputs="label", flagging_callback=SimpleCSVLogger()) cCdSNrrrrr__init__PzSimpleCSVLogger.__init__rrr str | PathcC||_||_tj|dddSNT)exist_okrrosmakedirsrrrrrSszSimpleCSVLogger.setuprNrrrrrrrr c Cs|j}t|d}g}t|j|D]\}}t|t|jpd} |||| dqt |ddd} t | } | t |Wdn1sKwYt |} ttt | d} Wd| S1skwY| S)Nlog.csvra)newline)rrzipr client_utils!strip_invalid_filename_characterslabelappend deserializeopencsvwriterwriterowr sanitize_list_for_csvlenlistreader) rrrrr log_filepathcsv_data componentsamplesave_dircsvfilerC line_countrrrr!Xs4    zSimpleCSVLogger.flagrrrr0r#r$r%r&r'r(r.rr!rrrrr*Bs r*c@r)) CSVLoggera The default implementation of the FlaggingCallback abstract class. Each flagged sample (both the input and output data) is logged to a CSV file with headers on the machine running the gradio app. Example: import gradio as gr def image_classifier(inp): return {'cat': 0.3, 'dog': 0.7} demo = gr.Interface(fn=image_classifier, inputs="image", outputs="label", flagging_callback=CSVLogger()) Guides: using-flagging cCr+r,rr-rrrr.r/zCSVLogger.__init__rrrr0cCr1r2r4rrrrrszCSVLogger.setuprNrrrrrrrr cCs|j}t|d}t| }ddt|jDgd}g}tt|j|D]5\} \} } t|tt| ddp=d| } t | rM| t | q(| | durZ| j | | dndq(| || |durk|nd| t tjt|d dd d } t| }|r|t ||t |Wdn1swYt|d d } ttt| d }Wd|S1swY|S)Nr7cSs&g|]\}}t|ddpd|qS)r>N component )getattr).0idxrKrrr sz"CSVLogger.flag..)r!r timestampr>rS)rMrr8utf-8r9encodingr[r:)rrexists enumeraterr;r<r=rTr Z is_updater?rr@datetimenowrArBrCrDrErFrGrH)rrrrrrIis_newheadersrJrVrKrLrMrNrCrOrrrr!sN      zCSVLogger.flagrPr#r$rQrrrrrRws  rRc@s|eZdZdZ     d1d2ddZd3ddZ  d4d5ddZ  d6d7d$d%Zed8d)d*Z ed9d+d,Z  d6d:d/d0Z dS);HuggingFaceDatasetSavera A callback that saves each flagged sample (both the input and output data) to a HuggingFace dataset. Example: import gradio as gr hf_writer = gr.HuggingFaceDatasetSaver(HF_API_TOKEN, "image-classification-mistakes") def image_classifier(inp): return {'cat': 0.3, 'dog': 0.7} demo = gr.Interface(fn=image_classifier, inputs="image", outputs="label", allow_flagging="manual", flagging_callback=hf_writer) Guides: using-flagging NFdataset_info.jsonThf_tokenr dataset_name organizationrprivatebool info_filename separate_dirsverbosecCs2|durtd||_||_||_||_||_dS)a; Parameters: hf_token: The HuggingFace token to use to create (and write the flagged sample to) the HuggingFace dataset (defaults to the registered one). dataset_name: The repo_id of the dataset to save the data to, e.g. "image-classifier-1" or "username/image-classifier-1". organization: Deprecated argument. Please pass a full dataset id (e.g. 'username/dataset_name') to `dataset_name` instead. private: Whether the dataset should be private (defaults to False). info_filename: The name of the file to save the dataset info (defaults to "dataset_infos.json"). separate_dirs: If True, each flagged item will be saved in a separate directory. This makes the flagging more robust to concurrent editing, but may be less convenient to use. NzParameter `organization` is not used anymore. Please pass a full dataset id (e.g. 'username/dataset_name') to `dataset_name` instead.)r re dataset_iddataset_privaterjrk)rrerfrgrhrjrkrlrrrr.s z HuggingFaceDatasetSaver.__init__rrrc Cstj|j|j|jdddj|_|jrdnd}tj|jdddd|d gd gid|jd ||_t | |j d d |_ |j j ddd|j |j|_|jg}|jsY|d|D]}ztj|jd||j |jdWq[tjjywYq[wdS)z Params: flagging_dir (str): local directory where the dataset is cloned, updated, and pushed from. datasetT)repo_idtokenrh repo_typer3z **/*.jsonldata.csvZconfigsdefaulttrain)splitpath)Z config_nameZ data_files)rprrmetadata overwriterq/parentsr3)rprrfilenameZ local_dirrqN)huggingface_hubZ create_repormrernrprkZmetadata_updaterrabsoluterv dataset_dirmkdirrj infos_filer?Zhf_hub_downloadr ZEntryNotFoundError)rrr path_globZ remote_filesr~rrrrsV   zHuggingFaceDatasetSaver.setuprrrrrrr cCsV|jrtt}|j|}|d}|}n |j}|d}d}|j||||||p(ddS)Nzmetadata.jsonlrsr) data_filecomponents_dir path_in_reporrr)rkruuiduuid4r _flag_in_dir)rrrr unique_idrrrrrrr!%s   zHuggingFaceDatasetSaver.flagrrrrc CsX|||||\}}tt|jd)|js6|jtdd|iit j |j d|j |jj |jdWdn1s@wYt|} |jst|d&|j|| |d} t| } t j|j dd| |d||j d Wd| S1s~wY| S|j|| |d} td d |jD} t j|j dd| |d||j d | S) Nz.lockZflaggedfeaturesro)rprrrqrZpath_or_fileobj)rbrowzFlagged sample #z*.lock)rprrZcommit_messagerignore_patternsZ folder_pathrqcSsg|]}|r|qSr)is_dir)rUrwrrrrWosz8HuggingFaceDatasetSaver._flag_in_dir..)_deserialize_componentsfilelockZFileLockrrr] write_textjsondumpsrZ upload_filermrenamerGkeysrk _save_as_csvZ upload_folder_save_as_jsonlrFriterdir) rrrrrrrrrrbZ sample_nbZ sample_namerrrr@sb     z$HuggingFaceDatasetSaver._flag_in_dirrb list[str]rcCs| }|jdddd}t|}|r|t||t|Wdn1s/wY|jdd}tddt|Dd WdS1sSwYdS) z9Save data as CSV and return the sample name (row number).r8rrYrZNr\css|]}dVqdS)r:Nr)rU_rrr sz7HuggingFaceDatasetSaver._save_as_csv..r:) r]rArBrCrDr rEsumrH)rrbrrarNrCrrrr}s   $z$HuggingFaceDatasetSaver._save_as_csvcCs`tj|jdddt|d}ttt|||Wd|jjS1s'wY|jjS)z5Save data as JSONL and return the sample name (uuid).Tr|wN) rrparentrArdumpdictr;r)rrbrfrrrrs  z&HuggingFaceDatasetSaver._save_as_jsonldata_dir tuple[dict[Any, Any], list[Any]]c Cstjdtjdi}t}g}t|j|D]\}} |jpd} |t| } | | | d} ddd|| <zt |  s:J| t t | |jWntttfyc| durXdnt | } | | Ynwt|t|r|D]\} }t|| rd|i|| d <nqo| rt t | |jd d }| tj|j|d d q| dqddd|d<ddd|d<| || |||fS)zDeserialize components and return the corresponding row for the flagged sample. Images/audio are saved to disk as individual files. AudioImagerNstringValue)Zdtype_typerz file\rzro)rpr~rrr!r)grrrrr;rr>r<r=r@rr]r?r relative_torAssertionError TypeError ValueError isinstancetupleitemsreplacerZ hf_hub_urlrm)rrrrrZfile_preview_typesrrrKrLr>rMZ deserializedZ _componentrrrrrrsV      z/HuggingFaceDatasetSaver._deserialize_components)NFrdFT)rerrfrrgrrhrirjrrkrirlrir"r#r$)rr)rrrrrrrrrrrrrr )rrrbrrrrr )rrrbrrrrr) rrrrrrrrrr) r%r&r'r(r.rr!r staticmethodrrrrrrrrcs, ; ! =   rccs(eZdZ    ddfdd ZZS)HuggingFaceDatasetJSONSaverNFrdTrerrfrgrrhrirjrlcs$tdtj|||||dddS)NzCallback `HuggingFaceDatasetJSONSaver` is deprecated in favor of using `HuggingFaceDatasetSaver` and passing `separate_dirs=True` as parameter.T)rerfrgrhrjrk)r superr.)rrerfrgrhrjrl __class__rrr.s  z$HuggingFaceDatasetJSONSaver.__init__)NFrdT) rerrfrrgrrhrirjrrlri)r%r&r'r. __classcell__rrrrrs rc@s0eZdZdZ ddd d ZdddZddZdS) FlagMethodz Helper class that contains the flagging options and calls the flagging method. Also provides visual feedback to the user when flag is clicked. Tflagging_callbackrr>rvaluevisual_feedbackricCs"||_||_||_d|_||_dS)NFlag)rr>rr%r)rrr>rrrrrr.s  zFlagMethod.__init__request gr.Requestc Gsz|jjt||j|jdWn#ty2}ztd||jr(WYd}~dSWYd}~nd}~ww|js8dSt d| S)N)rrzError while flagging: zError!g?) rr!rGrr Exceptionprintrtimesleepreset)rrrerrr__call__s   zFlagMethod.__call__cCstjj|jddS)NT)r interactive)rZButtonupdater>r-rrrr szFlagMethod.resetN)T)rrr>rrrrri)rr)r%r&r'r(r.rrrrrrrs  r)& __future__rrBr_rr5rrabcrr collectionsrpathlibrtypingrrrrZ gradio_clientr r<Zgradio_client.documentationr r ZgradiorZgradio.deprecationr Zgradio.componentsr rr*rRrcrrrrrrs@       %4I