petter2025 commited on
Commit
c6bda33
·
verified ·
1 Parent(s): eb30f11

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +66 -25
README.md CHANGED
@@ -9,46 +9,87 @@ app_file: app.py
9
  pinned: false
10
  ---
11
 
12
- # Agentic Reliability Framework (ARF) v4 API
13
 
14
- This Space hosts the **ARF v4 API** with an optional Gradio dashboard. It provides endpoints for risk assessment, decision history, and incident evaluation, as used by the [ARF frontend](https://arf-frontend-sandy.vercel.app).
15
 
16
- The API is built with FastAPI and mounted under the `/api` subpath, while the Gradio dashboard is served at the root (`/`).
17
 
18
- ## 🚀 Endpoints
19
 
20
- All API endpoints are prefixed with `/api`. Interactive documentation is available at `/api/docs`.
21
 
22
- | Method | Path | Description |
23
- |--------|------|-------------|
24
- | `GET` | `/api/health` | Health check |
25
- | `GET` | `/api/v1/get_risk` | Current system risk (demo) |
26
- | `GET` | `/api/v1/history` | Recent decisions |
27
- | `POST` | `/api/v1/incidents/evaluate` | Evaluate an incident (placeholder) |
28
- | `POST` | `/api/v1/feedback` | Record outcome of a decision |
29
 
30
- ## 🧪 Try It
 
 
 
 
 
31
 
32
- - **Swagger UI**: [https://a-r-f-agentic-reliability-framework-api.hf.space/api/docs](https://a-r-f-agentic-reliability-framework-api.hf.space/api/docs)
33
- - **Gradio dashboard**: [https://a-r-f-agentic-reliability-framework-api.hf.space/](https://a-r-f-agentic-reliability-framework-api.hf.space/)
34
 
35
- ## 🔧 Local Development
36
 
37
- To run this Space locally with Docker:
 
 
 
 
 
 
 
 
 
 
 
 
 
38
 
39
- ```bash
40
- docker build -t arf-api .
41
- docker run -p 7860:7860 arf-api
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
42
  ```
43
 
44
- Or without Docker, using Python directly:
45
 
46
- ```python
47
- pip install -r requirements.txt
48
- uvicorn app:fastapi_app --reload --port 7860
 
 
 
49
  ```
50
 
51
- The API will be available at http://localhost:7860/api and the Gradio UI at http://localhost:7860.
52
 
53
  📚 About ARF
54
  ------------
 
9
  pinned: false
10
  ---
11
 
12
+ # Agentic Reliability Framework (ARF) v4.2.0 – AI Reliability & Self-Healing Control Plane
13
 
14
+ **Problem:** Most AI‑driven governance systems fail silently in production, leading to outages, security breaches, and compliance violations.
15
 
16
+ **Solution:** ARF turns probabilistic AI into deterministic, auditable action using Bayesian inference, semantic memory, and deterministic probability thresholds (DPT).
17
 
18
+ **Outcome:** Reduce MTTR by up to 85% with self‑healing systems, backed by fully explainable risk scores.
19
 
20
+ ---
21
 
22
+ ## 🚀 Start Here
 
 
 
 
 
 
23
 
24
+ | | |
25
+ |--|--|
26
+ | **📚 API Docs** | [https://a-r-f-agentic-reliability-framework-api.hf.space/api/docs](https://a-r-f-agentic-reliability-framework-api.hf.space/api/docs) |
27
+ | **🧪 Live Demo** | [Gradio Dashboard](https://a-r-f-agentic-reliability-framework-api.hf.space/) |
28
+ | **📦 GitHub** | [github.com/arf-foundation/agentic-reliability-framework](https://github.com/arf-foundation/agentic-reliability-framework) |
29
+ | **📅 Book a Call** | [Calendly](https://calendly.com/petter2025us/30min) |
30
 
31
+ ---
 
32
 
33
+ ## 🔍 Quick Example
34
 
35
+ ```python
36
+ import requests
37
+
38
+ response = requests.post(
39
+ "https://a-r-f-agentic-reliability-framework-api.hf.space/api/v1/incidents/evaluate",
40
+ json={
41
+ "service_name": "payment-gateway",
42
+ "event_type": "latency_spike",
43
+ "severity": "high",
44
+ "metrics": {"latency_p99": 350, "error_rate": 0.12}
45
+ }
46
+ )
47
+ print(response.json())
48
+ ```
49
 
50
+ The response includes a full HealingIntent with:
51
+
52
+ * risk\_score: calibrated failure probability
53
+
54
+ * risk\_factors: additive contributions from conjugate prior, hyperprior, and HMC
55
+
56
+ * recommended\_action: approve, deny, or escalate
57
+
58
+ * decision\_trace: expected losses and variance
59
+
60
+
61
+ 🧠 Key Capabilities
62
+ -------------------
63
+
64
+ * **Bayesian Risk Scoring** – Conjugate priors + HMC for calibrated uncertainty.
65
+
66
+ * **Semantic Memory** – FAISS‑based retrieval of similar past incidents.
67
+
68
+ * **DPT Thresholds** – Deterministic approve/deny/escalate (0.2/0.8).
69
+
70
+ * **Multi‑Agent Orchestration** – Anomaly detection, root cause, forecasting.
71
+
72
+
73
+ 📊 Architecture
74
+ ---------------
75
+
76
+ ```text
77
+ User Request → Policy Evaluation → Cost Estimation → Risk Scoring
78
+
79
+ HealingIntent ← Decision (Bayesian Loss)
80
  ```
81
 
82
+ All decisions are immutable, signed, and fully traceable via ancestor\_chain and infrastructure\_intent fields.
83
 
84
+ 🔧 Local Development
85
+ --------------------
86
+
87
+ ```bash
88
+ docker build -t arf-api .
89
+ docker run -p 7860:7860 arf-api
90
  ```
91
 
92
+ Then open [http://localhost:7860](http://localhost:7860/) for the Gradio UI and [http://localhost:7860/api/docs](http://localhost:7860/api/docs) for the API.
93
 
94
  📚 About ARF
95
  ------------