fix: update docs and examples (#678)

* chore: add image-clustering example

* chore: update documentation

Author: omkar-334

…rators/detect_text_in_image_tesseract.md …cs/api/operators/detect_text_in_image.mddocs/api/operators/detect_text_in_image_tesseract.md renamed to docs/api/operators/detect_text_in_image.md docs/api/operators/detect_text_in_image_tesseract.md renamed to docs/api/operators/detect_text_in_image.md

@@ -45,7 +45,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "examples/*.ipynb"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # -- Options for HTML output -------------------------------------------------
 
@@ -91,6 +91,7 @@
     "seaborn",
     "pandas",
     "tesseract",
+    "pytesseract",
     "tqdm",
     # Additional ML/AI libraries
     "umap",
@@ -325,6 +326,9 @@
 
 nb_execution_mode = "off"
 nb_execution_timeout = 300
+
+# Suppress highlighting warnings for shell commands in notebooks
+suppress_warnings = ["misc.highlighting_failure"]
 # -- Options for intersphinx -------------------------------------------------
 
 intersphinx_mapping = {

…cs/api/operators/image_vec_rep_resnet.md docs/api/operators/image_vec_rep.mddocs/api/operators/image_vec_rep_resnet.md renamed to docs/api/operators/image_vec_rep.md docs/api/operators/image_vec_rep_resnet.md renamed to docs/api/operators/image_vec_rep.md

@@ -2,8 +2,14 @@
 
 Here you can find a collection of jupyter notebooks which have use cases of using `feluda` and its `operators`.
 
-| Notebook | Description | Colab |
-|----------|-------------|-------|
-| [plot_tsne_videos](https://github.com/tattle-made/feluda/blob/main/examples/plot_tsne_videos.ipynb) | How to extract video embeddings using Feluda and its operators and visualize them in 2D space using t-SNE | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/tattle-made/feluda/blob/main/examples/plot_tsne_videos.ipynb) |
-| [plot_cluster_videos](https://github.com/tattle-made/feluda/blob/main/examples/plot_cluster_videos.ipynb) | How to automatically cluster vidoes using Feluda and its operators | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/tattle-made/feluda/blob/main/examples/plot_cluster_videos.ipynb) |
-| [classify_video_zero_shot](https://github.com/tattle-made/feluda/blob/main/examples/classify_video_zero_shot.ipynb) | How to zero-shot classify vidoes using Feluda and its operators | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/tattle-made/feluda/blob/main/examples/classify_video_zero_shot.ipynb) |
+```{toctree}
+:maxdepth: 1
+
+classify_video_zero_shot.ipynb
+compare_video_hashes.ipynb
+detect_lewd_images.ipynb
+find_text_in_newspaper.ipynb
+plot_cluster_images.ipynb
+plot_cluster_videos.ipynb
+plot_tsne_videos.ipynb
+```

docs/api/operators/vid_vec_rep_clip.md docs/api/operators/vid_vec_rep.mddocs/api/operators/vid_vec_rep_clip.md renamed to docs/api/operators/vid_vec_rep.md

@@ -14,12 +14,19 @@
     "- Visualizing the clusters with video thumbnails and the classified labels."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "f7562061",
+   "metadata": {},
+   "source": [
+    "[![GitHub](https://img.shields.io/badge/GitHub-View%20Source-blue?logo=github)](https://github.com/tattle-made/feluda/blob/main/docs/examples/classify_video_zero_shot.ipynb)  [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/tattle-made/feluda/blob/main/docs/examples/classify_video_zero_shot.ipynb)"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "b63d79e1",
    "metadata": {},
    "source": [
-    "### Install Required Packages\n",
     "Install dependencies conditionally based on whether the notebook is running in Colab or locally."
    ]
   },
@@ -83,7 +90,7 @@
    "metadata": {},
    "source": [
     "\n",
-    "### Dataset Structure Breakdown\n",
+    "Dataset Structure Breakdown\n",
     "\n",
     "- **UCF101_subset/**: The root directory containing the dataset.\n",
     "  - **train/**: Contains training samples.\n",
@@ -138,8 +145,7 @@
    "id": "35a99415-ca33-4395-8bf0-84b109bcd382",
    "metadata": {},
    "source": [
-    "### Initializing Feluda operator\n",
-    "We'll use one operator for this example."
+    "Initializing Feluda operator for this example"
    ]
   },
   {
@@ -277,7 +283,7 @@
    "id": "82ece75b",
    "metadata": {},
    "source": [
-    "### Clustering videos\n",
+    "Clustering videos  \n",
     "\n",
     "This cell groups the videos by its predicted class"
    ]
@@ -307,7 +313,7 @@
    "id": "4cf0fc79-8a4c-4088-aeda-9fe4f0d9059d",
    "metadata": {},
    "source": [
-    "### Visualizing Clusters"
+    "Visualizing Clusters"
    ]
   },
   {

docs/api/operators/video_hash_tmk.md docs/api/operators/video_hash.mddocs/api/operators/video_hash_tmk.md renamed to docs/api/operators/video_hash.md

@@ -12,12 +12,19 @@
     "two sample videos and shows their hash values for similarity analysis."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "c32d1dd4",
+   "metadata": {},
+   "source": [
+    "[![GitHub](https://img.shields.io/badge/GitHub-View%20Source-blue?logo=github)](https://github.com/tattle-made/feluda/blob/main/docs/examples/compare_video_hashes.ipynb) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/tattle-made/feluda/blob/main/docs/examples/compare_video_hashes.ipynb)"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "b63d79e1",
    "metadata": {},
    "source": [
-    "### Install Required Packages\n",
     "Install dependencies conditionally based on whether the notebook is running in Colab or locally."
    ]
   },
@@ -63,7 +70,6 @@
    "id": "35a99415-ca33-4395-8bf0-84b109bcd382",
    "metadata": {},
    "source": [
-    "### Initializing Feluda operator\n",
     "We'll use one operator for this example."
    ]
   },

docs/conf.py

@@ -12,12 +12,19 @@
     "probability score indicating likelihood of lewd content."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "38455989",
+   "metadata": {},
+   "source": [
+    "[![GitHub](https://img.shields.io/badge/GitHub-View%20Source-blue?logo=github)](https://github.com/tattle-made/feluda/blob/main/docs/examples/detect_lewd_images.ipynb)  [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/tattle-made/feluda/blob/main/docs/examples/detect_lewd_images.ipynb)"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "b63d79e1",
    "metadata": {},
    "source": [
-    "### Install Required Packages\n",
     "Install dependencies conditionally based on whether the notebook is running in Colab or locally."
    ]
   },
@@ -63,7 +70,6 @@
    "id": "35a99415-ca33-4395-8bf0-84b109bcd382",
    "metadata": {},
    "source": [
-    "### Initializing Feluda operator\n",
     "We'll use one operator for this example."
    ]
   },

docs/examples/README.md

@@ -12,12 +12,19 @@
     "detected text with proper formatting and analysis."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "9d8c9f48",
+   "metadata": {},
+   "source": [
+    "[![GitHub](https://img.shields.io/badge/GitHub-View%20Source-blue?logo=github)](https://github.com/tattle-made/feluda/blob/main/docs/examples/find_text_in_newspaper.ipynb)  [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/tattle-made/feluda/blob/main/docs/examples/find_text_in_newspaper.ipynb)"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "1b60aae8",
    "metadata": {},
    "source": [
-    "### Install Required Packages\n",
     "Install dependencies conditionally based on whether the notebook is running in Colab or locally."
    ]
   },
@@ -63,8 +70,6 @@
    "id": "07d21783-b48c-4d4f-8a46-840b4ac0aaa6",
    "metadata": {},
    "source": [
-    "### Initializing Feluda class with config file\n",
-    "\n",
     "We'll use one operator for this example, for detecting text from newspaper clippings. Let's initialize the operator."
    ]
   },
@@ -223,8 +228,7 @@
    "outputs": [],
    "source": [
     "def display_results(results: list[dict]) -> None:\n",
-    "    \"\"\"\n",
-    "    Display the results of text detection in a formatted manner.\n",
+    "    \"\"\"Display the results of text detection in a formatted manner.\n",
     "    \"\"\"\n",
     "    if not results:\n",
     "        print(\"No images were successfully processed.\")\n",