visru 0.0.1__tar.gz

visru-0.0.1/.gitignore

@@ -0,0 +1,232 @@
+personals/
+.visru/
+visru.toml
+.claude/
+CLAUDE.md
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
+#   can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, you
+#   could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+# eval run outputs (regenerate with python -m evals.baseline)
+evals/runs/
+# working question set (cp evals/questions.example.jsonl evals/questions.jsonl)
+evals/questions.jsonl
+# imported benchmarks (python -m evals.import_bench <name>)
+bench/

visru-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Michael Chang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

visru-0.0.1/PKG-INFO

@@ -0,0 +1,289 @@
+Metadata-Version: 2.5
+Name: visru
+Version: 0.0.1
+Summary: Agentic harness giving a vision-language model tools to search, zoom, measure, annotate, and verify over images and video
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: anthropic>=0.40
+Requires-Dist: av>=12.0
+Requires-Dist: jinja2>=3.1
+Requires-Dist: mcp>=2.2
+Requires-Dist: numpy>=1.26
+Requires-Dist: openai>=1.40
+Requires-Dist: pillow>=10.3
+Requires-Dist: typer>=0.12
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Provides-Extra: kernel
+Requires-Dist: ipykernel>=6.29; extra == 'kernel'
+Requires-Dist: jupyter-client>=8.6; extra == 'kernel'
+Provides-Extra: ocr
+Requires-Dist: paddleocr>=2.8; extra == 'ocr'
+Requires-Dist: paddlepaddle>=2.6; extra == 'ocr'
+Provides-Extra: tools
+Requires-Dist: accelerate>=0.34; extra == 'tools'
+Requires-Dist: faiss-cpu>=1.8; extra == 'tools'
+Requires-Dist: opencv-python-headless>=4.10; extra == 'tools'
+Requires-Dist: timm>=1.0; extra == 'tools'
+Requires-Dist: torch>=2.4; extra == 'tools'
+Requires-Dist: torchvision>=0.19; extra == 'tools'
+Requires-Dist: transformers>=4.56; extra == 'tools'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/engichang1467/VisRU/main/img/visru-logo-acronym.png" alt="VisRU" width="360">
+</p>
+
+# Visual Reasoning and Understanding
+
+**VisRU** (Visual Reasoning and Understanding) is an agentic harness that gives a vision-language model a workspace of images, video, and multi-view captures, plus tools to search, zoom, measure, annotate, and check its own conclusions. Every claim in its final answer links to the crop, mask, frame, or overlay that supports it.
+
+The design borrows from coding agents. A codebase is too large to read in one pass, so a coding agent searches, opens the files it needs, edits, and runs tests. visru runs the same loop over pixels.
+
+> Status: pre-alpha.
+
+## A session
+
+```text
+$ visru run ./rollouts/pick_place --task "Why did trial 14 fail?"
+
+[1] list_assets(prefix="trial_14")                  -> 1 video, 1,812 frames, 30 fps
+[2] sample_frames(trial_14.mp4, n=24)               -> contact sheet a_0003
+[3] sample_frames(trial_14.mp4, t=37.5..40.5, n=12) -> contact sheet a_0004
+[4] view(frame_1164, box=[812,402,1240,690])        -> a_0005, scale 1.00
+[5] segment(a_0005, points=[[1020,560]])            -> mask a_0006 (mark 1: mug handle)
+[6] overlay(a_0006 + gripper track)                 -> a_0007
+[7] cross_check(c_1, via=["segment", "detect"])     -> agree, IoU 0.84
+[8] coverage(trial_14.mp4)                          -> 14% of frames inspected at native scale
+[9] submit_report(...)
+
+c_1 [verified]  Gripper closed before reaching the handle at 38.8 s.
+                evidence: a_0005, a_0007   checks: cross_tool
+c_2 [supported] Left finger occluded the handle from 38.4 s.
+                evidence: a_0004
+Not inspected at native scale: frames 0 to 1100.
+```
+
+## Architecture
+
+```mermaid
+flowchart TB
+    U[CLI session<br/>task + VISRU.md] --> L
+    subgraph H[Agent harness]
+        L[Agent loop] <--> C[Context manager<br/>pixel budget, coverage]
+        L <--> S[Subagents]
+    end
+    L <-->|tool calls| T
+    subgraph T[Vision tools, MCP server]
+        N[Navigate]
+        Q[Search]
+        M[Measure]
+        A[Annotate]
+        V[Verify]
+    end
+    T <--> W[(Workspace<br/>assets + index)]
+    T --> R[(Artifact store)]
+    T --> E[(Evidence ledger)]
+    E --> P[HTML evidence report]
+    L --> J[(Trajectory log)]
+```
+
+**CLI and project context.** A session starts in the terminal. Each workspace can carry a `VISRU.md` with domain context: camera intrinsics, class definitions, what counts as a defect, known failure modes, unit conventions. The harness loads it into the system prompt, the way Claude Code loads `CLAUDE.md`.
+
+**Agent loop.** A tool-use loop. The model plans, calls tools, receives text, images, and artifact IDs, and repeats until it calls `submit_report`. Ending through a tool call forces the final answer into the ledger schema.
+
+**Context manager.** Images dominate context cost, so the context manager keeps a fixed number of live images and replaces older ones with short text notes that carry artifact IDs. It also maintains a coverage map per asset: which regions or frames the model has viewed, and at what scale.
+
+**Workspace.** An asset registry with content-hash IDs and metadata (resolution, fps, intrinsics when known), plus an embedding index built at ingest: one SigLIP embedding per image and per video keyframe, stored in FAISS.
+
+**Artifact store.** Every derived image (view, mask, overlay, contact sheet, plot) is saved with its parent asset, the tool and parameters that produced it, and its coordinate transform. Any image the model saw can be regenerated from the log.
+
+**Tool layer.** Tools run in an MCP server, so any MCP client can use them. Heavy models (detector, segmenter, depth, pointmaps) run in a GPU worker process that loads weights once and batches requests.
+
+**Evidence ledger.** Claims with evidence IDs, the checks run against them, and a status. It renders to a static HTML report where each claim links to its artifacts.
+
+**Trajectory log.** JSONL of every model turn, tool call, tool result, and artifact ID, usable as training data.
+
+## Design decisions
+
+**Tools ship as an MCP server.** Claude Code or any other MCP client can drive them directly; visru's own loop uses the same server.
+
+**One coordinate frame: source-asset pixels.** The API returns coordinates relative to its own resized image, and every crop adds an offset and a scale. So all tool inputs and outputs use source-asset pixels, `view` resizes images itself to a size the API will not resize again, and detections are drawn as numbered marks (Set-of-Mark style) so the model can say "mark 3" instead of emitting coordinates.
+
+**Images in context expire; artifacts persist.** After an image ages out it becomes a note such as `[a_0042 elided: close view of MRZ, OCR read "P<CAN..."]`. The model can call `view("a_0042")` to see it again.
+
+**The ledger enforces verification.** Claims carry one of four statuses:
+
+| Status | Requirement |
+|---|---|
+| `verified` | At least one evidence artifact and at least one passing independent check |
+| `supported` | At least one evidence artifact |
+| `contested` | Checks disagree |
+| `hypothesis` | No evidence; reported in a separate section |
+
+Two methods count as independent only if they do not share a model. A VLM count checked against a detector count qualifies. SAM masks prompted from detector boxes do not, because they inherit the detector's errors. `verified` comes only from the harness's `cross_check` tool, never from a check the model writes out itself.
+
+**Model-agnostic backends.** The Anthropic API for Claude, and an OpenAI-compatible endpoint (vLLM) for open VLMs.
+
+## Tools
+
+| Group | Tool | Purpose | Default backing |
+|---|---|---|---|
+| Navigate | `list_assets` | Filter assets by name, type, metadata | Registry |
+| | `view` | Render a region at the model's max resolution, optional source-pixel grid | Pillow |
+| | `sample_frames` | Contact sheet of N frames over a time range | PyAV |
+| Search | `search` | Text query over the embedding index; video hits merge into time windows | SigLIP |
+| | `detect` | Open-vocabulary boxes, rendered as marks | OWLv2 or Grounding DINO |
+| | `segment` | Masks from points, boxes, or marks | SAM 2 |
+| | `track` | Propagate masks through a video from one frame; when an object is present | SAM 2 (video) |
+| | `ocr` | Text with boxes | PaddleOCR |
+| Measure | `python` | Sandboxed kernel with numpy, OpenCV, workspace mounted read-only | Jupyter kernel |
+| | `depth` | Monocular depth | Depth Anything V2 |
+| | `pointmap` | Multi-view pointmaps, poses, reprojection error | VGGT or DUSt3R |
+| Annotate | `annotate` | Draw boxes, masks, labels, arrows | Pillow |
+| | `note` | Append a finding to session notes | Harness |
+| Verify | `overlay` | Render claimed geometry on the source and return it for re-inspection | Pillow |
+| | `cross_check` | Answer the same question with independent methods and compare | Harness |
+| | `coverage` | Viewed regions and frames, by scale | Context manager |
+| Delegate | `delegate` | One subagent per time window of a video (visru loop only, not MCP) | Harness |
+| Finish | `submit_report` | Submit claims with evidence IDs; rejects malformed claims | Ledger |
+
+In fp16, OWLv2, SAM 2, SigLIP, and Depth Anything V2 fit on one 24 GB GPU. VGGT memory grows with the number of views.
+
+## Quick start
+
+```bash
+git clone git@github.com:engichang1467/VisRU.git && cd visru
+uv venv && source .venv/bin/activate
+uv pip install -e ".[tools]"
+
+# Build the registry and embedding index for a folder
+visru index "$(pwd)/sample_data" --embed
+
+visru run sample_data --task "In trial_01.mp4, when is the street-name sign legible?" --max-steps 30
+```
+
+### With Claude Code
+
+```bash
+claude mcp add -s user visru -- "$(pwd)/.venv/bin/python" -m visru.servers.vision_mcp \
+  --workspace "$(pwd)/sample_data"
+
+# Claude Code reads CLAUDE.md, so use the visru context file under that name
+cp VISRU.md.example sample_data/CLAUDE.md
+cd sample_data/ && claude
+```
+
+Then ask something like:
+
+```text
+In the scene_b stills, read every storefront sign on the right side of the street,
+citing the artifact ID of the view you read it from. In trial_01.mp4, find the frame
+window where the street-name sign becomes legible. Tell me which assets you did not
+inspect at native scale. Finish with submit_report.
+```
+
+### With visru's own loop
+
+```bash
+visru run sample_data --task "What store name is on the tall vertical neon sign?" --max-steps 20
+```
+
+This uses the model in `visru.toml` (Anthropic by default; set `ANTHROPIC_API_KEY`). It prints the report and writes the trajectory, ledger, and an HTML report under `sample_data/.visru/`. Re-render a report with `visru report sample_data [session]`. Pass `--backend replay --script turns.json` to run the loop without API spend.
+
+### Project context
+
+`VISRU.md` carries whatever the model cannot see in the pixels:
+
+```markdown
+# Workspace: warehouse inspection set
+
+- 1,240 RGB images, 4032x3024, phone camera, no intrinsics.
+- "Torn" means a visible tear through the printed area. Creases do not count.
+- Labels are 10x15 cm. Anything smaller is a different sticker.
+- Report findings per image ID. Measurements in pixels unless a ruler is visible.
+```
+
+### Configuration
+
+Model image limits change between models, so they live in `visru.toml`:
+
+```toml
+[model]
+backend = "anthropic"        # or "openai_compatible"
+name = "claude-sonnet-5"
+max_edge = 2576
+max_visual_tokens = 4784
+patch = 28
+max_upscale = 2.0
+
+[context]
+max_live_images = 16         # stays under the API's 20-image threshold
+elide_batch = 8              # elide in batches to keep the cached prefix stable
+compact_at_tokens = 150_000
+
+[coverage]
+inspected_scale = 1.0        # rendered px per source px that counts as "inspected"
+```
+
+See the [Claude vision docs](https://platform.claude.com/docs/en/build-with-claude/vision) for current limits.
+
+## Evaluation
+
+Three arms on the same questions: single pass on the downsized image, `view` only (zoom-only), and the full tool set.
+
+```bash
+python -m evals.import_bench vstar          # also: hrbench_4k, hrbench_8k, charades_sta
+B=bench/vstar; Q=$B/questions.jsonl
+
+python -m evals.baseline --workspace $B --questions $Q --sample 100
+python -m evals.agent --workspace $B --questions $Q --sample 100 --arm zoom_only \
+    --out evals/runs/zoom_only_vstar.jsonl
+python -m evals.agent --workspace $B --questions $Q --sample 100 --arm full \
+    --out evals/runs/full_vstar.jsonl
+python -m evals.score --questions $Q evals/runs/baseline_*.jsonl \
+    evals/runs/zoom_only_vstar.jsonl evals/runs/full_vstar.jsonl
+```
+
+`--sample N --seed S` draws the same questions for every arm. Every arm accepts `--backend openai_compatible --config open.toml` to run against an open model. The scorer prints accuracy per arm and category, cost per question, and accuracy grouped by ledger status, which measures whether `verified` claims are actually more accurate than `supported` ones. Answers it cannot grade mechanically are marked `review`; settle them by adding `"correct": true` or `false` to the run file.
+
+Custom question sets are JSONL:
+
+```json
+{"id": "q01", "asset": "scene_b_1546479680612194.jpg",
+ "question": "What does the vertical neon sign on the right read?",
+ "answer": "TRADER JOE'S", "accept": ["trader joes"], "kind": "text"}
+```
+
+`kind` is one of `text`, `count`, `localize`, `temporal` (answered as `start..end` seconds, with a `tolerance`). Validate a set with `python -m evals.suite questions.jsonl --workspace sample_data`. Charades-STA is licensed for non-commercial research use only.
+
+## Open questions
+
+- Do the checks predict correctness? If `verified` claims are no more accurate than `supported` ones, the verification layer needs redesigning.
+- Where should looking happen: inside the model through learned token selection (LookWhere-style), or outside through tool calls? At what resolution or corpus size does the answer flip?
+- Can trajectories ending in verified, correct claims train an open VLM (SFT, then RL) to reach the same answers with fewer visual tokens?
+- What stopping rule tells the agent it has looked enough?
+- How much of the gain comes from zoom alone?
+
+## References
+
+- Gupta and Kembhavi. [Visual Programming: Compositional Visual Reasoning without Training](https://arxiv.org/abs/2211.11559). CVPR 2023.
+- Surís, Menon, Vondrick. [ViperGPT: Visual Inference via Python Execution for Reasoning](https://arxiv.org/abs/2303.08128). ICCV 2023.
+- Hu et al. [Visual Sketchpad: Sketching as a Visual Chain of Thought for Multimodal Language Models](https://arxiv.org/abs/2406.09403). NeurIPS 2024.
+- Wu and Xie. [V*: Guided Visual Search as a Core Mechanism in Multimodal LLMs](https://arxiv.org/abs/2312.14135). CVPR 2024.
+- Yang et al. [Set-of-Mark Prompting Unleashes Extraordinary Visual Grounding in GPT-4V](https://arxiv.org/abs/2310.11441). arXiv 2023.
+- Zheng et al. [DeepEyes: Incentivizing "Thinking with Images" via Reinforcement Learning](https://arxiv.org/abs/2505.14362). arXiv 2025.
+- Fuller et al. [LookWhere? Efficient Visual Recognition by Learning Where to Look and What to See from Self-Supervision](https://arxiv.org/abs/2505.18051). arXiv 2025.
+- Ravi et al. [SAM 2: Segment Anything in Images and Videos](https://arxiv.org/abs/2408.00714). ICLR 2025.
+- Minderer et al. [Scaling Open-Vocabulary Object Detection (OWLv2)](https://arxiv.org/abs/2306.09683). NeurIPS 2023.
+- Liu et al. [Grounding DINO](https://arxiv.org/abs/2303.05499). ECCV 2024.
+- Zhai et al. [Sigmoid Loss for Language Image Pre-Training (SigLIP)](https://arxiv.org/abs/2303.15343). ICCV 2023.
+- Yang et al. [Depth Anything V2](https://arxiv.org/abs/2406.09414). NeurIPS 2024.
+- Wang et al. [DUSt3R: Geometric 3D Vision Made Easy](https://arxiv.org/abs/2312.14132). CVPR 2024.
+- Wang et al. [VGGT: Visual Geometry Grounded Transformer](https://arxiv.org/abs/2503.11651). CVPR 2025.
+- Wang et al. [Divide, Conquer and Combine (HR-Bench)](https://arxiv.org/abs/2408.15556). AAAI 2025.
+- Zhang et al. [MME-RealWorld](https://arxiv.org/abs/2408.13257). ICLR 2025.
+- Fu et al. [Video-MME](https://arxiv.org/abs/2405.21075). CVPR 2025.
+- Wu et al. [LongVideoBench](https://arxiv.org/abs/2407.15754). NeurIPS 2024 Datasets and Benchmarks.