o e@szdZddlmZddlZddlZddlZddlZddlZddlm Z m Z m Z m Z ddl mZmZddlmZmZmZmZddlmZddlmZmZmZmZmZmZmZmZdd l m!Z!dd l"m#Z#dd l$m%Z%m&Z&m'Z'dd l(m)Z)m*Z*m+Z+dd l,m-Z-m.Z.m/Z/m0Z0ddl1m2Z2ddl3m4Z5ede rddl6m7Z7edddddGdddeZ8eGdddeZ9d"d#d d!Z:dS)$zk This file defines two useful high-level abstractions to build Gradio apps: Interface and TabbedInterface. ) annotationsN) TYPE_CHECKINGAnyCallableLiteral)documentset_documentation_group)Examplesexternalinterpretationutils)Blocks)Button ClearButtonDuplicateButtonInterpretation IOComponentMarkdownStateget_component_instance)InterfaceTypeswarn_deprecation) Changeable Streamable Submittable) CSVLoggerFlaggingCallback FlagMethod)ColumnRowTabTabs)load_from_pipeline) ThemeClass interface)PipelineZlaunchload from_pipelineZ integratequeuecs&eZdZUdZeZded<eduddZ e   dvdwddZ edxddZ ddddddddddddddde ddddddfdyfdAdB Z dzdDdEZd{dGdHZd|dJdKZd}dOdPZdQdRZd~fdUdV Zdd\d]ZddadbZddedfZdgdhZdidjZdkdlZdmdnZddqdrZdzdsdtZZS) Interfaceak Interface is Gradio's main high-level class, and allows you to create a web-based GUI / demo around a machine learning model (or any Python function) in a few lines of code. You must specify three parameters: (1) the function to create a GUI for (2) the desired input components and (3) the desired output components. Additional parameters can be used to control the appearance and behavior of the demo. 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") demo.launch() Demos: hello_world, hello_world_3, gpt2_xl Guides: quickstart, key-features, sharing-your-app, interface-state, reactive-interfaces, advanced-interface-features, setting-up-a-gradio-demo-for-maximum-performance zweakref.WeakSet instancesreturnlist[Interface]cCs ttjS)z9 :return: list of all current instances. )listr*r+)clsr0@D:\Projects\ConvertPro\env\Lib\site-packages\gradio/interface.py get_instancesBs zInterface.get_instancesNnamestrsrc str | Noneapi_keyaliasr cKs"tdtjd||||d|S)a Warning: this method will be deprecated. Use the equivalent `gradio.load()` instead. This is a class method that constructs a Blocks from a Hugging Face repo. Can accept model repos (if src is "models") or Space repos (if src is "spaces"). The input and output components are automatically loaded from the repo. Parameters: name: the name of the model (e.g. "gpt2" or "facebook/bart-base") or space (e.g. "flax-community/spanish-gpt2"), can include the `src` as prefix (e.g. "models/facebook/bart-base") src: the source of the model: `models` or `spaces` (or leave empty if source is provided as a prefix in `name`) api_key: optional access token for loading private Hugging Face Hub models or spaces. Find your token here: https://huggingface.co/settings/tokens. Warning: only provide this if you are loading a trusted private Space as it can be read by the Space you are loading. alias: optional string used as the name of the loaded model instead of the default name (only applies if loading a Space running Gradio 2.x) Returns: a Gradio Interface object for the given model z>gr.Interface.load() will be deprecated. Use gr.load() instead.)r3r5Zhf_tokenr8Nr0)rr r')r/r3r5r7r8kwargsr0r0r1r'IszInterface.loadpipeliner&cKs*t|}t|fi|}|di|}|S)a# Class method that constructs an Interface from a Hugging Face transformers.Pipeline object. The input and output components are automatically determined from the pipeline. Parameters: pipeline: the pipeline object to use. Returns: a Gradio Interface object from the given Pipeline Example: import gradio as gr from transformers import pipeline pipe = pipeline("image-classification") gr.Interface.from_pipeline(pipe).launch() Nr0)r#dict)r/r:r9Zinterface_infor%r0r0r1r(fszInterface.from_pipeline Fg@ZflaggedZpredictfnrinputs2str | IOComponent | list[str | IOComponent] | Noneoutputsexamples(list[Any] | list[list[Any]] | str | Nonecache_examples bool | Noneexamples_per_pageintliveboolr Callable | str | Nonenum_shapfloattitle descriptionarticle thumbnailthemeTheme | str | Nonecssallow_flaggingflagging_options(list[str] | list[tuple[str, str]] | None flagging_dirflagging_callbackranalytics_enabledbatchmax_batch_sizeapi_namestr | Literal[False] | None _api_modeallow_duplicationc5 sztjd-|d|| p d|d|||_t|trtdtj|_|dus)|gkr5|dus1|gkr5t d|dus=|gkrDg}tj |_n|dusL|gkrRg}tj |_t|t tt fs\Jt|t tt fsfJt|tsn|g}t|tsv|g}|jr|durd|_n|pd|_d d t|D}d d t|D}t|d krt|d krnAt|d kst|d krt d|d }|d }||dkrt||}t|d} n||} | ||<| ||<|rtdd|_dd |D|_dd |D|_|j|jD]}!t|!t s t |!dqt|jt|jkr,dd t|j|jD}"t|"r,tj|_|jtjtj fvrN|jD]}#t|#t sCJ|#jdurLd|#_q9dus^tts^trb|_ntt rtfdd |jD|_nt d||_||_ d d g|_!t"|dd|_#||_$| |_%t&| |_'| |_(| durt)| } | |_*| |_+||_,| |_-||_.d|_/|durt01dd}|durtdd|_2n-|dkrd|_2n$|durtdd|_2n|dkrd|_2n |dkrd|_2nt d |durd!g|_3n/t|tst d"td#d$|Dr"d%d |D|_3ntd&d$|Dr0||_3nt d"||_4||_5||_6||_7||_8d|_9d|_:d|_;d|_?|t@|j }$tAB|j d }%t|%d krwtAC|j rw|%d d}%|%DD]}&tE|&|$r|%F|&q{t|j|%D]\}!}&t|!t sJ|!jGdur|&|!_Gqt|jD]&\}'}!t|!t sJ|!jGdurt|jd krd'|!_Gqd(|'|!_Gq|j2dkr|jtjks|j2dkr|j4H|j|j5n|jtj krn |j4H|j|j|j5||Id)\}(})}*}+},d*\}-}.d*\}/}0tJdd+H|jtjtj tjfvr8|K\}(})}*}+}/}0}.|jtjtj fvra|L|(\}1}2},}3}4}-|(pQ|1}(|)pV|2})|*p[|3}*|+p`|4}+Wdn 1slwY|)duszJd,|M|(|*|N|)|/|0|,dur|,O|P|-|.|/|0|Q|+|)|R|SWdn 1swY|T|_UdS).aH Parameters: fn: the function to wrap an interface around. Often a machine learning model's prediction function. Each parameter of the function corresponds to one input component, and the function should return a single value or a tuple of values, with each element in the tuple corresponding to one output component. inputs: a single Gradio component, or list of Gradio components. Components can either be passed as instantiated objects, or referred to by their string shortcuts. The number of input components should match the number of parameters in fn. If set to None, then only the output components will be displayed. outputs: a single Gradio component, or list of Gradio components. Components can either be passed as instantiated objects, or referred to by their string shortcuts. The number of output components should match the number of values returned by fn. If set to None, then only the input components will be displayed. examples: sample inputs for the function; if provided, appear below the UI components and can be clicked to populate the interface. Should be nested list, in which the outer list consists of samples and each inner list consists of an input corresponding to each input component. A string path to a directory of examples can also be provided, but it should be within the directory with the python file running the gradio app. If there are multiple input components and a directory is provided, a log.csv file must be present in the directory to link corresponding inputs. cache_examples: If True, caches examples in the server for fast runtime in examples. If `fn` is a generator function, then the last yielded value will be used as the output. The default option in HuggingFace Spaces is True. The default option elsewhere is False. examples_per_page: If examples are provided, how many to display per page. live: whether the interface should automatically rerun if any of the inputs change. interpretation: function that provides interpretation explaining prediction output. Pass "default" to use simple built-in interpreter, "shap" to use a built-in shapley-based interpreter, or your own custom interpretation function. For more information on the different interpretation methods, see the Advanced Interface Features guide. num_shap: a multiplier that determines how many examples are computed for shap-based interpretation. Increasing this value will increase shap runtime, but improve results. Only applies if interpretation is "shap". title: a title for the interface; if provided, appears above the input and output components in large font. Also used as the tab title when opened in a browser window. description: a description for the interface; if provided, appears above the input and output components and beneath the title in regular font. Accepts Markdown and HTML content. article: an expanded article explaining the interface; if provided, appears below the input and output components in regular font. Accepts Markdown and HTML content. thumbnail: path or url to image to use as display image when the web demo is shared on social media. theme: Theme to use, loaded from gradio.themes. css: custom css or path to custom css file to use with interface. allow_flagging: one of "never", "auto", or "manual". If "never" or "auto", users will not see a button to flag an input and output. If "manual", users will see a button to flag. If "auto", every input the user submits will be automatically flagged (outputs are not flagged). If "manual", both the input and outputs are flagged when the user clicks flag button. This parameter can be set with environmental variable GRADIO_ALLOW_FLAGGING; otherwise defaults to "manual". flagging_options: if provided, allows user to select from the list of options when flagging. Only applies if allow_flagging is "manual". Can either be a list of tuples of the form (label, value), where label is the string that will be displayed on the button and value is the string that will be stored in the flagging CSV; or it can be a list of strings ["X", "Y"], in which case the values will be the list of strings and the labels will ["Flag as X", "Flag as Y"], etc. flagging_dir: what to name the directory where flagged data is stored. flagging_callback: An instance of a subclass of FlaggingCallback which will be called when a sample is flagged. By default logs to a local CSV file. analytics_enabled: Whether to allow basic telemetry. If None, will use GRADIO_ANALYTICS_ENABLED environment variable if defined, or default to True. batch: If True, then the function should process a batch of inputs, meaning that it should accept a list of input values for each parameter. The lists should be of equal length (and be up to length `max_batch_size`). The function is then *required* to return a tuple of lists (even if there is only 1 output component), with each list in the tuple corresponding to one output component. max_batch_size: Maximum number of inputs to batch together if this is called from the queue (only relevant if batch=True) api_name: Defines how the endpoint appears in the API docs. Can be a string, None, or False. If False or None, the endpoint will not be exposed in the api docs. If set to a string, the endpoint will be exposed in the api docs with the given name. Default value is "predict". allow_duplication: If True, then will show a 'Duplicate Spaces' button on Hugging Face Spaces. r%Gradio)rYmoderSrMrQzThe `fn` parameter only accepts a single function, support for a list of functions has been deprecated. Please use gradio.mix.Parallel instead.Nz2Must provide at least one of `inputs` or `outputs`TFcS&g|]\}}|dkst|tr|qSstate isinstancer).0idxir0r0r1  z&Interface.__init__..cSrbrcre)rgrhor0r0r1rjrkrzMIf using 'state', there must be exactly one state input and one state output.rd)valuez\Cache examples cannot be used with state inputs and outputs.Setting cache_examples to False.cSg|]}t|ddqSF)renderrrgrir0r0r1rj cSrorprr)rgrlr0r0r1rjrtz5 is not a valid input/output component for Interface.cSsg|]\}}||uqSr0r0)rgrirlr0r0r1rjrtcsg|]}qSr0)lower)rg_r r0r1rjsz+Invalid value for parameter: interpretation__name__r>ZGRADIO_ALLOW_FLAGGINGmanualzThe `allow_flagging` parameter in `Interface` nowtakes a string value ('auto', 'manual', or 'never'), not a boolean. Setting parameter to: 'manual'.zThe `allow_flagging` parameter in `Interface` nowtakes a string value ('auto', 'manual', or 'never'), not a boolean. Setting parameter to: 'never'.neverautozSInvalid value for `allow_flagging` parameter.Must be: 'auto', 'manual', or 'never'.)FlagzNflagging_options must be a list of strings or list of (string, string) tuples.cs|]}t|tVqdSN)rfr4rgxr0r0r1 ^z%Interface.__init__..cSsg|] }d||fqS)zFlag as r0rr0r0r1rj_scsr~r)rftuplerr0r0r1r`routputzoutput NNNNNNN)Z equal_heightzClear button not renderedr0)Vsuper__init__r\rfr.DeprecationWarningrSTANDARDinterface_type ValueError INPUT_ONLY OUTPUT_ONLYr4rZspace_idrD enumeratelenr Zget_default_argsrwarningswarninput_componentsoutput_componentszipallUNIFIED interactivecallabler api_moder>Z fn_durationsgetattrrxrHrMZremove_html_tagsZsimple_descriptionrNZreadme_to_htmlrOrPrBrKrFZ simple_serverosgetenvrTrUrXrWrZr[r_shareZ share_urlZ local_urlZ favicon_pathr*r+addget_type_hintsinspectgetfullargspecismethodcopyZis_special_typed_parameterremovelabelsetuprender_title_descriptionr render_input_columnrender_output_columnattach_submit_eventsattach_clear_eventsactivateattach_interpretation_eventsattach_flagging_eventsrender_examplesrender_articleZget_config_fileconfig)5selfr>r?rArBrDrFrHr rKrMrNrOrPrQrSrTrUrWrXrYrZr[r\r^r_r9Zstate_input_indexesZstate_output_indexesZstate_input_indexZstate_output_indexdefaultZstate_variable componentZsame_componentsrlZ param_typesZ param_names param_nameri submit_btn clear_btnstop_btn flag_btns duplicate_btninterpretation_btninterpretation_setinput_component_columninterpret_component_columnZsubmit_btn_outZclear_btn_2_outZstop_btn_2_outZ flag_btns_out __class__rwr1rzs8                                                     @zInterface.__init__NonecCs0|jr td|jd|jrt|jdSdS)N4



)rMrrNrr0r0r1rs z"Interface.render_title_description list[Button]cCsdd|jDS)NcSsg|]\}}t|qSr0)r)rgrrvr0r0r1rjsz.Interface.render_flag_btns..)rUrr0r0r1render_flag_btnsszInterface.render_flag_btnstuple[Button | None, ClearButton | None, Button | None, list[Button] | None, Column, Column | None, list[Interpretation] | None]c Csd\}}}}d\}}tddt}||jD]}|qWdn1s*wY|jrXtdd}g}||jD] }|t|q?Wdn1sSwYtg|jtj tj fvrt }|j st ddd}t|js}t|jrt d d dd }n6|jtjkrt }t ddd}t|jst|jr|j st d d d}|jd kr|}n|jd kr|g}Wdn1swYWdn1swY|||||||fS)N)NNNNrpanelvariantFvisibleZSubmitprimaryStopstoprrryr{)rrrqr appendrr rrrrrrHrrisgeneratorfunctionr>isasyncgenfunctionrrTr) rrrrrrrrrr0r0r1rst                )zInterface.render_input_column submit_btn_in Button | Nonedtuple[Button | None, ClearButton | None, DuplicateButton, Button | None, list | None, Button | None]c Cs0|}d\}}}}}tddz|jD] }t|ts|qtX|jtjkrGt }t ddd}t |j s=t |j rG|jsGt dddd }|jd krQ|}n|jd kra|dus^Jd |g}|jrht d }|jrrtdddd}Wdn1s|wYWdn1swY||||||fS)NrrrZGeneraterrrFrryr{Submit button not renderedZ InterpretrmZlg)scalesizeZ _activate)rrrfrrqr rrrrrrrr>rrHrTrr r_r) rrrrrrrrrr0r0r1r"sL           zInterface.render_output_columncCs|jr t|jdSdSr)rOrrr0r0r1r]szInterface.render_articlerrc s|jro|jtjkr3dusJdt|jd|jj|jd|j|j |j |j |j |j ddS|j D]6}t|trT|jrT|j|j|j |j|j |j |j dq6t|trl|j|j|j |j|j |j |j dq6dSduswJd|j}g}jgdd|j D}g}rg}dd}t|D]=\} } | fdd dgd d j|j|j |j| d kr|j ndd |j |j |j |j d } || | j|d|d d qj|dg|d ddSt|D]#\} } || ||j |j| d kr|j ndd |j |j |j |j d qdS)Nr)r\ preprocess postprocessrZr[)r\rrcSsg|] }t|tr|jqSr0)rfrsubmit)rgrr0r0r1rjs z2Interface.attach_submit_events..cSstjddtjddgS)NTrFrupdater0r0r0r1cleanupsz/Interface.attach_submit_events..cleanupcsjddjddfSNFrT)rr0rrr0r1s  z0Interface.attach_submit_events..F)r?rAr)rT)r\Zscroll_to_outputrrrZr[)r?rAZcancelsr))rHrrrrr'r>rclickr\rrZr[rrfrZ streamingstreamrZchangerZthenr) rrrrr>Z extra_outputtriggersZpredict_eventsrritriggerZ predict_eventrrr1ras       zInterface.attach_submit_eventsrrr Column | Nonerc Cs||j|j|jdg|r|gng|jr|gngdt|jtj tj tj fvr0t j ddgng|jr;t j ddgngdddS)Nz() => TrFz )Z_js)rrrrr jsondumpsrrrrrrr)rrrrr0r0r1rs(  zInterface.attach_clear_eventsrrlist[Interpretation] | NonecCs4|r|j|j|j|j|pg||gdddSdS)NF)r?rAr)rinterpret_funcrr)rrrrrr0r0r1rs  z&Interface.attach_interpretation_eventsrlist[Button] | NonecCs|r |jtjtjtjfvsdS|jdkr,t|jdddd}|dj||j dddddS|jtjkr6|j }n|j |j }t ||j D]3\}\}}t |tsOJt|j||}|jddd|dd |j|||ddd|j|jd|dd qBdS) Nr{r}F)Zvisual_feedbackr)r?rArr)cSstjdddS)Nz Saving...F)rnrrr0r0r0r1rsz2Interface.attach_flagging_events..)r))rrrrrrTrrXrrrrrUrfr4reset)rrrZ flag_methodZflag_componentsZflag_btnrrnr0r0r1rs^    z Interface.attach_flagging_eventsc CsT|jr(dd|jD}dd|jD}t|j|||j|j|j|j|jd|_ dSdS)NcSg|] }t|ts|qSr0rergcr0r0r1rj3  z-Interface.render_examples..cSrr0rerr0r0r1rj6r)rBr?rAr>rDrFr^rZ) rBrrr r>rDrFrrZZexamples_handler)rZnon_state_inputsZnon_state_outputsr0r0r1r1s$ zInterface.render_examplescCs|Sr)__repr__rr0r0r1__str__DszInterface.__str__cCsjd|j}|ddt|7}|d7}|jD] }|d|7}q|d7}|jD] }|d|7}q)|S)NzGradio Interface for:  -z inputs:z |-z outputs:)rxrrr)rreprrr0r0r1rGs   zInterface.__repr__cs.|t|IdHtjddtjddgSr) interpretr.rr)rargsr0r0r1rRs   zInterface.interpret_func raw_input list[Any]cs(ddtt||IdHd|DS)NcSsg|] \}}||dqS))originalr r0)rgr Z raw_valuer0r0r1rjYsz'Interface.interpret..r)rr Z run_interpret)rrr0r0r1rXs zInterface.interpretcCs tddS)z Deprecated. z3The Interface.test_launch() function is deprecated.Nrrr0r0r1 test_launch`s zInterface.test_launch)r,r-)NNN) r3r4r5r6r7r6r8r6r,r )r:r&r,r*)2r>rr?r@rAr@rBrCrDrErFrGrHrIr rJrKrLrMr6rNr6rOr6rPr6rQrRrSr6rTr6rUrVrWr4rXrrYrErZrIr[rGr\r]r^rIr_rI)r,r)r,r)r,r)rrr,r)rrrr)rrrrrr)rrrrrrrr)rrrr)rrr,r)rx __module__ __qualname____doc__weakrefWeakSetr+__annotations__ classmethodr2r'r(rrrrrrrrrrrrrrrrr __classcell__r0r0rr1r**sh    _   @; l  7 r*cs.eZdZdZ     ddfdd ZZS)TabbedInterfacez A TabbedInterface is created by providing a list of Interfaces, each of which gets rendered in a separate tab. Demos: stt_or_tts Ninterface_listr- tab_nameslist[str] | NonerMr6rQ Theme | NonerYrErSc stj|pd||d|d|durddtt|D}|Q|r)td|dt+t||D]\}}t|d  |Wdn1sJwYq2Wdn1sZwYWddSWddS1srwYdS) a Parameters: interface_list: a list of interfaces to be rendered in tabs. tab_names: a list of tab names. If None, the tab names will be "Tab 1", "Tab 2", etc. title: a title for the interface; if provided, appears above the input and output components in large font. Also used as the tab title when opened in a browser window. analytics_enabled: whether to allow basic telemetry. If None, will use GRADIO_ANALYTICS_ENABLED environment variable or default to True. css: custom css or path to custom css file to apply to entire Blocks Returns: a Gradio Tabbed Interface for the given interfaces r`Ztabbed_interface)rMrQrYrarSNcSsg|]}d|qS)zTab r0rsr0r0r1rjsz,TabbedInterface.__init__..rr)r) rrrangerrr"rr!rq) rrr rMrQrYrSr%Ztab_namerr0r1ros2   "zTabbedInterface.__init__r) rr-r r rMr6rQr rYrErSr6)rxrrrrrr0r0rr1rgs rTverboserIr,rcCstD]}||qdSr)r*r2close)r ior0r0r1 close_alls  r)T)r rIr,r);r __future__rrrrrrtypingrrrrZgradio_client.documentationrrZgradior r r r Z gradio.blocksr Zgradio.componentsrrrrrrrrZgradio.data_classesrZgradio.deprecationrZ gradio.eventsrrrZgradio.flaggingrrrZgradio.layoutsrr r!r"Zgradio.pipelinesr#Z gradio.themesr$ThemeZtransformers.pipelines.baser&r*rrr0r0r0r1sB  (    B.