Skip to content

Commit 9d5a8bc

Browse files
authored
docs: align repository metadata and README with v7.0 architecture (#314)
* docs: align repository metadata and README with v7.0 architecture This PR does not introduce new functionality. It aligns the repository's public-facing documentation with the architecture that shipped in the v7.x series, including Verification Context v1.0, DiagnosticResult, and the verification protocol. Changes: - README: title 'QWED Protocol' -> 'QWED Verification' with protocol subtitle - README: opening now shows DiagnosticResult contract and VC v1.0 - README: removed pricing line, reduced badge wall - pyproject.toml: removed volatile '11 engines' count from description - pyproject.toml: updated keywords to reflect v7.0 architecture - GitHub description: updated to category + differentiator - GitHub topics: added verification-context, diagnostic-result, fail-closed; removed nlp, neurosymbolic-ai (inaccurate) * fix: distinguish DiagnosticResult admission (ADMIT/BLOCKED) from VC admission (ADMIT/DENY)
1 parent 637a880 commit 9d5a8bc

2 files changed

Lines changed: 33 additions & 53 deletions

File tree

README.md

Lines changed: 21 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,39 @@
11
<div align="center">
22
<img src="assets/logo.png" alt="QWED Logo - AI Verification Engine" width="80" height="80">
3-
<h1>QWED Protocol</h1>
4-
<h3>Model-Agnostic Trust Boundary for AI Systems</h3>
3+
<h1>QWED Verification</h1>
4+
<h3>Reference implementation of the QWED Verification protocol and Verification Context v1.0</h3>
55

6-
> **QWED Verification** - Production-grade deterministic trust boundary for LLMs, AI agents, and tool-driven systems. Works with **ANY LLM** - OpenAI, Anthropic, Gemini, Llama (via Ollama), or any local model. Detect and prevent AI hallucinations through multiple verification engines • agentic security guards • process determinism. **Your LLM, Your Choice, Our Verification.**
7-
8-
<p>
9-
<b>Don't fix the liar. Verify the lie.</b><br>
10-
<i>QWED verifies outputs, processes, and tool interactions before they enter production.</i><br>
11-
<i>For supported proof domains, hallucinations cannot bypass deterministic verification.</i>
12-
</p>
6+
QWED applies deterministic verification to AI outputs before production execution.
7+
8+
Every verification returns a <code>DiagnosticResult</code>:
9+
10+
<b>VERIFIED</b> — proof established, evidence attached<br>
11+
<b>UNVERIFIABLE</b> — proof could not be established<br>
12+
<b>BLOCKED</b> — policy or rule rejected the action<br>
13+
14+
Admission: <b>ADMIT</b> | <b>BLOCKED</b>
1315

14-
<p>
15-
<b>If critical AI output cannot be verified, QWED can block it before production.</b>
16-
</p>
16+
Verification Context v1.0 provides the canonical evidence and proof model
17+
(admission: <b>ADMIT</b> | <b>DENY</b> at the protocol layer).
1718

18-
<p>
19-
<b>🌐 Model Agnostic:</b> Local ($0) • Budget ($5/mo) • Premium ($100/mo) - You choose!
20-
</p>
19+
<p><i>Don't fix the liar. Verify the lie.</i></p>
2120

2221
[![CodSpeed](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/QWED-AI/qwed-verification?utm_source=badge)
2322
[![PyPI version](https://img.shields.io/pypi/v/qwed.svg)](https://pypi.org/project/qwed/)
2423
[![Docker Verified](https://img.shields.io/badge/Docker-Verified_Publisher-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/qwedai/qwed-verification)
2524
[![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](LICENSE)
2625
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/11903/badge)](https://www.bestpractices.dev/projects/11903)
27-
[![Snyk Security](https://img.shields.io/badge/Snyk-Monitored-4C4A73?logo=snyk&logoColor=white)](https://app.snyk.io)
2826
[![QWED Security](https://img.shields.io/badge/GitHub_Marketplace-QWED_Security_%E2%9C%93-2ea44f?style=flat&logo=github&logoColor=white)](https://github.com/marketplace/qwed-security)
29-
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=QWED-AI_qwed-verification&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=QWED-AI_qwed-verification)
3027
[![DOI](https://zenodo.org/badge/1115581942.svg)](https://doi.org/10.5281/zenodo.18111675)
31-
[![GitHub stars](https://img.shields.io/github/stars/QWED-AI/qwed-verification?style=social)](https://github.com/QWED-AI/qwed-verification)
32-
33-
[![Also on GitLab](https://img.shields.io/badge/Also%20on-GitLab%20(Enterprise)-FC6D26?logo=gitlab&logoColor=white)](https://gitlab.com/qwed-ai/qwed-verification)
34-
35-
<a href="https://www.nvidia.com/en-us/startups/"><img src="./assets/badges/nvidia-inception.png" alt="NVIDIA Inception Program" height="40"></a>
36-
<a href="https://github.com/developer-program"><img src="https://img.shields.io/badge/GitHub_Developer_Program-Member-4183C4?style=for-the-badge&logo=github&logoColor=white" alt="GitHub Developer Program" height="40"></a>
37-
38-
<br>
39-
40-
**💖 Support QWED Development:**
41-
42-
<a href="https://github.com/sponsors/QWED-AI"><img src="https://img.shields.io/github/sponsors/QWED-AI?style=for-the-badge&logo=githubsponsors&label=Sponsor&color=EA4AAA" alt="Sponsor QWED on GitHub"></a>
43-
44-
<br>
45-
46-
[![Twitter](https://img.shields.io/badge/Twitter-@rahuldass29-1DA1F2?style=flat&logo=twitter&logoColor=white)](https://x.com/rahuldass29)
47-
[![LinkedIn](https://img.shields.io/badge/LinkedIn-Rahul%20Dass-0077B5?style=flat&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/rahul-dass-23b370b0/)
48-
[![Blog](https://img.shields.io/badge/Blog-Unreadable%20Code%20Benchmark-FF5722?style=flat&logo=docusaurus&logoColor=white)](https://docs.qwedai.com/blog/unreadable-code-agi-benchmark)
4928

5029
<br>
51-
<a href="#-quick-start-install--verify-in-30-seconds">Quick Start</a> ·
52-
<a href="#-first-time-setup-qwed-init">🆕 qwed init</a> ·
53-
<a href="#-the-llm-hallucination-problem-why-ai-cant-be-trusted">The Problem</a> ·
54-
<a href="#verification-engines-and-agent-security-guards">The Engines & Guards</a> ·
55-
<a href="docs/INTEGRATION.md">🔌 Integration</a> ·
56-
<a href="docs/QWED_LOCAL.md">⚡ QWEDLocal</a> ·
57-
<a href="docs/CLI.md">🖥️ CLI</a> ·
58-
<a href="docs/OLLAMA_INTEGRATION.md">🆓 Ollama (FREE!)</a> ·
59-
<a href="https://docs.qwedai.com">📖 Full Documentation</a>
30+
<a href="#-installation--quick-start">Quick Start</a> ·
31+
<a href="#-first-time-setup-qwed-init">qwed init</a> ·
32+
<a href="#verification-engines-and-agent-security-guards">Engines & Guards</a> ·
33+
<a href="docs/INTEGRATION.md">Integration</a> ·
34+
<a href="docs/QWED_LOCAL.md">QWEDLocal</a> ·
35+
<a href="docs/CLI.md">CLI</a> ·
36+
<a href="https://docs.qwedai.com">Full Documentation</a>
6037
</div>
6138

6239
---

pyproject.toml

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
11
[project]
22
name = "qwed"
33
version = "7.0.0"
4-
description = "The Deterministic Verification Protocol for AI - 11 verification engines for math, logic, code, SQL, facts, images, and more. Now with Agentic Security Guards."
4+
description = "Open-source AI verification infrastructure for deterministic verification of LLM outputs, tool calls, code, schemas, and agent state before production execution."
55
authors = [
66
{name = "QWED Team", email = "rahul@qwedai.com"},
77
]
88
license = {text = "Apache-2.0"}
99
keywords = [
10-
"ai",
11-
"verification",
12-
"llm",
13-
"deterministic",
14-
"symbolic",
15-
"math",
16-
"logic",
10+
"ai-verification",
11+
"llm-verification",
12+
"deterministic-verification",
13+
"verification-context",
14+
"diagnostic-result",
15+
"fail-closed",
16+
"ai-safety",
1717
"code-security",
1818
"sql-validation",
19-
"fact-checking"
19+
"formal-verification",
20+
"symbolic-reasoning",
21+
"z3",
22+
"sympy",
2023
]
2124
classifiers = [
2225
"Development Status :: 4 - Beta",

0 commit comments

Comments
 (0)