vetch 0.1.0__tar.gz

vetch-0.1.0/.gitignore

@@ -0,0 +1,91 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+*.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
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# IDEs
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# macOS
+.DS_Store
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# ruff
+.ruff_cache/
+
+# Jupyter
+.ipynb_checkpoints/
+
+# Local development
+*.local
+.envrc
+
+# Vetch cache files (for testing)
+vetch_grid_cache.json
+vetch_grid_cache.json.tmp

vetch-0.1.0/CHANGELOG.md

@@ -0,0 +1,54 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-02-18
+
+### Added
+- Initial **alpha** release of Vetch SDK
+- Core context manager: `wrap()` for energy/carbon/cost tracking
+- OpenAI provider wrapper (sync & streaming)
+- Vertex AI provider wrapper (sync & streaming)
+- Anthropic provider wrapper (sync & streaming)
+- Multi-tier grid intensity cache (Memory + File with locking)
+- Serverless mode (`VETCH_CACHE_MODE=memory-only`)
+- Energy calculation engine with model registry
+- Pricing registry for list cost estimation with `price_multiplier` support
+- CLI tool: `estimate`, `compare`, `methodology`, `check`, `audit`, `report`
+- Token estimation with tiktoken integration and language-aware fallback
+- Session statistics: `get_session_stats()` for pattern detection
+- Advisory engine: `generate_advisories()` for optimization recommendations
+- OpenTelemetry span decoration (attach metrics to existing spans)
+- SQLite local storage for historical analysis (experimental)
+- GPU calibration module for Tier 0 measurements (experimental)
+- CI summary mode for GitHub Actions
+
+### Safety Features
+- **Fail-open behavior**: LLM calls always proceed even when Vetch fails
+- **Fail-loud diagnostics**: `vetch_warnings` field captures all issues
+- **Kill switch**: `VETCH_DISABLED=true` completely disables Vetch
+- **Privacy-first**: Zero access to prompt/completion content
+
+### Alpha Limitations
+- Timezone-based region inference has ~30% accuracy - use `VETCH_REGION` for production
+- Experimental modules (`calibrate`, `storage`, `ci`) marked with `FutureWarning`
+- Integration tests require live API credentials
+- Energy estimates are Tier 3 (±10x uncertainty) for most models
+
+### Environment Variables
+| Variable | Purpose | Default |
+|----------|---------|---------|
+| `VETCH_REGION` | Grid region for carbon calculation | (inferred) |
+| `VETCH_OUTPUT` | Output target: `stderr`, `none`, or file path | `stderr` |
+| `VETCH_DEFAULT_PUE` | Power Usage Effectiveness multiplier | `1.1` |
+| `VETCH_CACHE_MODE` | Set to `memory-only` for serverless | (file-based) |
+| `VETCH_DISABLED` | Set to `true` to disable all tracking | `false` |
+| `ELECTRICITY_MAPS_API_KEY` | API key for live grid data | (optional) |
+
+### Dependencies
+- **Runtime**: Zero dependencies (stdlib only)
+- **Optional**: `openai>=1.0,<2.0`, `google-cloud-aiplatform>=1.0`, `tiktoken>=0.5.0`
+- **Test**: `pytest>=7.0`, `hypothesis>=6.0`

vetch-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 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 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. 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
+
+   Copyright 2026 Prismatic Labs
+
+   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.

vetch-0.1.0/NOTICE

@@ -0,0 +1,31 @@
+Vetch SDK
+Copyright 2026 Prismatic Labs
+
+This product includes software developed at Prismatic Labs.
+
+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.
+
+--------------------------------------------------------------------------------
+
+Third-Party Data Sources:
+
+Electricity Maps (https://electricitymaps.com/)
+  - Real-time carbon intensity data for grid regions
+  - Used under their API terms of service
+
+Model energy estimates derived from:
+  - Published academic research on LLM energy consumption
+  - Parameter count extrapolation using FLOP-to-Wh conversion
+
+See src/vetch/METHODOLOGY.md for full methodology documentation.
+See src/vetch/registry/PROVENANCE.md for data source citations.

vetch-0.1.0/PKG-INFO

@@ -0,0 +1,257 @@
+Metadata-Version: 2.4
+Name: vetch
+Version: 0.1.0
+Summary: Energy-aware observability for LLM inference
+Project-URL: Homepage, https://github.com/prismatic-labs/vetch
+Project-URL: Documentation, https://github.com/prismatic-labs/vetch#readme
+Project-URL: Repository, https://github.com/prismatic-labs/vetch
+Project-URL: Issues, https://github.com/prismatic-labs/vetch/issues
+Author: Prismatic Labs
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: carbon,energy,llm,observability,openai,vertexai
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Provides-Extra: calibrate
+Requires-Dist: nvidia-ml-py3; extra == 'calibrate'
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Provides-Extra: openai
+Requires-Dist: openai<2.0,>=1.0; extra == 'openai'
+Provides-Extra: test
+Requires-Dist: hypothesis>=6.0; extra == 'test'
+Requires-Dist: pytest-cov>=4.0; extra == 'test'
+Requires-Dist: pytest>=7.0; extra == 'test'
+Requires-Dist: tiktoken>=0.5.0; extra == 'test'
+Provides-Extra: tiktoken
+Requires-Dist: tiktoken>=0.5.0; extra == 'tiktoken'
+Provides-Extra: vertexai
+Requires-Dist: google-cloud-aiplatform>=1.0; extra == 'vertexai'
+Description-Content-Type: text/markdown
+
+# Vetch SDK
+
+Energy-aware observability for LLM inference.
+
+Vetch is a Python SDK that wraps LLM API calls to log energy consumption, cost, and carbon per inference using live grid data. It never reads prompt or completion content—only metadata from the response usage.
+
+## Features
+
+- **Fail-Open**: LLM calls always proceed even if Vetch fails.
+- **Privacy-First**: No prompt or completion data is ever read or buffered.
+- **Multi-tier Caching**: Memory and file-based caching for grid intensity data.
+- **Observability-Transparent**: Works seamlessly with Datadog, OpenTelemetry, and Sentry.
+- **Low Overhead**: Under 5ms overhead for sync calls; zero TTFT latency for streaming.
+
+## Installation
+
+```bash
+pip install vetch
+```
+
+## Quick Start
+
+```python
+from vetch import wrap
+from openai import OpenAI
+
+client = OpenAI()
+
+with wrap(region="us-east-1", tags={"team": "ml", "env": "prod"}) as ctx:
+    response = client.chat.completions.create(
+        model="gpt-4o",
+        messages=[{"role": "user", "content": "Hello world"}]
+    )
+
+# Access inference metadata
+print(f"Energy: {ctx.event['estimated_energy_wh']} Wh")
+print(f"Carbon: {ctx.event['estimated_carbon_g']} gCO2e")
+```
+
+## CLI Usage
+
+Estimate energy/carbon for a model without running code:
+```bash
+vetch estimate --model gpt-4o --input-tokens 1000 --output-tokens 500 --region us-east-1
+```
+
+Compare multiple models:
+```bash
+vetch compare --models gpt-4o,claude-3-opus,gemini-1.5-pro --tokens 1000
+```
+
+Analyze your token usage patterns:
+```bash
+vetch audit
+```
+
+Check your environment:
+```bash
+vetch check
+```
+
+## Token Waste Audit
+
+Vetch tracks token usage patterns across your session and provides actionable recommendations:
+
+```python
+from vetch import wrap, get_session_stats, generate_advisories
+
+# Make multiple LLM calls
+for _ in range(10):
+    with wrap() as ctx:
+        response = client.chat.completions.create(...)
+
+# Analyze patterns
+stats = get_session_stats()
+advisories = generate_advisories(stats)
+
+for a in advisories:
+    print(f"[{a.level.value}] {a.title}")
+    print(f"  {a.description}")
+```
+
+**What it detects:**
+- **Static system prompts**: Repeated input token counts suggest cacheable prompts
+- **High input:output ratios**: Large inputs producing small outputs
+- **Expensive model usage**: Opportunities to use smaller, cheaper models
+
+## GPU Calibration (Local Inference)
+
+For local inference (Ollama, vLLM, llama.cpp), calibrate energy measurements using actual GPU power draw:
+
+```python
+from vetch.calibrate import calibrate_model, format_calibration_result
+
+def my_inference():
+    # Run your inference workload
+    # Return (input_tokens, output_tokens)
+    response = ollama.generate(model="llama3.1:8b", prompt="Hello world")
+    return 100, 50  # Your actual token counts
+
+result = calibrate_model("ollama", "llama3.1:8b", workload=my_inference)
+print(format_calibration_result(result))
+
+# Use calibrated values for accurate tracking
+with wrap(energy_override=result.to_override()) as ctx:
+    response = ollama.generate(...)
+```
+
+Check calibration status:
+```bash
+vetch calibrate --status
+```
+
+**Requirements:** NVIDIA GPU with `pynvml` (`pip install nvidia-ml-py3`)
+
+## Historical Analysis & Reporting
+
+Vetch can persist events to SQLite for historical FinOps analysis:
+
+```python
+from vetch import configure_storage, query_usage, wrap
+from datetime import datetime, timedelta
+
+# Enable persistent storage
+configure_storage()  # Uses ~/.vetch/usage.db
+
+# Your LLM calls are now tracked
+with wrap(tags={"team": "ml", "feature": "chat"}) as ctx:
+    response = client.chat.completions.create(...)
+
+# Query historical usage
+summary = query_usage(
+    start=datetime.now() - timedelta(days=7),
+    tags={"team": "ml"}
+)
+
+print(f"Total cost: ${summary.total_cost_usd:.2f}")
+print(f"Total energy: {summary.total_energy_wh:.2f} Wh")
+print(f"Requests: {summary.total_requests}")
+```
+
+Generate reports from CLI:
+```bash
+# Weekly report
+vetch report --days 7
+
+# Filter by team
+vetch report --tags team=ml
+
+# Show top consumers
+vetch report --top --top-by team --days 30
+
+# JSON output for dashboards
+vetch report --format json
+```
+
+## Energy Tiers
+
+Vetch uses a tiered system for energy estimate confidence:
+
+| Tier | Name | Uncertainty | Source |
+|------|------|-------------|--------|
+| 0 | **Measured** | ±10-20% | Direct GPU measurement (pynvml) |
+| 1 | **Vendor-Published** | ±20-50% | Official provider data |
+| 2 | **Validated** | ±50-100% | Crowdsourced aggregates |
+| 3 | **Estimated** | ±10x | Parameter-based calculation |
+
+Run `vetch methodology` to see full methodology documentation.
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `VETCH_DISABLED` | Set to `true` to completely disable Vetch (emergency kill switch) |
+| `VETCH_REGION` | Default grid region (e.g., `us-east-1`, `eu-west-1`) |
+| `VETCH_OUTPUT` | Output target: `stderr` (default), `none`, or file path |
+| `ELECTRICITY_MAPS_API_KEY` | API key for live grid carbon intensity data |
+| `VETCH_CACHE_MODE` | Set to `memory-only` for serverless/Lambda environments |
+
+## Alpha Limitations
+
+This is an alpha release. Please be aware of:
+
+1. **Energy estimates are uncertain**: Most models use Tier 3 estimates (±10x uncertainty). See `vetch methodology` for details.
+
+2. **Region inference is approximate**: Without explicit `VETCH_REGION`, timezone-based inference is ~30% accurate. Set the region explicitly for accurate carbon calculations.
+
+3. **Experimental modules**: `vetch.calibrate`, `vetch.storage`, and `vetch.ci` emit `FutureWarning` and may change in future versions.
+
+4. **Provider support**: Currently supports OpenAI, Anthropic, and Vertex AI. Other providers coming soon.
+
+## Troubleshooting
+
+**Vetch is blocking my LLM calls:**
+```bash
+export VETCH_DISABLED=true  # Emergency kill switch
+```
+
+**Too much output:**
+```bash
+export VETCH_OUTPUT=none  # Silence all output
+```
+
+**Need to debug:**
+```python
+import logging
+logging.getLogger("vetch").setLevel(logging.DEBUG)
+```
+
+## License
+
+Apache License 2.0. See `LICENSE` and `NOTICE` for details.