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

{interactive_pipe-0.5.8 → interactive_pipe-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: interactive_pipe
-Version: 0.5.8
+Version: 0.6.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
@@ -11,8 +11,34 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: matplotlib>=3.5.3
+Requires-Dist: numpy>=1.21.6
+Requires-Dist: Pillow>=9.0.1
+Requires-Dist: PyYAML>=5.4.1
+Provides-Extra: qt6
+Requires-Dist: PyQt6>=6.5.2; extra == "qt6"
+Requires-Dist: PyQt6_sip>=13.5.2; extra == "qt6"
+Provides-Extra: qt5
+Requires-Dist: PyQt5>=5.15.9; extra == "qt5"
+Requires-Dist: PyQt5_sip>=12.12.1; extra == "qt5"
+Provides-Extra: notebook
+Requires-Dist: ipywidgets>=8.0.7; extra == "notebook"
+Provides-Extra: pytest
+Requires-Dist: opencv_python_headless>=4.8.1.78; extra == "pytest"
+Requires-Dist: pytest>=6.2.5; extra == "pytest"
+Provides-Extra: full
+Requires-Dist: PyQt6>=6.5.2; extra == "full"
+Requires-Dist: PyQt6_sip>=13.5.2; extra == "full"
+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"
 
 # `interactive_pipe`
+
+Quick setup
+`pip install interactive-pipe[full]`
+
 ### Concept
 - Develop an algorithm while debugging visually with plots, while checking robustness & continuity to parameters change.
 - Magically create a graphical interface to easily demonstrate a concept or simply tune your algorithm.
@@ -33,7 +59,7 @@ License-File: LICENSE
 ----------------------
 
 ### Setup
-`pip3 install interactive-pipe`
+`pip install interactive-pipe[full]`
 
 ----------------------
 
@@ -56,7 +82,7 @@ License-File: LICENSE
 ----------------------
 
 ## :scroll:  Features
-**Version 0.5.8**
+**Version 0.6.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
@@ -117,6 +143,12 @@ Shortcuts while using the GUI (QT & matplotlib backends)
 # Tutorials
 
 ### Learn by examples
+#### [Basic image processing](/demo/multi_image.py)
+| GUI | Pipeline | 
+|:--:|:--:| 
+|![](/doc/images/image_selector.png) | ![](/doc/images/image_selector_graph.png) |
+
+![](/doc/images/demo_multi_image.gif)
 
 #### [Speech exploration notebook](https://colab.research.google.com/drive/1mUX2FW0qflWn-v3nIx90P_KvRxnXlBpz#scrollTo=qDTaIwvaJQ6R)
 ![Speech processing exploration in a notebook](/doc/images/jupyter_integration_speech.png)

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

@@ -5,10 +5,17 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "interactive_pipe"
-version = "0.5.8"
+version = "0.6.0"
 authors = [
   { name="Balthazar Neveu", email="balthazarneveu@gmail.com" },
 ]
+dependencies = [
+  "matplotlib>=3.5.3",
+  "numpy>=1.21.6",
+  "Pillow>=9.0.1",
+  "PyYAML>=5.4.1",
+]
+
 description = "Library to create flexible interactive image processing pipelines and automatically add a graphical user interface without knowing anything about GUI coding!"
 readme = "readme.md"
 requires-python = ">=3.7"
@@ -20,4 +27,33 @@ classifiers = [
 
 [project.urls]
 "Homepage" = "https://github.com/balthazarneveu/interactive_pipe"
-"Bug Tracker" = "https://github.com/balthazarneveu/interactive_pipe/issues"
+"Bug Tracker" = "https://github.com/balthazarneveu/interactive_pipe/issues"
+
+[project.optional-dependencies]
+qt6=[
+  "PyQt6>=6.5.2",
+  "PyQt6_sip>=13.5.2",
+]
+
+qt5=[
+  "PyQt5>=5.15.9",
+  "PyQt5_sip>=12.12.1",
+]
+
+notebook=[
+  "ipywidgets>=8.0.7",
+]
+
+pytest=[
+  "opencv_python_headless>=4.8.1.78",
+  "pytest>=6.2.5"
+]
+
+full=[
+  "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",
+]

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

@@ -1,4 +1,8 @@
 # `interactive_pipe`
+
+Quick setup
+`pip install interactive-pipe[full]`
+
 ### Concept
 - Develop an algorithm while debugging visually with plots, while checking robustness & continuity to parameters change.
 - Magically create a graphical interface to easily demonstrate a concept or simply tune your algorithm.
@@ -19,7 +23,7 @@
 ----------------------
 
 ### Setup
-`pip3 install interactive-pipe`
+`pip install interactive-pipe[full]`
 
 ----------------------
 
@@ -42,7 +46,7 @@
 ----------------------
 
 ## :scroll:  Features
-**Version 0.5.8**
+**Version 0.6.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
@@ -103,6 +107,12 @@ Shortcuts while using the GUI (QT & matplotlib backends)
 # Tutorials
 
 ### Learn by examples
+#### [Basic image processing](/demo/multi_image.py)
+| GUI | Pipeline | 
+|:--:|:--:| 
+|![](/doc/images/image_selector.png) | ![](/doc/images/image_selector_graph.png) |
+
+![](/doc/images/demo_multi_image.gif)
 
 #### [Speech exploration notebook](https://colab.research.google.com/drive/1mUX2FW0qflWn-v3nIx90P_KvRxnXlBpz#scrollTo=qDTaIwvaJQ6R)
 ![Speech processing exploration in a notebook](/doc/images/jupyter_integration_speech.png)

{interactive_pipe-0.5.8 → interactive_pipe-0.6.0}/src/interactive_pipe/__init__.py

@@ -1,4 +1,4 @@
 from interactive_pipe.helper.pipeline_decorator import pipeline, interactive_pipeline
 from interactive_pipe.headless.control import Control
-from interactive_pipe.headless.keyboard import  KeyboardControl
-from interactive_pipe.helper.filter_decorator import interactive, interact
+from interactive_pipe.headless.keyboard import KeyboardControl
+from interactive_pipe.helper.filter_decorator import interactive, interact

{interactive_pipe-0.5.8 → interactive_pipe-0.6.0}/src/interactive_pipe/core/cache.py

@@ -1,6 +1,6 @@
 import logging
 from copy import deepcopy
-from typing import Any, Dict
+from typing import Any
 
 
 class CachedResults:
@@ -8,7 +8,7 @@ class CachedResults:
     Helper class to store the results of a Filter.
 
     The overall purpose of these classes is to prevent unnecessary computations by reusing the
-    results of previous filter operations when the input parameters have not changed. 
+    results of previous filter operations when the input parameters have not changed.
     This is accomplished by storing the results of the filter operations and the parameters
     used in those operations, and checking for changes in the parameters
     before re-computing the results.
@@ -20,7 +20,7 @@ class CachedResults:
 
     Please note that if you use safe_buffer_deepcopy=False,
     only pointers are copied when updating the cache, no deepcopy is performed here.
-    You should only use safe_buffer_deepcopy=False 
+    You should only use safe_buffer_deepcopy=False
     if you're 100% sure you don't do inplace modifications.
 
     Underlying class used in the interactive pipe cache mechanism.
@@ -76,7 +76,7 @@ class CachedResults:
 class StateChange:
     """
     Helper class to check whether or not input parameters have been updated.
-    
+
     Underlying class used in the interactive pipe cache mechanism.
     """
 

{interactive_pipe-0.5.8 → interactive_pipe-0.6.0}/src/interactive_pipe/core/engine.py

@@ -7,6 +7,7 @@ from typing import List
 from interactive_pipe.core.cache import CachedResults
 from interactive_pipe.core.filter import FilterCore
 
+
 class PipelineEngine:
     def __init__(self, cache=False, safe_input_buffer_deepcopy=True) -> None:
         self.cache = cache
@@ -21,7 +22,8 @@ class PipelineEngine:
                 for input_index, inp in enumerate(imglst):
                     if self.safe_input_buffer_deepcopy:
                         result[input_index] = deepcopy(inp)
-                        logging.debug(f"<<< Deepcopy input images {input_index}")
+                        logging.debug(
+                            f"<<< Deepcopy input images {input_index}")
                     else:
                         result[input_index] = inp
             elif isinstance(imglst, dict):
@@ -56,7 +58,8 @@ class PipelineEngine:
                     if prc.inputs:
                         routing_in = [
                             result[idi] if idi is not None else None for idi in prc.inputs]
-                    logging.debug("in types->", [type(inp) for inp in routing_in])
+                    logging.debug("in types->", [type(inp)
+                                  for inp in routing_in])
                     out = prc.run(*routing_in)
                     if out is not None:
                         logging.debug("out types->", [type(ou) for ou in out])
@@ -83,4 +86,4 @@ class PipelineEngine:
         # Limit result using self.numfigs but with indices pointed by last filter
         logging.info("\n".join(performances))
         logging.info(f"Full buffer: {len(result)}")
-        return result
+        return result

{interactive_pipe-0.5.8 → interactive_pipe-0.6.0}/src/interactive_pipe/core/filter.py

@@ -5,13 +5,14 @@ from typing import Callable, List, Optional, Union, Tuple, Any
 from interactive_pipe.core.cache import CachedResults
 from interactive_pipe.core.signature import analyze_apply_fn_signature
 
+
 class PureFilter:
     def __init__(self, apply_fn: Optional[Callable] = None, name: Optional[str] = None, default_params: dict = {}):
         self.name = name if name else (
             self.__class__.__name__ if not apply_fn else apply_fn.__name__)
         if apply_fn is not None:
             self.apply = apply_fn
-        self.__initialize_default_values() # initialize default values from .apply method
+        self.__initialize_default_values()  # initialize default values from .apply method
         self.values = deepcopy(default_params)
 
     @property
@@ -34,14 +35,14 @@ class PureFilter:
             self.signature = (self.__args_names, self.__kwargs_names)
         else:  # skip computing signature
             pass
-    
+
     def __initialize_default_values(self):
         assert not hasattr(self, "_values")
         self.check_apply_signature()
         self._values = self.__kwargs_names
         if "global_params" in self.__kwargs_names.keys():
             self._values.pop("global_params")
-    
+
     @property
     def values(self):
         return self._values
@@ -70,6 +71,7 @@ class PureFilter:
 
 class FilterCore(PureFilter):
     """PureFilter with cache storage + routing nodes defined (inputs & outputs fields)"""
+
     def __init__(self,
                  apply_fn: Callable = None,
                  name: Optional[str] = None,
@@ -108,19 +110,21 @@ class FilterCore(PureFilter):
             assert len(out) >= len(
                 self.outputs), "number of outputs shall be at least greater or equal to what's expected by the filter"
             return out
-        
+
         else:
-            logging.debug(f"need to return a tuple when you have a single element out {type(out)}")
-            assert len(self.outputs)==1, "returning a single element!" 
+            logging.debug(
+                f"need to return a tuple when you have a single element out {type(out)}")
+            assert len(self.outputs) == 1, "returning a single element!"
             return (out,)
-    
+
     def __repr__(self) -> str:
         descr = f"{self.name}: "
         descr += "(" + (", ".join([f"{it}" for it in self.inputs])) + ")"
-        descr += " -> " + "(" + ", ".join([f"{it}" for it in self.outputs]) + ")"
+        descr += " -> " + \
+            "(" + ", ".join([f"{it}" for it in self.outputs]) + ")"
         # descr += "\n"
         return descr
-    
+
     def __call__(self, *args: Any, **kwargs: Any) -> Any:
         control_dict = {}
         if hasattr(self, "controls"):
@@ -128,4 +132,4 @@ class FilterCore(PureFilter):
                 control_dict[ctrl_name] = ctrl.value
         merged_kwargs = {**kwargs, **control_dict}
         out = self.apply(*args, **merged_kwargs)
-        return out
+        return out

{interactive_pipe-0.5.8 → interactive_pipe-0.6.0}/src/interactive_pipe/core/graph.py

@@ -5,6 +5,7 @@ from typing import List, Callable, Tuple, Optional, Union
 from interactive_pipe.core.filter import FilterCore
 from interactive_pipe.core.signature import analyze_apply_fn_signature
 
+
 def get_name(node: ast.NodeVisitor) -> Union[str, List[str], None]:
     if isinstance(node, ast.Name):
         return node.id
@@ -14,8 +15,9 @@ def get_name(node: ast.NodeVisitor) -> Union[str, List[str], None]:
         return [get_name(elt) for elt in node.elts]
     else:
         return None
-    
-def flatten_target_names(targets: List[Union[list, str, None]], mapping_function: Optional[Callable]=None) -> List[str]:
+
+
+def flatten_target_names(targets: List[Union[list, str, None]], mapping_function: Optional[Callable] = None) -> List[str]:
     output_names = []
     for target in targets:
         target_name = mapping_function(target) if mapping_function else target
@@ -29,7 +31,7 @@ def flatten_target_names(targets: List[Union[list, str, None]], mapping_function
     return output_names
 
 
-def get_call_graph(func:Callable, global_context=None) -> dict:
+def get_call_graph(func: Callable, global_context=None) -> dict:
     code = inspect.getsource(func)
     tree = ast.parse(code)
     results = []
@@ -53,10 +55,13 @@ def get_call_graph(func:Callable, global_context=None) -> dict:
             value = node.value
             if isinstance(value, ast.Call):
                 function_name = get_name(value.func)
-                logging.debug(f"classic function with assignment {function_name}")
-                assert function_name in global_context.keys(), f"Probably mispelled {function_name}"
+                logging.debug(
+                    f"classic function with assignment {function_name}")
+                assert function_name in global_context.keys(
+                ), f"Probably mispelled {function_name}"
                 input_names = [get_name(arg) for arg in value.args]
-                output_names = flatten_target_names(targets, mapping_function=get_name)
+                output_names = flatten_target_names(
+                    targets, mapping_function=get_name)
                 function_object = global_context[function_name]
                 if isinstance(function_object, FilterCore):
                     # Case of a filter instance
@@ -73,16 +78,18 @@ def get_call_graph(func:Callable, global_context=None) -> dict:
                     sig = analyze_apply_fn_signature(function_object)
                     function_apply = global_context[function_name]
                 else:
-                    raise TypeError(f"Not supported {function_name} - should be function or FilterCore")
+                    raise TypeError(
+                        f"Not supported {function_name} - should be function or FilterCore")
                 results.append({
                     "function_name": function_name,
                     "function_object": function_apply,
-                    "signature" : {"args": sig[0], "kwargs": sig[1]},
+                    "signature": {"args": sig[0], "kwargs": sig[1]},
                     "args": input_names,
                     "returns": output_names,
                 })
     main_function = tree.body[0]
-    outputs = [get_name(ret.value)  for ret in main_function.body if isinstance(ret, ast.Return)]
+    outputs = [get_name(ret.value)
+               for ret in main_function.body if isinstance(ret, ast.Return)]
     assert len(outputs) <= 1, "cannot return several times!"
     outputs = flatten_target_names(outputs, mapping_function=None)
     inputs, kwargs = analyze_apply_fn_signature(func)

{interactive_pipe-0.5.8 → interactive_pipe-0.6.0}/src/interactive_pipe/core/pipeline.py

@@ -3,6 +3,7 @@ from interactive_pipe.core.filter import FilterCore
 from interactive_pipe.core.engine import PipelineEngine
 import logging
 
+
 class PipelineCore:
     """A pipeline is defined as the combination of:
     - a list of filters
@@ -10,19 +11,21 @@ class PipelineCore:
     - optionally, some inputs to process
     """
 
-    def __init__(self, filters: List[FilterCore], name="pipeline", cache=False, inputs: Optional[list] = None, parameters: dict = {}, global_params={}, outputs:  Optional[list]=None, safe_input_buffer_deepcopy: bool=True):
+    def __init__(self, filters: List[FilterCore], name="pipeline", cache=False, inputs: Optional[list] = None, parameters: dict = {}, global_params={}, outputs:  Optional[list] = None, safe_input_buffer_deepcopy: bool = True):
         if not all(isinstance(f, FilterCore) for f in filters):
             raise ValueError(
                 f"All elements in 'filters' must be instances of 'Filter'. {[type(f) for f in filters]}")
         self.filters = filters
-        self.engine = PipelineEngine(cache, safe_input_buffer_deepcopy=safe_input_buffer_deepcopy)
+        self.engine = PipelineEngine(
+            cache, safe_input_buffer_deepcopy=safe_input_buffer_deepcopy)
         self.global_params = global_params
         for filter in self.filters:
             # link each filter to global params
             filter.global_params = self.global_params
         self.reset_cache()
         if inputs is None:
-            logging.warning("Setting a pipeline without input -  use inputs=[] to get rid of this warning")
+            logging.warning(
+                "Setting a pipeline without input -  use inputs=[] to get rid of this warning")
             self.inputs_routing = []
         else:
             self.inputs_routing = inputs
@@ -30,9 +33,10 @@ class PipelineCore:
         self.__initialized_inputs = False
         if outputs is None:
             outputs = self.filters[-1].outputs
-            logging.warning(f"Using last filter outputs {self.filters[-1]} {outputs}")
-            
-        self.outputs = outputs # output indexes (routing)
+            logging.warning(
+                f"Using last filter outputs {self.filters[-1]} {outputs}")
+
+        self.outputs = outputs  # output indexes (routing)
         # You need to set the values to their default_value for each filter
         self.parameters = parameters
         self.results = None
@@ -46,14 +50,14 @@ class PipelineCore:
         """Useful for standalone python acess without gui or disk write
         """
         return self.engine.run(self.filters, imglst=self.inputs)
-    
+
     @property
     def parameters(self):
         parameters = {}
         for filt in self.filters:
             parameters[filt.name] = filt.values
         return parameters
-    
+
     @parameters.setter
     def parameters(self, new_parameters: Dict[str, any]):
         """Force tuning parameters
@@ -76,14 +80,14 @@ class PipelineCore:
         available_filters_names = [filt.name for filt in self.filters]
         for filter_name in new_parameters.keys():
             assert filter_name in available_filters_names, f"filter {filter_name} does not exist {available_filters_names}"
-            self.filters[available_filters_names.index(filter_name)].values = new_parameters[filter_name]
-    
+            self.filters[available_filters_names.index(
+                filter_name)].values = new_parameters[filter_name]
 
     @property
     def inputs(self):
         assert self.__initialized_inputs, "Cannot access unitialized inputs!"
         return self.__inputs
-    
+
     @inputs.setter
     def inputs(self, inputs: list):
         if inputs is not None:
@@ -94,7 +98,8 @@ class PipelineCore:
                 self.__inputs = inputs
             elif isinstance(inputs, list) or isinstance(inputs, tuple):
                 # inputs is a list or a tuple
-                assert len(inputs) == len(self.inputs_routing), f"wrong amount of inputs\nprovided {len(inputs)} inputs vs expected:{len(self.inputs_routing)}"
+                assert len(inputs) == len(
+                    self.inputs_routing), f"wrong amount of inputs\nprovided {len(inputs)} inputs vs expected:{len(self.inputs_routing)}"
                 self.__inputs = {}
                 for idx, input_name in enumerate(self.inputs_routing):
                     self.__inputs[input_name] = inputs[idx]
@@ -104,9 +109,11 @@ class PipelineCore:
                 self.__inputs = {self.inputs_routing[0]: inputs}
             assert isinstance(self.__inputs, dict)
             if len(self.__inputs.keys()) == 0:
-                self.__inputs = None # similar to having no input, but explicitly saying that we have initialized it.
+                # similar to having no input, but explicitly saying that we have initialized it.
+                self.__inputs = None
         else:
-            assert self.inputs_routing is None or ((isinstance(self.inputs_routing, tuple) or isinstance(self.inputs_routing, list)) and len(self.inputs_routing)==0)
+            assert self.inputs_routing is None or ((isinstance(self.inputs_routing, tuple) or isinstance(
+                self.inputs_routing, list)) and len(self.inputs_routing) == 0)
             self.__inputs = None
         self.__initialized_inputs = True
         self.reset_cache()

{interactive_pipe-0.5.8 → interactive_pipe-0.6.0}/src/interactive_pipe/core/signature.py

@@ -1,6 +1,7 @@
 import inspect
 from typing import Callable, Tuple
 
+
 def analyze_apply_fn_signature(apply_fn: Callable) -> Tuple[dict, dict]:
     signature = inspect.signature(apply_fn)
     keyword_args = {
@@ -14,4 +15,4 @@ def analyze_apply_fn_signature(apply_fn: Callable) -> Tuple[dict, dict]:
         for k, v in signature.parameters.items()
         if v.default is inspect.Parameter.empty
     ]
-    return positional_args, keyword_args
+    return positional_args, keyword_args