diff --git a/README.md b/README.md new file mode 100644 index 0000000..4d5b018 --- /dev/null +++ b/README.md @@ -0,0 +1,90 @@ +# Patch Stability Probe + +## Überblick +Das Experiment **patch_stability_probe** untersucht die Behebung eines Off-By-3 Fehlers in einem Python-Skript, die Durchführung einer Stabilitätsprobe für einen Patch und das Testen von Spacer-Konfigurationen. Ziel ist es, die Auswirkungen des Patches auf Systemstabilität und Frequenzsteuerung zu evaluieren. + +[Artikel zur Versuchsbeschreibung](https://donau2space.de/tag-84-mittag-off-by-3-behoben-patch-stability-probe-kurzbootstrap-spacer-check/) + +### 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 +Das Repository enthält drei zentrale Python-Skripte: + +### 1. off_by_3_fix +- **Art:** Python-Skript +- **Ziel:** Linux Userspace +- **Sprachen:** Python +- **Zweck:** Behebung des Off-By-3 Fehlers in `trace_agg.py` durch Umstellung auf Integer-Buckets. + +**API-Funktionen:** +- `fix_off_by_3(trace_data)` – korrigiert Off-By-3 Fehler in Trace-Daten. + +**Strukturen:** +- `TraceData` (JSON): Felder `group`, `bucket`, `value`. + +### 2. patch_stability_probe +- **Art:** Python-Skript +- **Ziel:** Linux Userspace +- **Sprachen:** Python +- **Zweck:** Durchführung einer Stabilitätsprobe des Patches über verschiedene Governors. + +**API-Funktionen:** +- `run_stability_probe(governor)` – führt eine Stabilitätsprobe für den angegebenen Governor durch und liefert ein Ergebnisobjekt. + +**Strukturen:** +- `StabilityResult` (JSON): Felder `governor`, `max_residual`, `median`, `samples`. + +### 3. spacer_check +- **Art:** Python-Skript +- **Ziel:** Linux Userspace +- **Sprachen:** Python +- **Zweck:** Tests des Spacer-Effekts bei unterschiedlichen Konfigurationen. + +**API-Funktionen:** +- `test_spacer_effect(config_a, config_b)` – vergleicht zwei Spacer-Konfigurationen und liefert Messergebnisse. + +**Strukturen:** +- `SpacerTestResult` (JSON): Felder `configuration`, `hf_peak`, `noise`, `cycles`. + +## Installation & Nutzung +### Voraussetzungen +- Linux-System mit Python 3.8 oder höher +- Git für Repository-Klon + +### Installation +1. Repository klonen: + ```bash + git clone https://example.com/patch_stability_probe.git + cd patch_stability_probe + ``` +2. Abhängigkeiten installieren: + ```bash + pip install -r requirements.txt + ``` + +### Nutzung (Beispiel) +```bash +python patch_stability_probe.py --governor performance +``` +Das Skript führt eine Probe mit dem angegebenen Governor aus und speichert die Ergebnisse als JSON in `results/`. + +## Typische Use-Cases +- Validierung von Patches auf Stabilitätsverhalten über verschiedene Skalierungs-Governors. +- Analyse von Messfehlern und Spacing-Einflüssen. +- Automatisierte Tests auf Off-By-N Fehler im Trace-Handling. + +## Struktur & Erweiterbarkeit +- **core/** enthält die Basisskripte für Fehlerkorrektur, Stabilitätsproben und Spacer-Tests. +- **data/** speichert Eingabe- und Ergebnisdateien (JSON). +- **docs/** dokumentiert Ablauf, Messverfahren und mögliche Erweiterungen. + +Erweiterungen können neue Governor-Profile, Messparameter oder Trace-Formate einbeziehen. Jede API-Funktion ist modular aufgebaut und kann unabhängig getestet werden. + +## Lizenz +Veröffentlicht unter der **MIT-Lizenz**. + +--- +*Automatisch generierte technische Dokumentation. Nutzung auf eigenes Risiko.* \ No newline at end of file