update readme + demo

jprochazk · jprochazk · commit 357306d8b26e · 2024-07-09T14:26:36.000+02:00
diff --git a/README.md b/README.md
@@ -122,6 +122,16 @@ with gr.Blocks() as demo:
             img = gr.Image(interactive=True, label="Image")
             with gr.Column():
                 stream_blur = gr.Button("Stream Repeated Blur")
+        with gr.Row():
+            viewer = Rerun(
+                streaming=True,
+                panel_states={
+                    "time": "collapsed",
+                    "blueprint": "hidden",
+                    "selection": "hidden",
+                },
+            )
+        stream_blur.click(streaming_repeated_blur, inputs=[img], outputs=[viewer])
 
     with gr.Tab("Dynamic RRD"):
         pending_cleanup = gr.State(
@@ -139,6 +149,20 @@ with gr.Blocks() as demo:
             )
         with gr.Row():
             create_rrd = gr.Button("Create RRD")
+        with gr.Row():
+            viewer = Rerun(
+                streaming=True,
+                panel_states={
+                    "time": "collapsed",
+                    "blueprint": "hidden",
+                    "selection": "hidden",
+                },
+            )
+        create_rrd.click(
+            create_cube_rrd,
+            inputs=[x_count, y_count, z_count, pending_cleanup],
+            outputs=[viewer],
+        )
 
     with gr.Tab("Hosted RRD"):
         with gr.Row():
@@ -152,23 +176,16 @@ with gr.Blocks() as demo:
                     f"{rr.bindings.get_app_url()}/examples/plots.rrd",
                 ],
             )
-
-    # Rerun 0.16 has issues when embedded in a Gradio tab, so we share a viewer between all the tabs.
-    # In 0.17 we can instead scope each viewer to its own tab to clean up these examples further.
-    with gr.Row():
-        viewer = Rerun(
-            streaming=True,
-        )
-
-    stream_blur.click(streaming_repeated_blur, inputs=[img], outputs=[viewer])
-
-    create_rrd.click(
-        create_cube_rrd,
-        inputs=[x_count, y_count, z_count, pending_cleanup],
-        outputs=[viewer],
-    )
-
-    choose_rrd.change(lambda x: x, inputs=[choose_rrd], outputs=[viewer])
+        with gr.Row():
+            viewer = Rerun(
+                streaming=True,
+                panel_states={
+                    "time": "collapsed",
+                    "blueprint": "hidden",
+                    "selection": "hidden",
+                },
+            )
+        choose_rrd.change(lambda x: x, inputs=[choose_rrd], outputs=[viewer])
 
 
 if __name__ == "__main__":
@@ -363,6 +380,19 @@ bool
 <td align="left"><code>True</code></td>
 <td align="left">If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.</td>
 </tr>
+
+<tr>
+<td align="left"><code>panel_states</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+dict[str, Any] | None
+```
+
+</td>
+<td align="left"><code>None</code></td>
+<td align="left">Force viewer panels to a specific state. Any panels set cannot be toggled by the user in the viewer. Panel names are "top", "blueprint", "selection", and "time". States are "hidden", "collapsed", and "expanded".</td>
+</tr>
 </tbody></table>
 
 
diff --git a/demo/app.py b/demo/app.py
@@ -97,6 +97,16 @@ def cleanup_cube_rrds(pending_cleanup):
             img = gr.Image(interactive=True, label="Image")
             with gr.Column():
                 stream_blur = gr.Button("Stream Repeated Blur")
+        with gr.Row():
+            viewer = Rerun(
+                streaming=True,
+                panel_states={
+                    "time": "collapsed",
+                    "blueprint": "hidden",
+                    "selection": "hidden",
+                },
+            )
+        stream_blur.click(streaming_repeated_blur, inputs=[img], outputs=[viewer])
 
     with gr.Tab("Dynamic RRD"):
         pending_cleanup = gr.State(
@@ -114,6 +124,20 @@ def cleanup_cube_rrds(pending_cleanup):
             )
         with gr.Row():
             create_rrd = gr.Button("Create RRD")
+        with gr.Row():
+            viewer = Rerun(
+                streaming=True,
+                panel_states={
+                    "time": "collapsed",
+                    "blueprint": "hidden",
+                    "selection": "hidden",
+                },
+            )
+        create_rrd.click(
+            create_cube_rrd,
+            inputs=[x_count, y_count, z_count, pending_cleanup],
+            outputs=[viewer],
+        )
 
     with gr.Tab("Hosted RRD"):
         with gr.Row():
@@ -127,28 +151,16 @@ def cleanup_cube_rrds(pending_cleanup):
                     f"{rr.bindings.get_app_url()}/examples/plots.rrd",
                 ],
             )
-
-    # Rerun 0.16 has issues when embedded in a Gradio tab, so we share a viewer between all the tabs.
-    # In 0.17 we can instead scope each viewer to its own tab to clean up these examples further.
-    with gr.Row():
-        viewer = Rerun(
-            streaming=True,
-            panel_states={
-                "time": "hidden",
-                "blueprint": "hidden",
-                "selection": "hidden",
-            },
-        )
-
-    stream_blur.click(streaming_repeated_blur, inputs=[img], outputs=[viewer])
-
-    create_rrd.click(
-        create_cube_rrd,
-        inputs=[x_count, y_count, z_count, pending_cleanup],
-        outputs=[viewer],
-    )
-
-    choose_rrd.change(lambda x: x, inputs=[choose_rrd], outputs=[viewer])
+        with gr.Row():
+            viewer = Rerun(
+                streaming=True,
+                panel_states={
+                    "time": "collapsed",
+                    "blueprint": "hidden",
+                    "selection": "hidden",
+                },
+            )
+        choose_rrd.change(lambda x: x, inputs=[choose_rrd], outputs=[viewer])
 
 
 if __name__ == "__main__":
diff --git a/demo/space.py b/demo/space.py
@@ -3,7 +3,7 @@
 from app import demo as app
 import os
 
-_docs = {'Rerun': {'description': 'Creates a Rerun viewer component that can be used to display the output of a Rerun stream.', 'members': {'__init__': {'value': {'type': 'list[pathlib.Path | str]\n    | pathlib.Path\n    | str\n    | bytes\n    | Callable\n    | None', 'default': 'None', 'description': 'Takes a singular or list of RRD resources. Each RRD can be a Path, a string containing a url, or a binary blob containing encoded RRD data. If callable, the function will be called whenever the app loads to set the initial value of the component.'}, 'label': {'type': 'str | None', 'default': 'None', 'description': 'The label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to.'}, 'every': {'type': 'float | None', 'default': 'None', 'description': "If `value` is a callable, run the function 'every' number of seconds while the client connection is open. Has no effect otherwise. Queue must be enabled. The event can be accessed (e.g. to cancel it) via this component's .load_event attribute."}, 'show_label': {'type': 'bool | None', 'default': 'None', 'description': 'if True, will display label.'}, 'container': {'type': 'bool', 'default': 'True', 'description': 'If True, will place the component in a container - providing some extra padding around the border.'}, 'scale': {'type': 'int | None', 'default': 'None', 'description': 'relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer. scale applies in Rows, and to top-level Components in Blocks where fill_height=True.'}, 'min_width': {'type': 'int', 'default': '160', 'description': 'minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.'}, 'height': {'type': 'int | str', 'default': '640', 'description': 'height of component in pixels. If a string is provided, will be interpreted as a CSS value. If None, will be set to 640px.'}, 'visible': {'type': 'bool', 'default': 'True', 'description': 'If False, component will be hidden.'}, 'streaming': {'type': 'bool', 'default': 'False', 'description': 'If True, the data should be incrementally yielded from the source as `bytes` returned by calling `.read()` on an `rr.binary_stream()`'}, 'elem_id': {'type': 'str | None', 'default': 'None', 'description': 'An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.'}, 'elem_classes': {'type': 'list[str] | str | None', 'default': 'None', 'description': 'An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.'}, 'render': {'type': 'bool', 'default': 'True', 'description': 'If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.'}}, 'postprocess': {'value': {'type': 'list[pathlib.Path | str] | pathlib.Path | str | bytes', 'description': 'Expects'}}, 'preprocess': {'return': {'type': 'RerunData | None', 'description': 'A RerunData object.'}, 'value': None}}, 'events': {}}, '__meta__': {'additional_interfaces': {'RerunData': {'source': 'class RerunData(GradioRootModel):\n    root: list[FileData | str]'}}, 'user_fn_refs': {'Rerun': ['RerunData']}}}
+_docs = {'Rerun': {'description': 'Creates a Rerun viewer component that can be used to display the output of a Rerun stream.', 'members': {'__init__': {'value': {'type': 'list[pathlib.Path | str]\n    | pathlib.Path\n    | str\n    | bytes\n    | Callable\n    | None', 'default': 'None', 'description': 'Takes a singular or list of RRD resources. Each RRD can be a Path, a string containing a url, or a binary blob containing encoded RRD data. If callable, the function will be called whenever the app loads to set the initial value of the component.'}, 'label': {'type': 'str | None', 'default': 'None', 'description': 'The label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to.'}, 'every': {'type': 'float | None', 'default': 'None', 'description': "If `value` is a callable, run the function 'every' number of seconds while the client connection is open. Has no effect otherwise. Queue must be enabled. The event can be accessed (e.g. to cancel it) via this component's .load_event attribute."}, 'show_label': {'type': 'bool | None', 'default': 'None', 'description': 'if True, will display label.'}, 'container': {'type': 'bool', 'default': 'True', 'description': 'If True, will place the component in a container - providing some extra padding around the border.'}, 'scale': {'type': 'int | None', 'default': 'None', 'description': 'relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer. scale applies in Rows, and to top-level Components in Blocks where fill_height=True.'}, 'min_width': {'type': 'int', 'default': '160', 'description': 'minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.'}, 'height': {'type': 'int | str', 'default': '640', 'description': 'height of component in pixels. If a string is provided, will be interpreted as a CSS value. If None, will be set to 640px.'}, 'visible': {'type': 'bool', 'default': 'True', 'description': 'If False, component will be hidden.'}, 'streaming': {'type': 'bool', 'default': 'False', 'description': 'If True, the data should be incrementally yielded from the source as `bytes` returned by calling `.read()` on an `rr.binary_stream()`'}, 'elem_id': {'type': 'str | None', 'default': 'None', 'description': 'An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.'}, 'elem_classes': {'type': 'list[str] | str | None', 'default': 'None', 'description': 'An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.'}, 'render': {'type': 'bool', 'default': 'True', 'description': 'If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.'}, 'panel_states': {'type': 'dict[str, Any] | None', 'default': 'None', 'description': 'Force viewer panels to a specific state. Any panels set cannot be toggled by the user in the viewer. Panel names are "top", "blueprint", "selection", and "time". States are "hidden", "collapsed", and "expanded".'}}, 'postprocess': {'value': {'type': 'list[pathlib.Path | str] | pathlib.Path | str | bytes', 'description': 'Expects'}}, 'preprocess': {'return': {'type': 'RerunData | None', 'description': 'A RerunData object.'}, 'value': None}}, 'events': {}}, '__meta__': {'additional_interfaces': {'RerunData': {'source': 'class RerunData(GradioRootModel):\n    root: list[FileData | str]'}}, 'user_fn_refs': {'Rerun': ['RerunData']}}}
 
 abs_path = os.path.join(os.path.dirname(__file__), "css.css")
 
@@ -137,6 +137,16 @@ def cleanup_cube_rrds(pending_cleanup):
             img = gr.Image(interactive=True, label="Image")
             with gr.Column():
                 stream_blur = gr.Button("Stream Repeated Blur")
+        with gr.Row():
+            viewer = Rerun(
+                streaming=True,
+                panel_states={
+                    "time": "collapsed",
+                    "blueprint": "hidden",
+                    "selection": "hidden",
+                },
+            )
+        stream_blur.click(streaming_repeated_blur, inputs=[img], outputs=[viewer])
 
     with gr.Tab("Dynamic RRD"):
         pending_cleanup = gr.State(
@@ -154,6 +164,20 @@ def cleanup_cube_rrds(pending_cleanup):
             )
         with gr.Row():
             create_rrd = gr.Button("Create RRD")
+        with gr.Row():
+            viewer = Rerun(
+                streaming=True,
+                panel_states={
+                    "time": "collapsed",
+                    "blueprint": "hidden",
+                    "selection": "hidden",
+                },
+            )
+        create_rrd.click(
+            create_cube_rrd,
+            inputs=[x_count, y_count, z_count, pending_cleanup],
+            outputs=[viewer],
+        )
 
     with gr.Tab("Hosted RRD"):
         with gr.Row():
@@ -167,23 +191,16 @@ def cleanup_cube_rrds(pending_cleanup):
                     f"{rr.bindings.get_app_url()}/examples/plots.rrd",
                 ],
             )
-
-    # Rerun 0.16 has issues when embedded in a Gradio tab, so we share a viewer between all the tabs.
-    # In 0.17 we can instead scope each viewer to its own tab to clean up these examples further.
-    with gr.Row():
-        viewer = Rerun(
-            streaming=True,
-        )
-
-    stream_blur.click(streaming_repeated_blur, inputs=[img], outputs=[viewer])
-
-    create_rrd.click(
-        create_cube_rrd,
-        inputs=[x_count, y_count, z_count, pending_cleanup],
-        outputs=[viewer],
-    )
-
-    choose_rrd.change(lambda x: x, inputs=[choose_rrd], outputs=[viewer])
+        with gr.Row():
+            viewer = Rerun(
+                streaming=True,
+                panel_states={
+                    "time": "collapsed",
+                    "blueprint": "hidden",
+                    "selection": "hidden",
+                },
+            )
+        choose_rrd.change(lambda x: x, inputs=[choose_rrd], outputs=[viewer])
 
 
 if __name__ == "__main__":
