DOC added example for sklearn.feature_extraction.image.grid_to_graph (scikit-learn#28390)

ChVeen · glemaitre · LeoGrin · commit c848024297fa · 2024-02-12T19:40:52.000+01:00
Co-authored-by: Guillaume Lemaitre &lt;guillaume@probabl.ai&gt;
diff --git a/sklearn/feature_extraction/image.py b/sklearn/feature_extraction/image.py
@@ -237,6 +237,18 @@ def grid_to_graph(
 
     For compatibility, user code relying on this method should wrap its
     calls in ``np.asarray`` to avoid type issues.
+
+    Examples
+    --------
+    >>> import numpy as np
+    >>> from sklearn.feature_extraction.image import grid_to_graph
+    >>> shape_img = (4, 4, 1)
+    >>> mask = np.zeros(shape=shape_img, dtype=bool)
+    >>> mask[[1, 2], [1, 2], :] = True
+    >>> graph = grid_to_graph(*shape_img, mask=mask)
+    >>> print(graph)
+      (0, 0)    1
+      (1, 1)    1
     """
     return _to_graph(n_x, n_y, n_z, mask=mask, return_as=return_as, dtype=dtype)
 
