vi3ion 0.1.0__tar.gz

vi3ion-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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
+      (an example is provided in the Appendix below).
+
+      "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. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "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 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. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by 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. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   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 those 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. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Subadeepan-Y
+
+   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.

vi3ion-0.1.0/LOCAL_MODELS.md

@@ -0,0 +1,106 @@
+# Running Vi3ion with local models
+
+Vi3ion is the perception layer for agents. When the agent's model is local
+(Ollama, llama.cpp, LM Studio, vLLM, Unsloth, SGLang, LocalAI, jan,
+koboldcpp, text-generation-webui), Vi3ion has three jobs:
+
+1. Be the **eyes** for models that cannot read pixels.
+2. Stay **out of the way** for local vision models that can.
+3. Stay **cheap**: low RAM, low CPU, small token footprint.
+
+## 1. See what is running
+
+```powershell
+vi3ion local          # runtimes + models + which ones accept images
+vi3ion local --json   # same, machine readable
+```
+
+Output looks like:
+
+```
+llama.cpp             127.0.0.1:8080  reachable
+                      openai-compatible: http://127.0.0.1:8080/v1
+                      - qwen3-8b (text)
+                      - qwen2.5vl-7b (vision)
+
+No local vision model detected: Vi3ion is the eyes for local models.
+```
+
+In OpenCode, `/vi3ionlocal` prints the same in the chat and `/vi3ionstatus`
+adds it to the status line.
+
+The MCP tool `local_stack` exposes the same data to the agent itself.
+
+## 2. Point OpenCode at the local model
+
+```jsonc
+{
+  "provider": {
+    "llamacpp": {
+      "npm": "@ai-sdk/openai-compatible",
+      "name": "llama.cpp",
+      "options": {
+        "baseURL": "http://127.0.0.1:8080/v1",
+        "apiKey": "dummy"
+      },
+      "models": {
+        "qwen2.5vl-7b": { "name": "Qwen2.5-VL 7B", "limit": { "context": 32768, "output": 4096 } }
+      }
+    }
+  }
+}
+```
+
+Ollama uses `http://127.0.0.1:11434/v1` with the same openai-compatible npm
+package.
+
+## 3. What Vi3ion does automatically for local models
+
+| Behaviour | Local model | Cloud model |
+|---|---|---|
+| Vision detection | `capabilities.input`, then name heuristics (`llava`, `qwen2.5-vl`, `minicpm-v`, `gemma3`, `llama3.2-vision`, `internvl`, `pixtral`, `smolvlm`, …) | declared modalities + known names |
+| Evidence tier | `compact` | `compact` below 32K, else `full` |
+| Token budget | ~8% of the context window (min 200, max 900) | unlimited in `full` tier |
+| Second analysis pass | skipped (code cross-check only when `codeCheck: true`) | on |
+| Role for a text-only model | Vi3ion is the eyes | Vi3ion is the eyes |
+| Role for a vision model | model's own vision leads; Vi3ion assists | same |
+
+A local model that cannot see images gets the same treatment as any
+vision-less model: the intro states it must use Vi3ion evidence and must never
+describe an image from its filename.
+
+## 4. Keep the evidence small
+
+The token budget is derived from the model's context window. Override it when
+needed:
+
+- In OpenCode: `/vi3ionbudget 400` (0 = auto).
+- In the CLI: `vi3ion brief screenshot.png --budget 400`.
+
+With a budget, sections are kept in priority order — OCR text first, then
+omission notes, composition, colour, scene prose, and the honesty note last.
+
+## 5. Model switching
+
+A user can switch models mid-conversation. Vi3ion re-binds automatically:
+
+- the intro block is re-injected with the new model and its role,
+- the next request carries a role-change notice,
+- the evidence tier and budget are recomputed for the new model.
+
+No manual step is needed, and switching models never drops the evidence that
+was already collected.
+
+## 6. If the local model is not detected as vision capable but it is
+
+Name heuristics are conservative on purpose. Override per session with
+`/vi3ionon` and `mode: "always"` in the plugin options, or rename the model
+so the hint is visible (`qwen2.5vl-7b` is recognised; `my-model` is not).
+
+## 7. Checks
+
+```powershell
+node .\.opencode\plugins\vi3ion-attach\smoke.mjs        # hook behaviour
+node .\.opencode\plugins\vi3ion-attach\e2e_local.mjs    # local-model path, real screenshot
+node .\.opencode\plugins\vi3ion-attach\e2e_visionless.mjs
+```

vi3ion-0.1.0/MANIFEST.in

@@ -0,0 +1,32 @@
+# Only the package, the docs and the license ship in the sdist.
+include LICENSE
+include README.md
+include LOCAL_MODELS.md
+include PERFORMANCE.md
+include pyproject.toml
+
+recursive-include vi3ion *.py
+recursive-include vi3ion/core/ocr/models *.onnx
+recursive-include vi3ion/skill *.md
+recursive-include adapters *.md
+
+# Everything below is local development material.
+prune dashboard
+prune .opencode
+prune data
+prune scripts
+prune testing screenshots
+prune tools
+prune tests
+prune .github
+exclude *.png
+exclude *.jpg
+exclude *.jpeg
+exclude .env
+exclude .env.example
+exclude CONTINUATION.md
+exclude IMAGE_ANALYSIS.md
+exclude IMAGE_ANALYSIS - new.md
+exclude VI3ION_OUTPUT.md
+global-exclude *.py[cod]
+global-exclude __pycache__

vi3ion-0.1.0/NOTICE

@@ -0,0 +1,21 @@
+VI3ION
+Copyright 2026 Subadeepan-Y
+
+This product includes software developed as an independent perception engine
+for AI agents.
+
+Portions of this software include ONNX OCR models distributed with the
+`rapidocr-onnxruntime` package (Apache-2.0) and a bundled Japanese text
+recognizer (`vi3ion/core/ocr/models/japan_rec_crnn.onnx`).
+
+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.

vi3ion-0.1.0/PERFORMANCE.md

@@ -0,0 +1,65 @@
+# Vi3ion performance profile
+
+Measured 2026-11-02 on this machine, running a full brief generation for the
+new page screenshot **while OpenCode was open and idle** in the same session
+(the exact IDE-plugin usage pattern).
+
+## Test machine
+
+| | |
+|---|---|
+| OS | Windows 11 Pro 10.0.26200 |
+| CPU | AMD Ryzen 5 5500GT (6 cores / 12 logical processors) |
+| RAM | 15.3 GB |
+| OCR | RapidOCR (ONNX Runtime, CPU) — bundled Chinese rec model |
+
+## Results (peak values during a run)
+
+| Process | Peak working set | Peak CPU | Avg CPU |
+|---|---|---|---|
+| Vi3ion brief (venv python) | **584 MB** | **63.9%** (of total CPU) | 50.7% |
+| OpenCode (opencode.exe ×2) | ~340 MB each | ~3% | ~0.7% |
+| Other python (system) | ~32 MB | ~1% | ~0.5% |
+
+Timing: one brief run = **56.6 s cold** (model load + OCR + recovery passes),
+single-threaded startup and multi-threaded inference burst.
+
+## What this means for IDE integration
+
+- **Memory floor:** Vi3ion itself needs roughly **0.6 GB** at peak while
+  processing (the OCR model + frame buffers). OpenCode stays at its normal
+  footprint (~0.7 GB total). A machine with ≥4 GB free RAM handles this
+  comfortably.
+- **CPU burst:** inference is multi-threaded and briefly uses most cores;
+  the burst lasts seconds, then the process idles. Avoid running many Vi3ion
+  calls in parallel on small machines.
+- **Latency:** expect **~1 minute cold** per image. Once the MCP server is
+  long-lived, the model stays loaded and subsequent images are faster
+  (warm) — this is the recommended deployment mode for IDE plugins.
+- **Disk:** model files ~13 MB; no network use during processing.
+
+## Low-resource mode (for local models / low-end machines)
+
+Auto-enabled when the machine has < 8 GB RAM (override with
+`VI3ION_LOW_RESOURCE=0|1`). It:
+
+- lowers the analysis cap 2048 → 1280 px (downscales images before OCR),
+- skips the CJK margin-recovery pass (the most expensive extra pass),
+- skips the context-driven attention relook.
+
+Measured on this machine (1294×852 screenshot, warm runs):
+- peak working set **453.9 MB** vs 562.6 MB normal (~19% less)
+- run time ≈ unchanged (~4s warm)
+- accuracy cost: CJK subtitles only (typical UI text unaffected)
+
+The visual add-on also selects a **compact evidence tier** automatically for
+models with < 32K context (`/vi3ioncompact`, `/vi3ionfull` to force).
+
+## Measuring yourself
+
+`data/debug/profile_vi3ion.ps1` samples opencode + python processes every
+250 ms while running one brief and prints peaks. Run with:
+
+```powershell
+powershell -ExecutionPolicy Bypass -File data/debug/profile_vi3ion.ps1
+```