interactive-pipe 0.6.0__tar.gz → 0.7.0__tar.gz

{interactive_pipe-0.6.0/src/interactive_pipe.egg-info → interactive_pipe-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: interactive_pipe
-Version: 0.6.0
+Version: 0.7.0
 Summary: Library to create flexible interactive image processing pipelines and automatically add a graphical user interface without knowing anything about GUI coding!
 Author-email: Balthazar Neveu <balthazarneveu@gmail.com>
 Project-URL: Homepage, https://github.com/balthazarneveu/interactive_pipe
@@ -15,6 +15,13 @@ Requires-Dist: matplotlib>=3.5.3
 Requires-Dist: numpy>=1.21.6
 Requires-Dist: Pillow>=9.0.1
 Requires-Dist: PyYAML>=5.4.1
+Requires-Dist: PyQt6>=6.5.2
+Requires-Dist: PyQt6_sip>=13.5.2
+Requires-Dist: opencv_python_headless>=4.8.1.78
+Requires-Dist: pytest>=6.2.5
+Requires-Dist: ipywidgets>=8.0.7
+Requires-Dist: pandas
+Requires-Dist: gradio
 Provides-Extra: qt6
 Requires-Dist: PyQt6>=6.5.2; extra == "qt6"
 Requires-Dist: PyQt6_sip>=13.5.2; extra == "qt6"
@@ -33,11 +40,12 @@ Requires-Dist: opencv_python_headless>=4.8.1.78; extra == "full"
 Requires-Dist: pytest>=6.2.5; extra == "full"
 Requires-Dist: ipywidgets>=8.0.7; extra == "full"
 Requires-Dist: pandas; extra == "full"
+Requires-Dist: gradio; extra == "full"
 
 # `interactive_pipe`
 
 Quick setup
-`pip install interactive-pipe[full]`
+`pip install interactive-pipe`
 
 ### Concept
 - Develop an algorithm while debugging visually with plots, while checking robustness & continuity to parameters change.
@@ -58,8 +66,12 @@ Quick setup
 
 ----------------------
 
-### Setup
-`pip install interactive-pipe[full]`
+### Local setup
+```
+git clone git@github.com:balthazarneveu/interactive_pipe.git
+cd interactive-pipe
+pip install -e ".[full]"
+```
 
 ----------------------
 
@@ -82,7 +94,8 @@ Quick setup
 ----------------------
 
 ## :scroll:  Features
-**Version 0.6.0**
+
+**Version 0.7.0**
 - Modular multi-image processing filters
 - Declarative: Easily make graphical user interface without having to learn anything about pyQt or matplotlib
 - Support in jupyter notebooks
@@ -90,16 +103,9 @@ Quick setup
 - Cache intermediate results in RAM for much faster processing
 - `KeyboardControl` : no slider on UI but exactly the same internal mechanism, update on key press.
 - Support Curve plots (2D signals)
-
-#### :soon: Upcoming features:
-- :soon: Scientific visual debugging: Display both colored images, heatmaps & graphs
+- :new: gradio backend (+allows sharing with others)
 
 
-#### :test_tube: Experimental features
-- custom events on specific key press
-- Display the execution graph of the pipeline
-- [thirdparty/music](/src/interactive_pipe/thirdparty/music.py) Play audio (Qt backend only). Play songs on spotify (linux only) when the spotify app is running.
-- [thirdparty/images_openai_api](/src/interactive_pipe/thirdparty/images_openai_api.py) Generate images from prompt using OpenAI API image generation DALL-E Model (:dollar:  paid service ~ 2cents/image) 
 
 #### :keyboard:   Keyboard shortcuts
 Shortcuts while using the GUI (QT & matplotlib backends)
@@ -119,7 +125,8 @@ Shortcuts while using the GUI (QT & matplotlib backends)
 - supported backends 
     - :ok: `gui='qt'` pyQt/pySide 
     - :ok: `gui='mpl'` matplotlib
-    - :ok: `gui='nb'`  ipywidget for jupyter notebooks  
+    - :ok: `gui='nb'`  ipywidget for jupyter notebooks
+    - :test_tube: `gui='gradio'` gradio wrapping (+use `share_gradio_app=True` to share your app with others)
 - tested platforms
     - :ok: Linux (Ubuntu / KDE Neon)
     - :ok: RapsberryPi
@@ -127,16 +134,15 @@ Shortcuts while using the GUI (QT & matplotlib backends)
 
 
 
-| :star: | *PyQt / PySide* |  *Matplotlib*   | *Jupyter notebooks including Google collab*   |
-|:-----: |:-----:|:------:|:----: |
-| Backend name | `qt`  | `mpl`  | `nb`|
-| Preview | ![qt backend](/doc/images/qt_backend.jpg)   | ![mpl backend](/doc/images/mpl_backend.jpg)    |  ![nb backend](/doc/images/notebook_backend.jpg)  |
-| Plot curves | :heavy_check_mark: | :heavy_check_mark: |   :heavy_check_mark: |
-| Auto refreshed layout | :heavy_check_mark: | :heavy_check_mark: |   :heavy_check_mark: |
-| Keyboard shortcuts / fullscreen| :heavy_check_mark: | :heavy_check_mark: |  :heavy_minus_sign: |
-| Audio support | :heavy_check_mark: | :heavy_minus_sign: |  :heavy_minus_sign: |
-| Image buttons| :heavy_check_mark: | :heavy_minus_sign: |  :heavy_minus_sign: |
-
+| :star: | *PyQt / PySide* |  *Matplotlib*   | *Jupyter notebooks including Google collab*   | *Gradio* | 
+|:-----: |:-----:|:------:|:----: |:----: |
+| Backend name | `qt`  | `mpl`  | `nb`| `gradio` |
+| Preview | ![qt backend](/doc/images/qt_backend.jpg)   | ![mpl backend](/doc/images/mpl_backend.jpg)    |  ![nb backend](/doc/images/notebook_backend.jpg)  | | 
+| Plot curves | :heavy_check_mark: | :heavy_check_mark: |   :heavy_check_mark: | :heavy_check_mark:|
+| Auto refreshed layout | :heavy_check_mark: | :heavy_check_mark: |   :heavy_check_mark: | :heavy_minus_sign: |
+| Keyboard shortcuts / fullscreen| :heavy_check_mark: | :heavy_check_mark: |  :heavy_minus_sign: | :heavy_minus_sign: |
+| Audio support | :heavy_check_mark: | :heavy_minus_sign: |  :heavy_minus_sign: | :heavy_minus_sign: |
+| Image buttons| :heavy_check_mark: | :heavy_minus_sign: |  :heavy_minus_sign: | :heavy_minus_sign:| 
 
 
 
@@ -154,12 +160,7 @@ Shortcuts while using the GUI (QT & matplotlib backends)
 ![Speech processing exploration in a notebook](/doc/images/jupyter_integration_speech.png)
 
 
-#### [Minimalistic pytorch based ISP ](https://github.com/balthazarneveu/interactive_pipe/tree/sample_interactive_isp/samples/isp)
-[ISP means image signal processor](https://en.wikipedia.org/wiki/Image_processor)
 
-:warning: Work in progess (no proper demosaicking, no denoiser, no tone mapping.)
-
-![Ultra simplistic ISP](/doc/images/isp_pipeline.png)
 
 
 # Tutorials
@@ -250,7 +251,7 @@ def generate_flat_colored_image(color_choice=["red", "green", "blue", "gray"], g
 ```
 
 - Note that you can also create filters which take no inputs and simply "generate" images. 
-- The `color_choice` list will be turnt into a nice dropdown menu. Default value here will be red as this is the first element of the list!
+- The `color_choice` list will be turned into a nice dropdown menu. Default value here will be red as this is the first element of the list!
 ----------
 
 :bulb: Can filters communicate together?
@@ -304,7 +305,8 @@ if __name__ == '__main__':
 ### History
 - Interactive pipe was initially developped by [Balthazar Neveu](https://github.com/balthazarneveu) as part of the [irdrone project](https://github.com/wisescootering/infrareddrone/tree/master/interactive) based on matplotlib.
 - Later, more contributions were also made by [Giuseppe Moschetti](https://github.com/g-moschetti) and Sylvain Leroy.
-- Summer 2023: rewriting the whole core and supporting several graphical backends!
+- August 2023: rewriting the whole core and supporting several graphical backends!
+- September 2024: Gradio backend
 
 
 
@@ -324,3 +326,23 @@ if __name__ == '__main__':
 - Exploratory backends
     - Create a [textual](https://github.com/Textualize/textual) backend for simplified GUI (probably no images displayed)
     - Create a [Kivy](https://kivy.org/) backend
+
+
+### Further examples
+
+#### [Minimalistic pytorch based ISP ](https://github.com/balthazarneveu/interactive_pipe/tree/sample_interactive_isp/samples/isp)
+[ISP means image signal processor](https://en.wikipedia.org/wiki/Image_processor)
+
+:warning: Work in progess (no proper demosaicking, no denoiser, no tone mapping.)
+
+![Ultra simplistic ISP](/doc/images/isp_pipeline.png)
+
+
+
+
+
+#### :test_tube: Experimental features
+- Custom events on specific key press
+- Display the execution graph of the pipeline `G` key
+- [thirdparty/music](/src/interactive_pipe/thirdparty/music.py) Play audio (Qt backend only). Play songs on spotify (linux only) when the spotify app is running.
+- [thirdparty/images_openai_api](/src/interactive_pipe/thirdparty/images_openai_api.py) Generate images from prompt using OpenAI API image generation DALL-E Model (:dollar:  paid service ~ 2cents/image) 

{interactive_pipe-0.6.0 → interactive_pipe-0.7.0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "interactive_pipe"
-version = "0.6.0"
+version = "0.7.0"
 authors = [
   { name="Balthazar Neveu", email="balthazarneveu@gmail.com" },
 ]
@@ -14,6 +14,13 @@ dependencies = [
   "numpy>=1.21.6",
   "Pillow>=9.0.1",
   "PyYAML>=5.4.1",
+  "PyQt6>=6.5.2",
+  "PyQt6_sip>=13.5.2",
+  "opencv_python_headless>=4.8.1.78",
+  "pytest>=6.2.5",
+  "ipywidgets>=8.0.7",
+  "pandas",
+  "gradio",
 ]
 
 description = "Library to create flexible interactive image processing pipelines and automatically add a graphical user interface without knowing anything about GUI coding!"
@@ -56,4 +63,5 @@ full=[
   "pytest>=6.2.5",
   "ipywidgets>=8.0.7",
   "pandas",
-]
+  "gradio",
+]

{interactive_pipe-0.6.0 → interactive_pipe-0.7.0}/readme.md

@@ -1,7 +1,7 @@
 # `interactive_pipe`
 
 Quick setup
-`pip install interactive-pipe[full]`
+`pip install interactive-pipe`
 
 ### Concept
 - Develop an algorithm while debugging visually with plots, while checking robustness & continuity to parameters change.
@@ -22,8 +22,12 @@ Quick setup
 
 ----------------------
 
-### Setup
-`pip install interactive-pipe[full]`
+### Local setup
+```
+git clone git@github.com:balthazarneveu/interactive_pipe.git
+cd interactive-pipe
+pip install -e ".[full]"
+```
 
 ----------------------
 
@@ -46,7 +50,8 @@ Quick setup
 ----------------------
 
 ## :scroll:  Features
-**Version 0.6.0**
+
+**Version 0.7.0**
 - Modular multi-image processing filters
 - Declarative: Easily make graphical user interface without having to learn anything about pyQt or matplotlib
 - Support in jupyter notebooks
@@ -54,17 +59,10 @@ Quick setup
 - Cache intermediate results in RAM for much faster processing
 - `KeyboardControl` : no slider on UI but exactly the same internal mechanism, update on key press.
 - Support Curve plots (2D signals)
+- :new: gradio backend (+allows sharing with others)
 
-#### :soon: Upcoming features:
-- :soon: Scientific visual debugging: Display both colored images, heatmaps & graphs
 
 
-#### :test_tube: Experimental features
-- custom events on specific key press
-- Display the execution graph of the pipeline
-- [thirdparty/music](/src/interactive_pipe/thirdparty/music.py) Play audio (Qt backend only). Play songs on spotify (linux only) when the spotify app is running.
-- [thirdparty/images_openai_api](/src/interactive_pipe/thirdparty/images_openai_api.py) Generate images from prompt using OpenAI API image generation DALL-E Model (:dollar:  paid service ~ 2cents/image) 
-
 #### :keyboard:   Keyboard shortcuts
 Shortcuts while using the GUI (QT & matplotlib backends)
 
@@ -83,7 +81,8 @@ Shortcuts while using the GUI (QT & matplotlib backends)
 - supported backends 
     - :ok: `gui='qt'` pyQt/pySide 
     - :ok: `gui='mpl'` matplotlib
-    - :ok: `gui='nb'`  ipywidget for jupyter notebooks  
+    - :ok: `gui='nb'`  ipywidget for jupyter notebooks
+    - :test_tube: `gui='gradio'` gradio wrapping (+use `share_gradio_app=True` to share your app with others)
 - tested platforms
     - :ok: Linux (Ubuntu / KDE Neon)
     - :ok: RapsberryPi
@@ -91,16 +90,15 @@ Shortcuts while using the GUI (QT & matplotlib backends)
 
 
 
-| :star: | *PyQt / PySide* |  *Matplotlib*   | *Jupyter notebooks including Google collab*   |
-|:-----: |:-----:|:------:|:----: |
-| Backend name | `qt`  | `mpl`  | `nb`|
-| Preview | ![qt backend](/doc/images/qt_backend.jpg)   | ![mpl backend](/doc/images/mpl_backend.jpg)    |  ![nb backend](/doc/images/notebook_backend.jpg)  |
-| Plot curves | :heavy_check_mark: | :heavy_check_mark: |   :heavy_check_mark: |
-| Auto refreshed layout | :heavy_check_mark: | :heavy_check_mark: |   :heavy_check_mark: |
-| Keyboard shortcuts / fullscreen| :heavy_check_mark: | :heavy_check_mark: |  :heavy_minus_sign: |
-| Audio support | :heavy_check_mark: | :heavy_minus_sign: |  :heavy_minus_sign: |
-| Image buttons| :heavy_check_mark: | :heavy_minus_sign: |  :heavy_minus_sign: |
-
+| :star: | *PyQt / PySide* |  *Matplotlib*   | *Jupyter notebooks including Google collab*   | *Gradio* | 
+|:-----: |:-----:|:------:|:----: |:----: |
+| Backend name | `qt`  | `mpl`  | `nb`| `gradio` |
+| Preview | ![qt backend](/doc/images/qt_backend.jpg)   | ![mpl backend](/doc/images/mpl_backend.jpg)    |  ![nb backend](/doc/images/notebook_backend.jpg)  | | 
+| Plot curves | :heavy_check_mark: | :heavy_check_mark: |   :heavy_check_mark: | :heavy_check_mark:|
+| Auto refreshed layout | :heavy_check_mark: | :heavy_check_mark: |   :heavy_check_mark: | :heavy_minus_sign: |
+| Keyboard shortcuts / fullscreen| :heavy_check_mark: | :heavy_check_mark: |  :heavy_minus_sign: | :heavy_minus_sign: |
+| Audio support | :heavy_check_mark: | :heavy_minus_sign: |  :heavy_minus_sign: | :heavy_minus_sign: |
+| Image buttons| :heavy_check_mark: | :heavy_minus_sign: |  :heavy_minus_sign: | :heavy_minus_sign:| 
 
 
 
@@ -118,12 +116,7 @@ Shortcuts while using the GUI (QT & matplotlib backends)
 ![Speech processing exploration in a notebook](/doc/images/jupyter_integration_speech.png)
 
 
-#### [Minimalistic pytorch based ISP ](https://github.com/balthazarneveu/interactive_pipe/tree/sample_interactive_isp/samples/isp)
-[ISP means image signal processor](https://en.wikipedia.org/wiki/Image_processor)
 
-:warning: Work in progess (no proper demosaicking, no denoiser, no tone mapping.)
-
-![Ultra simplistic ISP](/doc/images/isp_pipeline.png)
 
 
 # Tutorials
@@ -214,7 +207,7 @@ def generate_flat_colored_image(color_choice=["red", "green", "blue", "gray"], g
 ```
 
 - Note that you can also create filters which take no inputs and simply "generate" images. 
-- The `color_choice` list will be turnt into a nice dropdown menu. Default value here will be red as this is the first element of the list!
+- The `color_choice` list will be turned into a nice dropdown menu. Default value here will be red as this is the first element of the list!
 ----------
 
 :bulb: Can filters communicate together?
@@ -268,7 +261,8 @@ if __name__ == '__main__':
 ### History
 - Interactive pipe was initially developped by [Balthazar Neveu](https://github.com/balthazarneveu) as part of the [irdrone project](https://github.com/wisescootering/infrareddrone/tree/master/interactive) based on matplotlib.
 - Later, more contributions were also made by [Giuseppe Moschetti](https://github.com/g-moschetti) and Sylvain Leroy.
-- Summer 2023: rewriting the whole core and supporting several graphical backends!
+- August 2023: rewriting the whole core and supporting several graphical backends!
+- September 2024: Gradio backend
 
 
 
@@ -287,4 +281,24 @@ if __name__ == '__main__':
     - Animations/While loops/Video source (Time slider)
 - Exploratory backends
     - Create a [textual](https://github.com/Textualize/textual) backend for simplified GUI (probably no images displayed)
-    - Create a [Kivy](https://kivy.org/) backend
+    - Create a [Kivy](https://kivy.org/) backend
+
+
+### Further examples
+
+#### [Minimalistic pytorch based ISP ](https://github.com/balthazarneveu/interactive_pipe/tree/sample_interactive_isp/samples/isp)
+[ISP means image signal processor](https://en.wikipedia.org/wiki/Image_processor)
+
+:warning: Work in progess (no proper demosaicking, no denoiser, no tone mapping.)
+
+![Ultra simplistic ISP](/doc/images/isp_pipeline.png)
+
+
+
+
+
+#### :test_tube: Experimental features
+- Custom events on specific key press
+- Display the execution graph of the pipeline `G` key
+- [thirdparty/music](/src/interactive_pipe/thirdparty/music.py) Play audio (Qt backend only). Play songs on spotify (linux only) when the spotify app is running.
+- [thirdparty/images_openai_api](/src/interactive_pipe/thirdparty/images_openai_api.py) Generate images from prompt using OpenAI API image generation DALL-E Model (:dollar:  paid service ~ 2cents/image) 

interactive_pipe-0.7.0/src/interactive_pipe/graphical/gradio_control.py

@@ -0,0 +1,95 @@
+
+from functools import partial
+from interactive_pipe.headless.control import Control
+import logging
+import gradio as gr
+
+
+class BaseControl():
+    def __init__(self, name, ctrl: Control, update_func):
+        super().__init__()
+        self.name = name
+        self.ctrl = ctrl
+        self.update_func = update_func
+        self.check_control_type()
+
+    def create(self):
+        raise NotImplementedError(
+            "This method should be overridden by subclass")
+
+    def check_control_type(self):
+        raise NotImplementedError(
+            "This method should be overridden by subclass to check the right slider control type")
+
+
+class ControlFactory:
+    @staticmethod
+    def create_control(control: Control, update_func):
+        control_type = control._type
+        name = control.name
+        control_class_map = {
+            bool: TickBoxControl,
+            int: IntSliderControl,
+            float: FloatSliderControl,
+            str: DropdownMenuControl
+        }
+
+        if control_type not in control_class_map:
+            logging.warning(
+                f"Unsupported control type: {control_type} for control named {name}")
+            return None
+
+        control_class = control_class_map[control_type]
+        return control_class(name, control, update_func)
+
+
+class IntSliderControl(BaseControl):
+    def check_control_type(self):
+        assert self.ctrl._type == int
+
+    def create(self) -> gr.Slider:
+        self.control_widget = gr.Slider(
+            value=self.ctrl.value_default, minimum=self.ctrl.value_range[0], maximum=self.ctrl.value_range[1], label=self.name, step=1)
+        return self.control_widget
+
+
+class FloatSliderControl(BaseControl):
+    def check_control_type(self):
+        assert self.ctrl._type == float
+
+    def create(self) -> gr.Slider:
+        self.control_widget = gr.Slider(
+            value=self.ctrl.value_default,
+            minimum=self.ctrl.value_range[0], maximum=self.ctrl.value_range[1], label=self.name)
+
+        return self.control_widget
+
+
+class TickBoxControl(BaseControl):
+    def check_control_type(self):
+        assert self.ctrl._type == bool
+
+    def create(self) -> gr.Checkbox:
+        self.control_widget = gr.Checkbox(label=self.name, value=self.ctrl.value)
+        return self.control_widget
+
+    def reset(self):
+        self.control_widget.update(value=self.ctrl.default_value)
+
+
+class DropdownMenuControl(BaseControl):
+    def check_control_type(self):
+        assert self.ctrl._type == str
+        if not hasattr(self.ctrl, 'value_range'):
+            raise ValueError("Invalid control type")
+
+    def create(self) -> gr.Dropdown:
+        # Create a horizontal layout to hold the dropdown menu
+        self.control_widget = gr.Dropdown(label=self.name, choices=self.ctrl.value_range, value=self.ctrl.value)
+        return self.control_widget
+
+    def reset(self):
+        index = self.control_widget.findText(self.ctrl.value)
+        if index >= 0:
+            self.control_widget.setCurrentIndex(index)
+        self.control_widget.setCurrentIndex(index)

interactive_pipe-0.7.0/src/interactive_pipe/graphical/gradio_gui.py

@@ -0,0 +1,173 @@
+import gradio as gr
+import numpy as np
+from typing import List
+from interactive_pipe.headless.pipeline import HeadlessPipeline
+from interactive_pipe.graphical.gradio_control import ControlFactory
+from interactive_pipe.graphical.window import InteractivePipeWindow
+from interactive_pipe.graphical.gui import InteractivePipeGUI
+from interactive_pipe.headless.control import Control
+import logging
+PYQTVERSION = None
+MPL_SUPPORT = False
+GRADIO_INTERFACE_MODE = False
+try:
+    from interactive_pipe.data_objects.curves import Curve
+    import matplotlib.pyplot as plt
+    MPL_SUPPORT = True
+except ImportError:
+    pass
+
+
+class InteractivePipeGradio(InteractivePipeGUI):
+    def init_app(self, **kwargs):
+        self.window = MainWindow(controls=self.controls, name=self.name,
+                                 pipeline=self.pipeline, size=self.size, main_gui=self, **kwargs)
+        self.pipeline.global_params["__pipeline"] = self.pipeline
+        # self.set_default_key_bindings()
+
+    def run(self) -> list:
+        assert self.pipeline._PipelineCore__initialized_inputs, "Did you forget to initialize the pipeline inputs?"
+        out_list = self.window.process_inputs_fn(*self.window.default_values)
+        out_list_gradio_containers = []
+        for idx in range(len(out_list)):
+            for idy in range(len(out_list[idx])):
+                if isinstance(out_list[idx][idy], np.ndarray):
+                    out_list_gradio_containers.append(gr.Image())
+                elif MPL_SUPPORT and isinstance(out_list[idx][idy], Curve):
+                    out_list_gradio_containers.append(gr.Plot())
+                else:
+                    raise NotImplementedError(
+                        f"output type {type(out_list[idx][idy])} not supported")
+        self.window.instantiate_gradio_interface(out_list_gradio_containers)
+        self.window.refresh()
+        self.custom_end()
+        return self.pipeline.results
+
+    def print_message(self, message_list: List[str]):
+        print("\n".join(message_list))
+
+
+class MainWindow(InteractivePipeWindow):
+    def __init__(self, *args, controls=[], name="", pipeline: HeadlessPipeline = None, size=None, share_gradio_app=False, **kwargs):
+        InteractivePipeWindow.__init__(
+            self, name=name, pipeline=pipeline, size=size)
+        self.init_sliders(controls)
+        self.size = size
+        self.full_screen_flag = False
+        self.pipeline = pipeline
+        self.share_gradio_app = share_gradio_app
+        # Define the functions that will be called when the input changes for gradio. => gr.Interface(fn=process_fn)
+
+        def process_outputs_fn(out) -> tuple:
+            flat_out = []
+            for idx in range(len(out)):
+                if isinstance(out[idx], list):
+                    for idy in range(len(out[idx])):
+                        if MPL_SUPPORT and isinstance(out[idx][idy], Curve):
+                            curve = out[idx][idy]
+                            fig, ax = plt.subplots()
+                            Curve._plot_curve(curve.data, ax=ax)
+                            flat_out.append(fig)
+                        elif isinstance(out[idx][idy], np.ndarray):
+                            logging.info(f"CONVERTING IMAGE  {idx} {idy}")
+                            flat_out.append(self.convert_image(out[idx][idy]))
+                        else:
+                            raise NotImplementedError(
+                                f"output type {type(out[idx][idy])} not supported")
+                else:
+                    logging.info(f"CONVERTING IMAGE  {idx} ")
+                    flat_out.append(self.convert_image(out[idx]))
+            if out is None:
+                logging.warning("No output to display")
+                return
+            return tuple(flat_out)
+
+        def process_inputs_fn(*args) -> list:
+            all_keys = list(self.ctrl.keys())
+            for idx in range(len(args)):
+                self.ctrl[all_keys[idx]].update(args[idx])
+            out = self.pipeline.run()
+            return out
+
+        def run_fn(*args) -> tuple:
+            out = process_inputs_fn(*args)
+            out_tuple = process_outputs_fn(out)
+            return out_tuple
+        self.default_values = [self.ctrl[ctrl_key].value for ctrl_key in self.ctrl.keys()]
+        self.process_inputs_fn = process_inputs_fn
+        self.run_fn = run_fn
+
+    def instantiate_gradio_interface(self, outputs: List[gr.Blocks]):
+        if GRADIO_INTERFACE_MODE:
+            # Interface mode, high level wrapper
+            # https://www.gradio.app/guides/the-interface-class
+            self.io = gr.Interface(
+                allow_flagging='never',
+                fn=self.run_fn,
+                title=self.name,
+                inputs=self.widget_list,
+                outputs=outputs,
+                examples=[self.default_values],
+                live=True,
+                show_progress="minimal",
+                clear_btn=None,
+            )
+        else:
+            # Gradio Blocks mode
+            # https://www.gradio.app/guides/blocks-and-event-listeners
+            with gr.Blocks() as io:
+                with gr.Row():
+                    for elem in outputs:
+                        elem.render()
+                with gr.Row():
+                    for elem in self.widget_list:
+                        with gr.Row():
+                            elem.render()
+                with gr.Row():
+                    gr.Examples([self.default_values], inputs=self.widget_list)
+                io.load(fn=self.run_fn, inputs=self.widget_list, outputs=outputs)
+                for idx in range(len(self.widget_list)):
+                    self.widget_list[idx].change(
+                        fn=self.run_fn, inputs=self.widget_list,
+                        outputs=outputs,
+                        show_progress="minimal"
+                    )
+            self.io = io
+        self.io.launch(share=self.share_gradio_app)
+
+    def init_sliders(self, controls: List[Control]):
+        self.ctrl = {}
+        self.result_label = {}
+        self.name_label = {}
+        self.widget_list = []
+        control_factory = ControlFactory()
+        for ctrl in controls:
+            if isinstance(ctrl, Control):
+                slider_instance = control_factory.create_control(
+                    ctrl, None)
+                control_widget = slider_instance.create()
+                self.widget_list.append(control_widget)
+            slider_name = ctrl.name
+            self.ctrl[slider_name] = ctrl
+
+    @staticmethod
+    def convert_image(out_im):
+        if isinstance(out_im, np.ndarray):
+            return (out_im.clip(0., 1.) * 255).astype(np.uint8)
+        else:
+            return out_im
+
+    def refresh(self):
+        if self.pipeline is not None:
+            self.io.launch()
+
+    def reset_sliders(self):
+        # Click on default examples in Gradio
+        pass
+
+    def add_image_placeholder(self, row, col):
+        ax_placeholder = None
+        text_label = None
+        image_label = None
+        self.image_canvas[row][col] = {
+            "image": image_label, "title": text_label, "ax_placeholder": ax_placeholder}

{interactive_pipe-0.6.0 → interactive_pipe-0.7.0}/src/interactive_pipe/helper/choose_backend.py

@@ -35,6 +35,8 @@ def get_interactive_pipeline_class(gui="auto"):
         from interactive_pipe.graphical.mpl_gui import InteractivePipeMatplotlib as ChosenGui
     elif selected_gui == "nb":
         from interactive_pipe.graphical.nb_gui import InteractivePipeJupyter as ChosenGui
+    elif selected_gui == "gradio":
+        from interactive_pipe.graphical.gradio_gui import InteractivePipeGradio as ChosenGui
     else:
         raise NotImplementedError(f"Gui {gui} not available")
     return ChosenGui

{interactive_pipe-0.6.0 → interactive_pipe-0.7.0/src/interactive_pipe.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: interactive_pipe
-Version: 0.6.0
+Version: 0.7.0
 Summary: Library to create flexible interactive image processing pipelines and automatically add a graphical user interface without knowing anything about GUI coding!
 Author-email: Balthazar Neveu <balthazarneveu@gmail.com>
 Project-URL: Homepage, https://github.com/balthazarneveu/interactive_pipe
@@ -15,6 +15,13 @@ Requires-Dist: matplotlib>=3.5.3
 Requires-Dist: numpy>=1.21.6
 Requires-Dist: Pillow>=9.0.1
 Requires-Dist: PyYAML>=5.4.1
+Requires-Dist: PyQt6>=6.5.2
+Requires-Dist: PyQt6_sip>=13.5.2
+Requires-Dist: opencv_python_headless>=4.8.1.78
+Requires-Dist: pytest>=6.2.5
+Requires-Dist: ipywidgets>=8.0.7
+Requires-Dist: pandas
+Requires-Dist: gradio
 Provides-Extra: qt6
 Requires-Dist: PyQt6>=6.5.2; extra == "qt6"
 Requires-Dist: PyQt6_sip>=13.5.2; extra == "qt6"
@@ -33,11 +40,12 @@ Requires-Dist: opencv_python_headless>=4.8.1.78; extra == "full"
 Requires-Dist: pytest>=6.2.5; extra == "full"
 Requires-Dist: ipywidgets>=8.0.7; extra == "full"
 Requires-Dist: pandas; extra == "full"
+Requires-Dist: gradio; extra == "full"
 
 # `interactive_pipe`
 
 Quick setup
-`pip install interactive-pipe[full]`
+`pip install interactive-pipe`
 
 ### Concept
 - Develop an algorithm while debugging visually with plots, while checking robustness & continuity to parameters change.
@@ -58,8 +66,12 @@ Quick setup
 
 ----------------------
 
-### Setup
-`pip install interactive-pipe[full]`
+### Local setup
+```
+git clone git@github.com:balthazarneveu/interactive_pipe.git
+cd interactive-pipe
+pip install -e ".[full]"
+```
 
 ----------------------
 
@@ -82,7 +94,8 @@ Quick setup
 ----------------------
 
 ## :scroll:  Features
-**Version 0.6.0**
+
+**Version 0.7.0**
 - Modular multi-image processing filters
 - Declarative: Easily make graphical user interface without having to learn anything about pyQt or matplotlib
 - Support in jupyter notebooks
@@ -90,16 +103,9 @@ Quick setup
 - Cache intermediate results in RAM for much faster processing
 - `KeyboardControl` : no slider on UI but exactly the same internal mechanism, update on key press.
 - Support Curve plots (2D signals)
-
-#### :soon: Upcoming features:
-- :soon: Scientific visual debugging: Display both colored images, heatmaps & graphs
+- :new: gradio backend (+allows sharing with others)
 
 
-#### :test_tube: Experimental features
-- custom events on specific key press
-- Display the execution graph of the pipeline
-- [thirdparty/music](/src/interactive_pipe/thirdparty/music.py) Play audio (Qt backend only). Play songs on spotify (linux only) when the spotify app is running.
-- [thirdparty/images_openai_api](/src/interactive_pipe/thirdparty/images_openai_api.py) Generate images from prompt using OpenAI API image generation DALL-E Model (:dollar:  paid service ~ 2cents/image) 
 
 #### :keyboard:   Keyboard shortcuts
 Shortcuts while using the GUI (QT & matplotlib backends)
@@ -119,7 +125,8 @@ Shortcuts while using the GUI (QT & matplotlib backends)
 - supported backends 
     - :ok: `gui='qt'` pyQt/pySide 
     - :ok: `gui='mpl'` matplotlib
-    - :ok: `gui='nb'`  ipywidget for jupyter notebooks  
+    - :ok: `gui='nb'`  ipywidget for jupyter notebooks
+    - :test_tube: `gui='gradio'` gradio wrapping (+use `share_gradio_app=True` to share your app with others)
 - tested platforms
     - :ok: Linux (Ubuntu / KDE Neon)
     - :ok: RapsberryPi
@@ -127,16 +134,15 @@ Shortcuts while using the GUI (QT & matplotlib backends)
 
 
 
-| :star: | *PyQt / PySide* |  *Matplotlib*   | *Jupyter notebooks including Google collab*   |
-|:-----: |:-----:|:------:|:----: |
-| Backend name | `qt`  | `mpl`  | `nb`|
-| Preview | ![qt backend](/doc/images/qt_backend.jpg)   | ![mpl backend](/doc/images/mpl_backend.jpg)    |  ![nb backend](/doc/images/notebook_backend.jpg)  |
-| Plot curves | :heavy_check_mark: | :heavy_check_mark: |   :heavy_check_mark: |
-| Auto refreshed layout | :heavy_check_mark: | :heavy_check_mark: |   :heavy_check_mark: |
-| Keyboard shortcuts / fullscreen| :heavy_check_mark: | :heavy_check_mark: |  :heavy_minus_sign: |
-| Audio support | :heavy_check_mark: | :heavy_minus_sign: |  :heavy_minus_sign: |
-| Image buttons| :heavy_check_mark: | :heavy_minus_sign: |  :heavy_minus_sign: |
-
+| :star: | *PyQt / PySide* |  *Matplotlib*   | *Jupyter notebooks including Google collab*   | *Gradio* | 
+|:-----: |:-----:|:------:|:----: |:----: |
+| Backend name | `qt`  | `mpl`  | `nb`| `gradio` |
+| Preview | ![qt backend](/doc/images/qt_backend.jpg)   | ![mpl backend](/doc/images/mpl_backend.jpg)    |  ![nb backend](/doc/images/notebook_backend.jpg)  | | 
+| Plot curves | :heavy_check_mark: | :heavy_check_mark: |   :heavy_check_mark: | :heavy_check_mark:|
+| Auto refreshed layout | :heavy_check_mark: | :heavy_check_mark: |   :heavy_check_mark: | :heavy_minus_sign: |
+| Keyboard shortcuts / fullscreen| :heavy_check_mark: | :heavy_check_mark: |  :heavy_minus_sign: | :heavy_minus_sign: |
+| Audio support | :heavy_check_mark: | :heavy_minus_sign: |  :heavy_minus_sign: | :heavy_minus_sign: |
+| Image buttons| :heavy_check_mark: | :heavy_minus_sign: |  :heavy_minus_sign: | :heavy_minus_sign:| 
 
 
 
@@ -154,12 +160,7 @@ Shortcuts while using the GUI (QT & matplotlib backends)
 ![Speech processing exploration in a notebook](/doc/images/jupyter_integration_speech.png)
 
 
-#### [Minimalistic pytorch based ISP ](https://github.com/balthazarneveu/interactive_pipe/tree/sample_interactive_isp/samples/isp)
-[ISP means image signal processor](https://en.wikipedia.org/wiki/Image_processor)
 
-:warning: Work in progess (no proper demosaicking, no denoiser, no tone mapping.)
-
-![Ultra simplistic ISP](/doc/images/isp_pipeline.png)
 
 
 # Tutorials
@@ -250,7 +251,7 @@ def generate_flat_colored_image(color_choice=["red", "green", "blue", "gray"], g
 ```
 
 - Note that you can also create filters which take no inputs and simply "generate" images. 
-- The `color_choice` list will be turnt into a nice dropdown menu. Default value here will be red as this is the first element of the list!
+- The `color_choice` list will be turned into a nice dropdown menu. Default value here will be red as this is the first element of the list!
 ----------
 
 :bulb: Can filters communicate together?
@@ -304,7 +305,8 @@ if __name__ == '__main__':
 ### History
 - Interactive pipe was initially developped by [Balthazar Neveu](https://github.com/balthazarneveu) as part of the [irdrone project](https://github.com/wisescootering/infrareddrone/tree/master/interactive) based on matplotlib.
 - Later, more contributions were also made by [Giuseppe Moschetti](https://github.com/g-moschetti) and Sylvain Leroy.
-- Summer 2023: rewriting the whole core and supporting several graphical backends!
+- August 2023: rewriting the whole core and supporting several graphical backends!
+- September 2024: Gradio backend
 
 
 
@@ -324,3 +326,23 @@ if __name__ == '__main__':
 - Exploratory backends
     - Create a [textual](https://github.com/Textualize/textual) backend for simplified GUI (probably no images displayed)
     - Create a [Kivy](https://kivy.org/) backend
+
+
+### Further examples
+
+#### [Minimalistic pytorch based ISP ](https://github.com/balthazarneveu/interactive_pipe/tree/sample_interactive_isp/samples/isp)
+[ISP means image signal processor](https://en.wikipedia.org/wiki/Image_processor)
+
+:warning: Work in progess (no proper demosaicking, no denoiser, no tone mapping.)
+
+![Ultra simplistic ISP](/doc/images/isp_pipeline.png)
+
+
+
+
+
+#### :test_tube: Experimental features
+- Custom events on specific key press
+- Display the execution graph of the pipeline `G` key
+- [thirdparty/music](/src/interactive_pipe/thirdparty/music.py) Play audio (Qt backend only). Play songs on spotify (linux only) when the spotify app is running.
+- [thirdparty/images_openai_api](/src/interactive_pipe/thirdparty/images_openai_api.py) Generate images from prompt using OpenAI API image generation DALL-E Model (:dollar:  paid service ~ 2cents/image) 

{interactive_pipe-0.6.0 → interactive_pipe-0.7.0}/src/interactive_pipe.egg-info/SOURCES.txt

@@ -20,6 +20,8 @@ src/interactive_pipe/data_objects/data.py
 src/interactive_pipe/data_objects/image.py
 src/interactive_pipe/data_objects/parameters.py
 src/interactive_pipe/graphical/__init__.py
+src/interactive_pipe/graphical/gradio_control.py
+src/interactive_pipe/graphical/gradio_gui.py
 src/interactive_pipe/graphical/gui.py
 src/interactive_pipe/graphical/mpl_control.py
 src/interactive_pipe/graphical/mpl_gui.py

{interactive_pipe-0.6.0 → interactive_pipe-0.7.0}/src/interactive_pipe.egg-info/requires.txt

@@ -2,6 +2,13 @@ matplotlib>=3.5.3
 numpy>=1.21.6
 Pillow>=9.0.1
 PyYAML>=5.4.1
+PyQt6>=6.5.2
+PyQt6_sip>=13.5.2
+opencv_python_headless>=4.8.1.78
+pytest>=6.2.5
+ipywidgets>=8.0.7
+pandas
+gradio
 
 [full]
 PyQt6>=6.5.2
@@ -10,6 +17,7 @@ opencv_python_headless>=4.8.1.78
 pytest>=6.2.5
 ipywidgets>=8.0.7
 pandas
+gradio
 
 [notebook]
 ipywidgets>=8.0.7