add gifs for backend speeds

.gitattributes

@@ -33,3 +33,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+*gif* filter=lfs diff=lfs merge=lfs -text

library.py

@@ -7,26 +7,39 @@ from interactive_pipe import Curve, SingleCurve
 # -----------------
 
 
-def gen_color(frequency=0, isotropy=0.):
+def gen_color(
+    frequency: int = 0,  # discrete slider (int)
+    isotropy: float = 0.,  # continuous slider (float)
+) -> np.ndarray:
     lin_coord = np.linspace(0, 1., 256)
     X, Y = np.meshgrid(lin_coord, isotropy*lin_coord)
     radius = 0.5+0.5*np.cos(frequency*np.sqrt(X**2 + Y**2))
     return np.stack([np.abs(X), np.abs(Y), radius], axis=-1).clip(0, 1)
 
 
-def modify_geometry(img, effect="flip"):
+def modify_geometry(
+    img: np.ndarray,
+    effect: str = "flip"  # dropdown menus (str)
+) -> np.ndarray:
     img = img[::-1] if "flip" in effect else img
     img = img[:, ::-1] if "mirror" in effect else img
     return img
 
 
-def change_color(img, bnw=True):
+def change_color(
+    img: np.ndarray,
+    bnw: bool = True  # checkboxes (bool)
+):
     if bnw:
         return np.mean(img, axis=-1, keepdims=True).repeat(3, axis=-1)
     return img
 
 
-def compare_by_splitting(img_1, img_2, ratio=0.5):
+def compare_by_splitting(
+    img_1: np.ndarray,
+    img_2: np.ndarray,
+    ratio: float = 0.5,  # continuous slider (float)
+) -> np.ndarray:
     out = np.zeros_like(img_1)
     split = int(ratio*img_1.shape[1])
     out[:, :split] = img_2[:, :split]
@@ -34,7 +47,7 @@ def compare_by_splitting(img_1, img_2, ratio=0.5):
     return out
 
 
-def extract_profile(img):
+def extract_profile(img: np.ndarray,) -> Curve:
     luma = img.mean(axis=-1)
     h_profile = SingleCurve(y=luma[0, :], label="H profile")
     v_profile = SingleCurve(y=luma[:, 0], label="V profile")

tutorial.md

@@ -1,5 +1,7 @@
 # Tutorial
 
+
+
 ## Keep separation between "production code" (library / not interactive) & interactivity
 - 💡 One of the strength of interactive pipe is to avoid adding hundreds of lines of code dedicated to GUI (graphical user interfaces). 
 - With interactive pipe, you have the choice to keep this design choice. Each processing block can be defined as a regular function, without even importing the `interactive` decorator. In a separate file, you'll add sliders.
@@ -52,4 +54,9 @@ def gen_color(
 ```
 
 - ➕ Shortest code
-- ➖ The decorated function can't be re-used somewhere else
+- ➖ The decorated function can't be re-used somewhere else
+
+## Backend choice
+| 🚀  Qt | 🐢 Gradio |
+|:---:|:---:|
+| ![QT](/pyqt.gif) | ![Gradio](/gradio.gif) |