diff --git a/README.md b/README.md new file mode 100644 index 0000000..71d1a6a --- /dev/null +++ b/README.md @@ -0,0 +1,86 @@ +# Experiment Run 17 Gates Default + +## Überblick +Experiment *run_17_gates_default* untersucht die Stabilität und Entscheidungsfindung der Gate-V1-Implementierung in einem kontrollierten Umfeld. + +Link zum Artikel: [https://donau2space.de/tag-172-run-17-pinned-gegenprobe-kein-%ce%b4t/](https://donau2space.de/tag-172-run-17-pinned-gegenprobe-kein-%ce%b4t/) + +Git Repo: [https://git.donau2space.de/Mika/run_17_gates_default](https://git.donau2space.de/Mika/run_17_gates_default) + +### Hinweis +Alle Inhalte wurden per KI generiert. + +Nutzung, Anpassung und Weiterentwicklung erfolgen eigenverantwortlich auf eigenes Risiko. +Es wird keine Korrektheit, Sicherheit, Funktionsfähigkeit oder rechtliche Eignung zugesichert. + +## Inhalt des Repositories + +### Artefakte + +#### 1. artifact.retry_analysis +- **Art:** python_script +- **Ziel:** Linux Userspace +- **Sprachen:** Python +- **Zweck:** Analysiert Retry-Daten und bestimmt Heilungsraten anhand von Log-Dateien. +- **API:** + - **Funktion:** `analyze_retry_data(log_file)` → Liefert ein *retry_analysis_report*-Objekt. + - **Datenstruktur:** *retry_analysis_report* + - Felder: *total_retries*, *success_rate*, *failure_rate*, *details* + +#### 2. artifact.logging_schema +- **Art:** db_schema +- **Ziel:** Mixed (Server und Analyseumgebung) +- **Sprachen:** SQL +- **Zweck:** Definiert das Datenbankschema zur Speicherung von Log-Daten. +- **Schema:** *log_table* + - Felder: *id*, *retry_taken*, *retry_total_overhead_ms*, *stratum*, *expires_at_dist_hours*, *delta_t* + +#### 3. artifact.visualization +- **Art:** web_ui +- **Ziel:** Web +- **Sprachen:** HTML, CSS, JavaScript +- **Zweck:** Darstellung der Retry-Statistiken und Ergebnisse der Analyse von *run_17_gates_default*. +- **API-Routen:** + - **GET /api/retry-stats** → Liefert ein *retry_analysis_report*-Objekt zur Visualisierung. + +## Voraussetzungen (Webserver/DB) +- Laufende Python-Umgebung (3.9 oder höher) +- SQL-Datenbank (z. B. PostgreSQL oder SQLite) +- Webserver (z. B. Nginx oder Apache) zur Bereitstellung der Web UI +- Zugriff auf die Log-Daten gemäß *artifact.logging_schema* + +## Installation & Nutzung + +### Schema-Anwendung +1. Datenbankschema *artifact.logging_schema* anwenden: Migration oder SQL-Ausführung. +2. Verbindung in der Analyseumgebung konfigurieren. + +### Python-Skript ausführen +1. Python-Abhängigkeiten installieren (`pip install -r requirements.txt`). +2. Skript ausführen: + ```bash + python retry_analysis.py --input + ``` +3. Ausgabe: JSON-Bericht (*retry_analysis_report*) für weitere Nutzung in der Web-UI. + +### Starten der Web UI +1. Environment konfigurieren (API-Endpunkt und DB-Verbindung). +2. Webserver starten (z. B. `npm run start` oder über integriertes Werkzeug). +3. Zugriff im Browser über lokale oder bereitgestellte URL. + +## Typische Use-Cases +- Untersuchung der Stabilität verschiedener Gate-Konfigurationen. +- Vergleich der Retry-Effizienz innerhalb kontrollierter Testläufe. +- visuelle Darstellung von Retry-Verhalten und Erfolgsquoten. +- Validierung der Logging-Struktur und Datenintegrität. + +## Struktur & Erweiterbarkeit +- **/scripts/** → Python-Skripte für Analysen. +- **/db/** → SQL-Schema-Definitionen. +- **/web/** → Quellcode der Web UI. +- Erweiterbar durch zusätzliche Analysefunktionen (z. B. Clustering oder Zeitreihenmodellierung) oder Ergänzung weiterer Metriken im Datenbankschema. + +## Lizenz +Dieses Projekt steht unter der **MIT-Lizenz**. + +Alle Inhalte wurden automatisch durch KI generiert. Nutzung erfolgt eigenverantwortlich und ohne Gewähr. \ No newline at end of file