diff --git a/gradio/blocks.py b/gradio/blocks.py index 44695960b8..f5f024311d 100644 --- a/gradio/blocks.py +++ b/gradio/blocks.py @@ -293,6 +293,7 @@ class Blocks(BlockContext): demo.launch() Demos: blocks_hello, blocks_flipper, blocks_speech_text_sentiment, generate_english_german + Guides: blocks_and_event_listeners, controlling_layout, state_in_blocks, custom_CSS_and_JS, custom_interpretations_with_blocks, using_blocks_like_functions """ def __init__( diff --git a/gradio/components.py b/gradio/components.py index cb74f4d837..5d50a5eb2f 100644 --- a/gradio/components.py +++ b/gradio/components.py @@ -286,6 +286,7 @@ class Textbox(Changeable, Submittable, IOComponent): Examples-format: a {str} representing the textbox input. Demos: hello_world, diff_texts, sentence_builder + Guides: creating_a_chatbot, real_time_speech_recognition """ def __init__( @@ -665,6 +666,7 @@ class Slider(Changeable, IOComponent): Examples-format: A {float} or {int} representing the slider's value. Demos: sentence_builder, generate_tone, titanic_survival + Guides: create_your_own_friends_with_a_gan """ def __init__( @@ -1351,6 +1353,7 @@ class Image(Editable, Clearable, Changeable, Streamable, IOComponent): Postprocessing: expects a {numpy.array}, {PIL.Image} or {str} filepath to an image and displays the image. Examples-format: a {str} filepath to a local file that contains the image. Demos: image_mod, image_mod_default_image + Guides: Gradio_and_ONNX_on_Hugging_Face, image_classification_in_pytorch, image_classification_in_tensorflow, image_classification_with_vision_transformers, building_a_pictionary_app, create_your_own_friends_with_a_gan """ def __init__( @@ -1912,6 +1915,7 @@ class Audio(Changeable, Clearable, Playable, Streamable, IOComponent): Postprocessing: expects a {Tuple(int, numpy.array)} corresponding to (sample rate, data) or as a {str} filepath to an audio file, which gets displayed Examples-format: a {str} filepath to a local file that contains audio. Demos: main_note, generate_tone, reverse_audio + Guides: real_time_speech_recognition """ def __init__( @@ -2854,6 +2858,7 @@ class Variable(IOComponent): Preprocessing: No preprocessing is performed Postprocessing: No postprocessing is performed Demos: chatbot_demo, blocks_simple_squares + Guides: creating_a_chatbot, real_time_speech_recognition """ allow_string_shortcut = False @@ -3075,6 +3080,7 @@ class Label(Changeable, IOComponent): Postprocessing: expects a {Dict[str, float]} of classes and confidences, or {str} with just the class or an {int}/{float} for regression outputs. Demos: main_note, titanic_survival + Guides: Gradio_and_ONNX_on_Hugging_Face, image_classification_in_pytorch, image_classification_in_tensorflow, image_classification_with_vision_transformers, building_a_pictionary_app """ CONFIDENCES_KEY = "confidences" @@ -3218,6 +3224,7 @@ class HighlightedText(Changeable, IOComponent): Postprocessing: expects a {List[Tuple[str, float | str]]]} consisting of spans of text and their associated labels, or a {Dict} with two keys: (1) "text" whose value is the complete text, and "entities", which is a list of dictionaries, each of which have the keys: "entity" (consisting of the entity label), "start" (the character index where the label starts), and "end" (the character index where the label ends). Demos: diff_texts, text_analysis + Guides: named_entity_recognition """ def __init__( @@ -3458,6 +3465,7 @@ class HTML(Changeable, IOComponent): Postprocessing: expects a valid HTML {str}. Demos: text_analysis + Guides: key_features """ def __init__( @@ -3869,6 +3877,7 @@ class Model3D(Changeable, Editable, Clearable, IOComponent): Postprocessing: expects function to return a {str} path to a file of type (.obj, glb, or .gltf) Demos: model3D + Guides: how_to_use_3D_model_component """ def __init__( @@ -4102,6 +4111,7 @@ class Markdown(IOComponent, Changeable): Postprocessing: expects a valid {str} that can be rendered as Markdown. Demos: blocks_hello, blocks_kinematics + Guides: key_features """ def __init__( @@ -4249,6 +4259,8 @@ class Interpretation(Component): Used to create an interpretation widget for a component. Preprocessing: this component does *not* accept input. Postprocessing: expects a {dict} with keys "original" and "interpretation". + + Guides: custom_interpretations_with_blocks """ def __init__( diff --git a/gradio/examples.py b/gradio/examples.py index 87ae443c32..1e9845e7ef 100644 --- a/gradio/examples.py +++ b/gradio/examples.py @@ -31,6 +31,7 @@ class Examples: components. Optionally handles example caching for fast inference. Demos: blocks_inputs, fake_gan + Guides: more_on_examples_and_flagging, using_hugging_face_integrations, image_classification_in_pytorch, image_classification_in_tensorflow, image_classification_with_vision_transformers, create_your_own_friends_with_a_gan """ def __init__( diff --git a/gradio/flagging.py b/gradio/flagging.py index b7a4d113da..a35f8d4aaa 100644 --- a/gradio/flagging.py +++ b/gradio/flagging.py @@ -120,6 +120,7 @@ class CSVLogger(FlaggingCallback): return {'cat': 0.3, 'dog': 0.7} demo = gr.Interface(fn=image_classifier, inputs="image", outputs="label", flagging_callback=CSVLogger()) + Guides: using_flagging """ def __init__(self): @@ -239,6 +240,7 @@ class HuggingFaceDatasetSaver(FlaggingCallback): 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 """ def __init__( diff --git a/gradio/interface.py b/gradio/interface.py index 4db5545b1c..18647dbb4a 100644 --- a/gradio/interface.py +++ b/gradio/interface.py @@ -60,6 +60,7 @@ class Interface(Blocks): demo = gr.Interface(fn=image_classifier, inputs="image", outputs="label") demo.launch() Demos: hello_world, hello_world_3, gpt_j + Guides: quickstart, key_features, sharing_your_app, interface_state, reactive_interfaces, advanced_interface_features """ # stores references to all currently existing Interface instances diff --git a/gradio/layouts.py b/gradio/layouts.py index b3cf660e86..0481b4b5f2 100644 --- a/gradio/layouts.py +++ b/gradio/layouts.py @@ -37,6 +37,7 @@ class Row(BlockContext): gr.Image("lion.jpg") gr.Image("tiger.jpg") demo.launch() + Guides: controlling_layout """ def get_config(self): @@ -77,6 +78,7 @@ class Column(BlockContext): with gradio.Column(): btn1 = gr.Button("Button 1") btn2 = gr.Button("Button 2") + Guides: controlling_layout """ def __init__( @@ -126,6 +128,7 @@ class Tabs(BlockContext): with gradio.TabItem("Tiger"): gr.Image("tiger.jpg") gr.Button("New Tiger") + Guides: controlling_layout """ def __init__(self, selected: Optional[int | str] = None, **kwargs): diff --git a/gradio/mix.py b/gradio/mix.py index 6d6181432b..a908b30dbd 100644 --- a/gradio/mix.py +++ b/gradio/mix.py @@ -19,6 +19,7 @@ class Parallel(gradio.Interface): The Interfaces to put in Parallel must share the same input components (but can have different output components). Demos: interface_parallel, interface_parallel_load + Guides: advanced_interface_features """ def __init__(self, *interfaces: gradio.Interface, **options): @@ -61,6 +62,7 @@ class Series(gradio.Interface): and so the input and output components must agree between the interfaces). Demos: interface_series, interface_series_load + Guides: advanced_interface_features """ def __init__(self, *interfaces: gradio.Interface, **options): diff --git a/guides/2)building_interfaces/4)advanced_interface_features.md b/guides/2)building_interfaces/4)advanced_interface_features.md index 1a7c9c5ca3..dfdac13daa 100644 --- a/guides/2)building_interfaces/4)advanced_interface_features.md +++ b/guides/2)building_interfaces/4)advanced_interface_features.md @@ -78,5 +78,3 @@ gr.Series(generator, translator).launch() # this demo generates text, then tran ``` And of course, you can also mix `Parallel` and `Series` together whenever that makes sense! - -Docs: parallel, series \ No newline at end of file diff --git a/guides/4)integrating_other_frameworks/1)using_hugging_face_integrations.md b/guides/4)integrating_other_frameworks/1)using_hugging_face_integrations.md index fa59cde0ef..718e60b28d 100644 --- a/guides/4)integrating_other_frameworks/1)using_hugging_face_integrations.md +++ b/guides/4)integrating_other_frameworks/1)using_hugging_face_integrations.md @@ -2,7 +2,6 @@ Related spaces: https://huggingface.co/spaces/farukozderim/Model-Comparator-Space-Builder, https://huggingface.co/spaces/osanseviero/helsinki_translation_en_es, https://huggingface.co/spaces/osanseviero/remove-bg-webcam, https://huggingface.co/spaces/mrm8488/GPT-J-6B, https://huggingface.co/spaces/akhaliq/T0pp, https://huggingface.co/spaces/osanseviero/mix_match_gradio Tags: HUB, SPACES, EMBED -Docs: examples Contributed by Omar Sanseviero 🦙 and Ömer Faruk Özdemir diff --git a/guides/4)integrating_other_frameworks/Gradio_and_ONNX_on_Hugging_Face.md b/guides/4)integrating_other_frameworks/Gradio_and_ONNX_on_Hugging_Face.md index f9ee73fc02..d58bf077ec 100644 --- a/guides/4)integrating_other_frameworks/Gradio_and_ONNX_on_Hugging_Face.md +++ b/guides/4)integrating_other_frameworks/Gradio_and_ONNX_on_Hugging_Face.md @@ -3,8 +3,6 @@ Related spaces: https://huggingface.co/spaces/onnx/EfficientNet-Lite4 Tags: ONNX, SPACES Contributed by Gradio and the ONNX team -Docs: image, label - ## Introduction diff --git a/guides/4)integrating_other_frameworks/image_classification_in_pytorch.md b/guides/4)integrating_other_frameworks/image_classification_in_pytorch.md index 07f3e30edc..a8ed423abd 100644 --- a/guides/4)integrating_other_frameworks/image_classification_in_pytorch.md +++ b/guides/4)integrating_other_frameworks/image_classification_in_pytorch.md @@ -2,7 +2,6 @@ Related spaces: https://huggingface.co/spaces/abidlabs/pytorch-image-classifier, https://huggingface.co/spaces/pytorch/ResNet, https://huggingface.co/spaces/pytorch/ResNext, https://huggingface.co/spaces/pytorch/SqueezeNet Tags: VISION, RESNET, PYTORCH -Docs: image, label, example ## Introduction diff --git a/guides/4)integrating_other_frameworks/image_classification_in_tensorflow.md b/guides/4)integrating_other_frameworks/image_classification_in_tensorflow.md index 0bbea03555..617b107f02 100644 --- a/guides/4)integrating_other_frameworks/image_classification_in_tensorflow.md +++ b/guides/4)integrating_other_frameworks/image_classification_in_tensorflow.md @@ -2,7 +2,6 @@ Related spaces: https://huggingface.co/spaces/abidlabs/keras-image-classifier Tags: VISION, MOBILENET, TENSORFLOW -Docs: image, label, examples ## Introduction diff --git a/guides/4)integrating_other_frameworks/image_classification_with_vision_transformers.md b/guides/4)integrating_other_frameworks/image_classification_with_vision_transformers.md index 7b8d253d83..92e205806a 100644 --- a/guides/4)integrating_other_frameworks/image_classification_with_vision_transformers.md +++ b/guides/4)integrating_other_frameworks/image_classification_with_vision_transformers.md @@ -2,7 +2,6 @@ Related spaces: https://huggingface.co/spaces/abidlabs/vision-transformer Tags: VISION, TRANSFORMERS, HUB -Docs: image, label, examples ## Introduction diff --git a/guides/5)other_tutorials/building_a_pictionary_app.md b/guides/5)other_tutorials/building_a_pictionary_app.md index 98b3d4db9c..e5f3c0cbb9 100644 --- a/guides/5)other_tutorials/building_a_pictionary_app.md +++ b/guides/5)other_tutorials/building_a_pictionary_app.md @@ -2,7 +2,6 @@ Related spaces: https://huggingface.co/spaces/nateraw/quickdraw Tags: SKETCHPAD, LABELS, LIVE -Docs: image, label ## Introduction diff --git a/guides/5)other_tutorials/create_your_own_friends_with_a_gan.md b/guides/5)other_tutorials/create_your_own_friends_with_a_gan.md index 41d92b130b..67f99ca8ec 100644 --- a/guides/5)other_tutorials/create_your_own_friends_with_a_gan.md +++ b/guides/5)other_tutorials/create_your_own_friends_with_a_gan.md @@ -2,7 +2,6 @@ Related spaces: https://huggingface.co/spaces/NimaBoscarino/cryptopunks, https://huggingface.co/spaces/nateraw/cryptopunks-generator Tags: GAN, IMAGE, HUB -Docs: slider, image, examples Contributed by Nima Boscarino and Nate Raw diff --git a/guides/5)other_tutorials/creating_a_chatbot.md b/guides/5)other_tutorials/creating_a_chatbot.md index 302490cf19..9297744606 100644 --- a/guides/5)other_tutorials/creating_a_chatbot.md +++ b/guides/5)other_tutorials/creating_a_chatbot.md @@ -2,7 +2,6 @@ Related spaces: https://huggingface.co/spaces/abidlabs/chatbot-minimal, https://huggingface.co/spaces/ThomasSimonini/Chat-with-Gandalf-GPT-J6B, https://huggingface.co/spaces/gorkemgoknar/moviechatbot, https://huggingface.co/spaces/Kirili4ik/chat-with-Kirill Tags: NLP, TEXT, HTML -Docs: textbox, variable ## Introduction diff --git a/guides/5)other_tutorials/creating_a_new_component.md b/guides/5)other_tutorials/creating_a_new_component.md index 5bc4818087..85e561466c 100644 --- a/guides/5)other_tutorials/creating_a_new_component.md +++ b/guides/5)other_tutorials/creating_a_new_component.md @@ -1,7 +1,5 @@ # How to Create a New Component -Docs: component - ## Introduction The purpose of this guide is to illustrate how to add a new component, which you can use in your Gradio applications. The guide will be complemented by code snippets showing step by step how the [ColorPicker](https://gradio.app/docs/#colorpicker) component was added. diff --git a/guides/5)other_tutorials/custom_interpretations_with_blocks.md b/guides/5)other_tutorials/custom_interpretations_with_blocks.md index e43cda5f7c..5897fc8db8 100644 --- a/guides/5)other_tutorials/custom_interpretations_with_blocks.md +++ b/guides/5)other_tutorials/custom_interpretations_with_blocks.md @@ -1,7 +1,6 @@ # Custom Machine Learning Interpretations with Blocks -Docs: blocks, interpretation Tags: INTERPRETATION, SENTIMENT ANALYSIS **Prerequisite**: This Guide requires you to know about Blocks and the interpretation feature of Interfaces. diff --git a/guides/5)other_tutorials/how_to_use_3D_model_component.md b/guides/5)other_tutorials/how_to_use_3D_model_component.md index a88e887a5c..2882ba616e 100644 --- a/guides/5)other_tutorials/how_to_use_3D_model_component.md +++ b/guides/5)other_tutorials/how_to_use_3D_model_component.md @@ -2,7 +2,6 @@ Related spaces: https://huggingface.co/spaces/dawood/Model3D, https://huggingface.co/spaces/radames/PIFu-Clothed-Human-Digitization, https://huggingface.co/spaces/radames/dpt-depth-estimation-3d-obj Tags: VISION, IMAGE -Docs: model3d ## Introduction diff --git a/guides/5)other_tutorials/named_entity_recognition.md b/guides/5)other_tutorials/named_entity_recognition.md index eedf010a82..38f6ea49d2 100644 --- a/guides/5)other_tutorials/named_entity_recognition.md +++ b/guides/5)other_tutorials/named_entity_recognition.md @@ -2,7 +2,6 @@ Related spaces: https://huggingface.co/spaces/rajistics/biobert_ner_demo, https://huggingface.co/spaces/abidlabs/ner, https://huggingface.co/spaces/rajistics/Financial_Analyst_AI Tags: NER, TEXT, HIGHLIGHT -Docs: highlightedtext ## Introduction diff --git a/guides/5)other_tutorials/real_time_speech_recognition.md b/guides/5)other_tutorials/real_time_speech_recognition.md index c107c4f485..6e73cff584 100644 --- a/guides/5)other_tutorials/real_time_speech_recognition.md +++ b/guides/5)other_tutorials/real_time_speech_recognition.md @@ -2,7 +2,6 @@ Related spaces: https://huggingface.co/spaces/abidlabs/streaming-asr-paused, https://huggingface.co/spaces/abidlabs/full-context-asr Tags: ASR, SPEECH, STREAMING -Docs: audio, variable, textbox ## Introduction diff --git a/guides/5)other_tutorials/using_blocks_like_functions.md b/guides/5)other_tutorials/using_blocks_like_functions.md index 883d252ad0..b05c6e820e 100644 --- a/guides/5)other_tutorials/using_blocks_like_functions.md +++ b/guides/5)other_tutorials/using_blocks_like_functions.md @@ -2,8 +2,6 @@ Tags: TRANSLATION, HUB, SPACES -Docs: Blocks - **Prerequisite**: This Guide builds on the Blocks Introduction. Make sure to [read that guide first](/introduction_to_blocks). ## Introduction diff --git a/website/homepage/src/docs/__init__.py b/website/homepage/src/docs/__init__.py index 8540a3885a..10dfba1a38 100644 --- a/website/homepage/src/docs/__init__.py +++ b/website/homepage/src/docs/__init__.py @@ -63,8 +63,15 @@ add_supported_events() def add_guides(): for mode in docs: - for obj in docs[mode]: - obj["guides"] = [guide for guide in guides if obj["name"].lower() in guide["docs"]] + for cls in docs[mode]: + if "guides" not in cls["tags"]: + continue + cls["guides"] = [] + docstring_guides = [guide.strip() for guide in cls["tags"]["guides"].split(",")] + for docstring_guide in docstring_guides: + for guide in guides: + if docstring_guide == guide["name"]: + cls["guides"].append(guide) add_guides() diff --git a/website/homepage/src/docs/template.html b/website/homepage/src/docs/template.html index 5cc41e2dea..f7c0d54976 100644 --- a/website/homepage/src/docs/template.html +++ b/website/homepage/src/docs/template.html @@ -35,7 +35,7 @@

Building Demos

- {% with obj=find_cls("Interface"), parent="gradio" %} + {% with obj=find_cls("Interface"), is_class=True, parent="gradio" %} {% include "docs/obj_doc_template.html" %} {% endwith %}
@@ -59,15 +59,6 @@ {% endwith %} {% endfor %} - -

Flagging Guides

-
- -
-

Flagging

-
- -
@@ -93,7 +84,7 @@
- {% with obj=find_cls("Blocks"), parent="gradio" %} + {% with obj=find_cls("Blocks"), is_class=True, parent="gradio" %} {% include "docs/obj_doc_template.html" %} {% endwith %}
@@ -101,7 +92,7 @@

Customize the layout of your Blocks UI with the layout classes below.

{% for layout in docs["layout"] %} - {% with obj=layout, parent="gradio" %} + {% with obj=layout, is_class=True, parent="gradio" %} {% include "docs/obj_doc_template.html" %} {% endwith %} {% endfor %} diff --git a/website/homepage/src/guides/__init__.py b/website/homepage/src/guides/__init__.py index 3413bfcc4a..c14b40d452 100644 --- a/website/homepage/src/guides/__init__.py +++ b/website/homepage/src/guides/__init__.py @@ -69,8 +69,6 @@ for guide_folder in guide_folders: tags = get_labeled_metadata("Tags:") spaces = get_labeled_metadata("Related spaces:") contributor = get_labeled_metadata("Contributed by", is_list=False) - docs = get_labeled_metadata("Docs:") - pinned = get_labeled_metadata("Pinned:", is_list=False) url = f"/{guide_name}/" @@ -109,8 +107,6 @@ for guide_folder in guide_folders: "spaces": spaces, "url": url, "contributor": contributor, - "docs": docs, - "pinned": pinned, } guides.append(guide_data) guides_by_category[-1]["guides"].append(guide_data) diff --git a/website/homepage/src/guides/gallery_template.html b/website/homepage/src/guides/gallery_template.html index a8f15d5db3..1682de94c2 100644 --- a/website/homepage/src/guides/gallery_template.html +++ b/website/homepage/src/guides/gallery_template.html @@ -34,12 +34,12 @@

{{ guide.pretty_name }}

{% if guide.tags is not none %} -

- {% for tag in guide.tags %} - {{ tag }} - {% if not loop.last %},{% endif %} - {% endfor %} -

+

{% for tag in guide.tags %}{{ tag }}{% if not loop.last %}, {% endif %}{% endfor %}

{% endif %}