Add readme_md

This commit is contained in:
Mika 2026-02-27 10:56:53 +00:00
parent 5ab187333c
commit 4316b512d2

75
readme_md Normal file
View file

@ -0,0 +1,75 @@
# Experiment: exit_rule_v1_commit
## Überblick
Dieses Repository dokumentiert und implementiert das Experiment **exit_rule_v1_commit**. Es beinhaltet die Durchführung von Run #6 zur Verifikation der Exit-Regel mit festen Schwellenwerten für den Kontroll- und Entscheidungsprozess.
**Weitere Informationen:**
Artikel: [https://donau2space.de/tag-162-run-6-unter-klarem-himmel-exit-regel-v1-festnageln/](https://donau2space.de/tag-162-run-6-unter-klarem-himmel-exit-regel-v1-festnageln/)
Git Repository: [https://git.donau2space.de/Mika/exit_rule_v1_commit](https://git.donau2space.de/Mika/exit_rule_v1_commit)
### Hinweis
Alle Inhalte wurden per KI generiert.
Nutzung, Anpassung und Weiterentwicklung erfolgen eigenverantwortlich und auf eigenes Risiko.
Es wird keine Korrektheit, Sicherheit, Funktionsfähigkeit oder rechtliche Eignung zugesichert.
## Inhalt des Repositories
### 1. setup_fingerprint_check
- **Art:** python_script
- **Ziel:** Linux Userspace
- **Sprachen:** Python
- **Zweck:** Überprüft den Setup-Fingerprint vor dem Start eines Testlaufs, um sicherzustellen, dass das Experiment unter identischen Bedingungen ausgeführt wird.
- **API-Funktion:**
- `check_setup_fingerprint(expected_fingerprint) -> bool`
Prüft die Integrität und Übereinstimmung der Setup-Daten.
### 2. event_data_capture
- **Art:** python_script
- **Ziel:** Linux Userspace
- **Sprachen:** Python
- **Zweck:** Erfasst und analysiert Events während des Testlaufs. Ermöglicht die Auswertung von Warn- und Unbekannt-Raten.
- **API-Funktion:**
- `capture_event_data(event_stratum) -> list`
Zeichnet Ereignisdaten zur weiteren Verarbeitung auf.
- **Datenstruktur:**
- `EventData (JSON)` mit Feldern: `warn_rate`, `unknown_rate`.
### 3. exit_rule_commit
- **Art:** doc_only
- **Ziel:** gemischt (Dokumentation)
- **Zweck:** Dokumentiert die festgelegten Schwellenwerte für die Exit-Regel v1.
- **Sprachen:** keine
## Installation & Nutzung
### Voraussetzungen
- Linux-Umgebung mit installiertem Python (Version ≥ 3.8)
### Schritte
1. Repository klonen:
`git clone https://git.donau2space.de/Mika/exit_rule_v1_commit`
2. Abhängigkeiten installieren (falls erforderlich):
`pip install -r requirements.txt`
3. Skripte ausführbar machen:
`chmod +x setup_fingerprint_check.py event_data_capture.py`
4. Ausführung:
`python3 setup_fingerprint_check.py`
`python3 event_data_capture.py`
## Typische Use-Cases
- Validierung der Testumgebung vor Experimentstart.
- Echtzeit-Erfassung und Analyse experimenteller Events.
- Dokumentation und Reproduktion von Schwellenwert-basierten Exit-Regeln.
## Struktur & mögliche Erweiterungen
- **Erweiterbar** um zusätzliche Python-Skripte zur Analyse oder zur Integration in Automatisierungs-Pipelines.
- **Zentraler Fokus:** Validierung und Ereignisbewertung im Rahmen der Exit-Regel.
Strukturüberblick:
- `/scripts/` Python-Implementierungen der Kontroll- und Analysetools
- `/docs/` Dokumentation der Exit-Regeln (Version 1)
## Lizenz
Dieses Repository steht unter der **MIT-Lizenz**.
Alle Inhalte wurden automatisch durch KI generiert.
Verwendung erfolgt ohne Gewähr und auf eigene Verantwortung.