sightrag 0.1.0__tar.gz

sightrag-0.1.0/LICENSE

@@ -0,0 +1,125 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work.
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner.
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear.
+
+   5. Submission of Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND.
+
+   8. Limitation of Liability.
+
+   9. Accepting Warranty or Additional Liability.
+
+   Copyright 2026 Ant (VK-Ant)
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

sightrag-0.1.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include LICENSE
+include README.md
+include requirements.txt
+recursive-include sightrag *.py

sightrag-0.1.0/PKG-INFO

@@ -0,0 +1,391 @@
+Metadata-Version: 2.4
+Name: sightrag
+Version: 0.1.0
+Summary: SightRAG — Image and Video RAG. See. Search. Retrieve.
+Home-page: https://github.com/VK-Ant/sightrag
+Author: Ant (VK-Ant)
+Author-email: 
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/VK-Ant/sightrag
+Project-URL: Issues, https://github.com/VK-Ant/sightrag/issues
+Keywords: computer-vision,rag,image-search,video-search,retrieval,clip,yolo
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Image Recognition
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: torch>=2.0.0
+Requires-Dist: torchvision>=0.15.0
+Requires-Dist: transformers>=4.30.0
+Requires-Dist: ultralytics>=8.0.0
+Requires-Dist: opencv-python>=4.8.0
+Requires-Dist: Pillow>=9.0.0
+Requires-Dist: numpy>=1.24.0
+Provides-Extra: chroma
+Requires-Dist: chromadb>=0.4.0; extra == "chroma"
+Provides-Extra: api
+Requires-Dist: fastapi>=0.100.0; extra == "api"
+Requires-Dist: uvicorn>=0.23.0; extra == "api"
+Requires-Dist: python-multipart>=0.0.6; extra == "api"
+Provides-Extra: all
+Requires-Dist: chromadb>=0.4.0; extra == "all"
+Requires-Dist: fastapi>=0.100.0; extra == "all"
+Requires-Dist: uvicorn>=0.23.0; extra == "all"
+Requires-Dist: python-multipart>=0.0.6; extra == "all"
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/VK-Ant/sightrag/main/assets/sightrag_banner.png" alt="SightRAG Banner" width="100%">
+</p>
+
+<h1 align="center">SightRAG</h1>
+<h3 align="center">See. Search. Retrieve.</h3>
+
+<p align="center">
+  <a href="https://pypi.org/project/sightrag/"><img src="https://img.shields.io/pypi/v/sightrag" alt="PyPI"></a>
+  <a href="https://github.com/VK-Ant/sightrag/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-blue" alt="License"></a>
+  <a href="https://www.python.org/"><img src="https://img.shields.io/badge/python-3.9+-green" alt="Python"></a>
+</p>
+
+<p align="center">
+  Search your images and videos with plain English. Three lines of code.
+</p>
+
+---
+
+## Quick Start
+
+```python
+from sightrag import SightRAG
+
+rag = SightRAG()
+rag.index("./photos/")
+results = rag.query("find empty shelf")
+```
+
+## Install
+
+```bash
+pip install sightrag
+```
+
+For REST API:
+```bash
+pip install sightrag[api]
+```
+
+## What SightRAG Does
+
+Point SightRAG at any image folder, video file, or camera. Ask in plain English. Get back matched images with bounding boxes, timestamps, and confidence scores.
+
+SightRAG is not a model. Not a wrapper. Not a framework plugin. It is a complete retrieval system that handles detection, embedding, indexing, and search — so you don't have to.
+
+All models and indexes are stored in `~/.sightrag/` — your project folder stays clean.
+
+## Project Structure
+
+```
+sightrag/
+├── sightrag/                    ← main library (pip install)
+│   ├── core.py                  ← SightRAG class
+│   ├── detector.py              ← YOLO detection
+│   ├── embedder.py              ← CLIP embeddings
+│   ├── indexer.py               ← image/video/camera indexing
+│   ├── retriever.py             ← text + reference queries
+│   ├── api.py                   ← REST API (FastAPI)
+│   ├── store/
+│   │   ├── base.py              ← abstract store interface
+│   │   ├── sqlite_store.py      ← SQLite fallback
+│   │   └── chroma_store.py      ← ChromaDB (default)
+│   └── utils/
+│       ├── image.py             ← image loading
+│       ├── video.py             ← frame extraction
+│       └── camera.py            ← webcam capture
+│
+├── demo_sightrag/               ← test locally — run the scripts
+│   ├── sightrag_images.py       ← demo: image folder indexing
+│   ├── sightrag_video.py        ← demo: video file indexing
+│   ├── sightrag_livecam.py      ← demo: live webcam capture
+│   ├── sightrag_restapi.py      ← demo: REST API usage
+│   ├── input_images/            ← sample images to index
+│   ├── reference_images/        ← sample reference query images
+│   ├── camera_captures/         ← webcam frames stored here
+│   └── video_samples/           ← put your videos here
+│
+├── notebooks/                   ← test on Google Colab
+│   └── SightRAG_Colab_Demo.ipynb
+│
+├── examples/                    ← code examples
+│   ├── basic_usage.py
+│   ├── camera_example.py
+│   ├── custom_domain_example.py
+│   └── rest_api_example.py
+│
+├── tests/                       ← unit tests
+│   └── test_core.py
+│
+├── docs/                        ← documentation
+│   └── DOCKER.md
+│
+├── assets/                      ← banner image
+├── setup.py                     ← PyPI packaging
+├── pyproject.toml               ← build config
+├── requirements.txt             ← dependencies
+├── Dockerfile                   ← container
+├── docker-compose.yml           ← one command deploy
+├── LICENSE                      ← Apache 2.0
+└── test_sightrag.py             ← quick test script
+```
+
+## How To Test
+
+### Quick Test (terminal)
+```bash
+python test_sightrag.py
+```
+
+### Demo Scripts (test each mode)
+```bash
+python demo_sightrag/sightrag_images.py     # image folder
+python demo_sightrag/sightrag_video.py       # video files
+python demo_sightrag/sightrag_livecam.py     # live webcam
+python demo_sightrag/sightrag_restapi.py     # REST API
+```
+
+### Google Colab
+Upload `notebooks/SightRAG_Colab_Demo.ipynb` to Google Colab → Run All
+
+### Unit Tests
+```bash
+pip install pytest
+python -m pytest tests/ -v
+```
+
+## Usage
+
+### Image Folder
+
+```python
+from sightrag import SightRAG
+
+rag = SightRAG()
+rag.index("./shelf_photos/")
+results = rag.query("find empty shelf near dairy")
+
+for r in results:
+    print(f"{r['image_path']} — score: {r['score']} — {r['label']}")
+```
+
+### Video File
+
+```python
+rag = SightRAG()
+rag.index("./cctv_footage.mp4")
+results = rag.query("person near exit door")
+
+for r in results:
+    print(f"Timestamp: {r['timestamp']} — score: {r['score']}")
+```
+
+### Mixed Folder (images + videos)
+
+```python
+rag = SightRAG()
+rag.index("./my_data/")  # automatically detects images AND videos
+```
+
+### Live Camera
+
+```python
+rag = SightRAG()
+rag.index(source="camera")              # default webcam
+rag.index(source="camera", camera_id=1) # specific camera
+results = rag.query("find person")
+```
+
+### Reference Image Query
+
+```python
+results = rag.query(reference="sample_shelf.jpg")
+```
+
+### Custom Domain (medical, industrial, satellite)
+
+```python
+rag = SightRAG(domain_hint="pcb defect solder joint circuit board")
+rag.index("./circuit_boards/")
+results = rag.query("find defective solder joint")
+```
+
+### SQLite Fallback (lightweight)
+
+```python
+rag = SightRAG(store="sqlite")
+rag.index("./small_dataset/")
+```
+
+## REST API
+
+```bash
+pip install sightrag[api]
+```
+
+Start the server:
+
+```bash
+# Command line
+sightrag-server
+
+# Or from Python
+from sightrag import serve
+serve(port=8000)
+
+# Or Docker (API starts automatically)
+docker-compose up
+```
+
+API available at `http://localhost:8000`
+
+### Endpoints
+
+| Method | Endpoint | Description |
+|--------|----------|-------------|
+| GET | `/` | API info and available endpoints |
+| GET | `/status` | Index count, store type, domain hint |
+| POST | `/index/folder` | Index all images and videos in a folder |
+| POST | `/index/video` | Index a video file |
+| POST | `/index/upload` | Upload and index images directly |
+| POST | `/query/text` | Search with plain English text |
+| POST | `/query/reference` | Search with a reference image |
+| DELETE | `/index` | Clear all indexed data |
+
+### Examples
+
+```bash
+# Index a folder
+curl -X POST http://localhost:8000/index/folder \
+     -F "path=./data/"
+
+# Search with text
+curl -X POST http://localhost:8000/query/text \
+     -F "text=find empty shelf" \
+     -F "top_k=5"
+
+# Upload and search with reference image
+curl -X POST http://localhost:8000/query/reference \
+     -F "file=@new_photo.jpg" \
+     -F "top_k=5"
+
+# Check status
+curl http://localhost:8000/status
+```
+
+Interactive API docs available at `http://localhost:8000/docs` (Swagger UI).
+
+## Result Format
+
+```python
+[
+    {
+        "image_path":  "./photos/shelf_042.jpg",
+        "score":       0.9134,
+        "label":       "bottle",
+        "confidence":  0.8721,
+        "bbox":        [120, 45, 380, 290],
+        "timestamp":   "",
+        "source_type": "image"
+    }
+]
+```
+
+## Storage
+
+SightRAG uses a built-in SQLite vector store by default — zero extra dependencies, works everywhere.
+
+| Store | Scale | Cost | Usage |
+|-------|-------|------|-------|
+| SQLite (default) | Up to 100k images | Free | `SightRAG()` |
+| ChromaDB (optional) | Large scale | Free | `SightRAG(store="chroma")` |
+
+Enterprise connectors (Qdrant, Pinecone, Azure) coming in v2.
+
+## Where SightRAG Stores Data
+
+```
+~/.sightrag/
+├── models/      ← YOLO weights (auto-downloaded once)
+└── index/       ← vector database (ChromaDB/SQLite)
+```
+
+Your project folder stays clean. No random `.pt` files or `sightrag_index/` folders appearing.
+
+## Docker
+
+```bash
+docker-compose up
+```
+
+This starts the REST API server on port 8000. See [Docker Guide](docs/DOCKER.md) for details.
+
+## Architecture
+
+```
+Input (images / video / camera / reference image)
+        ↓
+   Preprocessor (resize, validate, keyframe extract)
+        ↓
+   YOLO Detection (80 COCO classes + whole-image fallback)
+        ↓
+   CLIP Embedding (domain_hint enrichment for custom domains)
+        ↓
+   Vector Store (ChromaDB default / SQLite fallback)
+        ↓
+   Retrieval + Ranking (cosine similarity, confidence scoring)
+        ↓
+Output (matched images, timestamps, bounding boxes, scores)
+```
+
+## Honest Limitations (v0.1.0)
+
+- Indexing ~500 images takes ~2 minutes on CPU (one-time cost — search is instant after)
+- Custom domains (medical, satellite) use whole-image CLIP without region grounding
+- Single webcam only (multiple cameras in v2)
+- SQLite vector store loads all vectors into memory for search
+
+## Roadmap
+
+| Version | Features |
+|---------|----------|
+| v0.1 (current) | Image + Video + Camera + REST API + ChromaDB |
+| v0.2 | C++ core, CLI, Grounding DINO, SAM |
+| v0.3 | Person Re-ID, scene graph, edge deployment |
+| v1.0 | Jetson Orin, compliance modes (GDPR/HIPAA/DPDP) |
+
+## Three Library Ecosystem
+
+SightRAG is part of the VK-Ant AI ecosystem:
+
+| Library | Purpose | Status |
+|---------|---------|--------|
+| [SightRAG](https://github.com/VK-Ant/sightrag) | Image & Video RAG | v0.1 |
+| [adaptive-intelligence](https://pypi.org/project/adaptive-intelligence/) | RL-based RAG orchestration | v4.0 |
+| [llmevalkit](https://pypi.org/project/llmevalkit/) | LLM evaluation (97+ tests) | Stable |
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE)
+
+## Author
+
+Built by **Ant (VK-Ant)** — Kaggle Master, 8.5+ years computer vision experience.
+
+- GitHub: [VK-Ant](https://github.com/VK-Ant)
+- LinkedIn: [VK-Ant](https://linkedin.com/in/vk-ant)
+- Portfolio: [vk-ant.github.io](https://vk-ant.github.io/Venkatkumar)