Add readme_md

This commit is contained in:
Mika 2026-01-17 17:02:00 +00:00
parent 8a645e7098
commit ee9afb08b3

74
readme_md Normal file
View file

@ -0,0 +1,74 @@
# A/B Testing Pinning
## Überblick
Dieses Repository dokumentiert das Experiment **ab_testing_pinning**, in dem die Auswirkungen von „pinned“ versus „unpinned“ A/B-Testkonfigurationen auf die Mischfenster-Dauer und die Stabilität der Step-Reihenfolge in einer virtuellen Maschinenumgebung untersucht werden.
[Artikel zum Thema](https://donau2space.de/tag-121-1749-wolken-ueber-passau-und-mein-pinned-vs-unpinned-a-b-zeigt-endlich-was-wirklich-am-mischfenster-zieht/)
[Git Repository](https://git.donau2space.de/Mika/ab_testing_pinning)
### 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
Dieses Repository enthält zwei Hauptartefakte, die das Experiment und die Analyse abbilden:
### 1. `trace_agg`
- **Art**: Python-Skript (`python_script`)
- **Zielumgebung**: Linux Userspace
- **Sprache**: Python
- **Zweck**: Aggregation von Trace-Daten und Erstellung komprimierter JSON-Summaries pro Experimentdurchlauf.
#### API-Übersicht
**Funktionen:**
- `generate_summary(trace_data)` Erzeugt eine kompakte JSON-Zusammenfassung aus den übergebenen Trace-Daten.
**Datenstrukturen:**
- `trace_data` (JSON)
- Felder: `run_id`, `mischfenster_p50`, `mischfenster_p95`, `mischfenster_max`, `step_order_stability`, `read_between_steps`
---
### 2. `experiment_analysis`
- **Art**: Dokumentation (`doc_only`)
- **Zielumgebung**: Plattformübergreifend
- **Zweck**: Enthält die Analyse- und Ergebnisbeschreibung der A/B-Testkonfigurationen, insbesondere Auswirkungen auf Mischfenster und Step-Reihenfolge.
## Installation & Nutzung
Dieses Repository enthält Python-Komponenten. Eine Standard-Python-Umgebung (>=3.8) wird empfohlen.
### Installation
1. Repository klonen:
`git clone https://git.donau2space.de/Mika/ab_testing_pinning`
2. In das Verzeichnis wechseln:
`cd ab_testing_pinning`
3. Abhängigkeiten installieren (falls benötigt, z.B. für JSON-Verarbeitung):
`pip install -r requirements.txt`
### Nutzung des Python-Skripts
1. Python-Interpreter starten oder Skript direkt ausführen.
2. Eingabedatei mit Trace-Daten übergeben:
`python trace_agg.py path/to/trace_input.json`
3. Die Ausgabe ist ein JSON-Summary pro Lauf.
## Typische Use-Cases
- Auswertung und Vergleich von „pinned“ und „unpinned“ A/B-Testkonfigurationen.
- Analyse von Latenzkennwerten in virtuellen Maschinen.
- Untersuchung der Stabilität der Ausführungsreihenfolge (Step Order).
- Erstellung wiederholbarer Zusammenfassungen aus Log- oder Trace-Daten.
## Struktur & mögliche Erweiterungen
Die Repository-Struktur ist modular aufgebaut:
- `trace_agg.py` zentrale Funktionalität zur Datenauswertung.
- `docs/` Analyseergebnisse und Erläuterungen.
Erweiterungen können beinhalten:
- Zusätzliche Analysemetriken in `trace_agg`.
- Visualisierung der JSON-Ergebnisse.
- Einbindung in CI/CD-Testframeworks.
## Lizenz
Lizensiert unter der **MIT-Lizenz**.
*Hinweis:* Diese Inhalte wurden automatisch mit KI erstellt. Verwendung und Interpretation erfolgen auf eigene Verantwortung.