diff --git a/README.md b/README.md new file mode 100644 index 0000000..80f663c --- /dev/null +++ b/README.md @@ -0,0 +1,78 @@ +# Holdover Test + +## Überblick +Untersuchung der Auswirkungen von CPU-Governoren auf C-States und Clocksource-Wechsel über einen 24-Stunden-Testzeitraum. + +Weitere Informationen unter: [Artikel-Link](https://donau2space.de/tag-79-24-h-holdover-bootstrap-ci-bestaetigt-governor-effekt-c-state-muster-praezisiert/) + +### 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 Werkzeuge und Dokumentation zur Analyse von CPU-Zuständen, Leistungsdaten und Clocksource-Verhalten unter Linux. Der Experiment-Key **holdover_test** definiert die Grundlage der hier hinterlegten Tests und Auswertungen. + +### Artefakt-Liste + +#### 1. bootstrap_resampling +- **Art:** Linux CLI-Tool +- **Ziel:** Linux Userspace +- **Sprachen:** Python +- **Zweck:** Durchführung von Bootstrap-Resampling zur Analyse von Leistungsdaten. + +**API-Funktionen:** +- `run_bootstrap(data, iterations)` – führt das Bootstrap-Resampling aus und liefert aggregierte Kennzahlen. + +**Datenstruktur:** +- `bootstrap_results` (JSON): `mean`, `ci_lower`, `ci_upper`, `outliers` + +#### 2. c_state_analysis +- **Art:** Linux CLI-Tool +- **Ziel:** Linux Userspace +- **Sprachen:** Python +- **Zweck:** Analyse von C-State-Daten und Ermittlung möglicher Performance-Auswirkungen. + +**API-Funktionen:** +- `analyze_c_states(c_state_data)` – wertet C-State-Daten aus und gibt Analyseergebnisse zurück. + +**Datenstruktur:** +- `analysis_results` (JSON): `median_c3_residency`, `switch_events`, `correlation` + +#### 3. trace_repo_template +- **Art:** Dokumentation +- **Ziel:** gemischt (Analyse-Templates und Aggregationsbeschreibung) +- **Sprachen:** — +- **Zweck:** Dokumentation der Template-Struktur und Aggregationsvorgänge für C-State- und Clocksource-Analysen. + +## Installation & Nutzung + +### Für CLI-Tools (bootstrap_resampling, c_state_analysis) +1. Python-Umgebung vorbereiten (mind. Version 3.8) +2. Repository klonen: + `git clone ` +3. Abhängigkeiten installieren: + `pip install -r requirements.txt` +4. Tool ausführen: + `python -m bootstrap_resampling --input data.json --iterations 1000` + `python -m c_state_analysis --input c_states.json` + +## Typische Use-Cases +- Vergleich der Effekte unterschiedlicher CPU-Governoren über 24 Stunden +- Statistische Analyse von C-State-Residencies mittels Bootstrap-Verfahren +- Untersuchung der Clocksource-Wechselhäufigkeit unter Lastbedingungen +- Erstellung reproduzierbarer Datenreports durch Template-basierte Analyse + +## Struktur & mögliche Erweiterungen +- Erweiterung um zusätzliche CPU-Zustände (C7/C10) +- Integration weiterer Clocksource-Metriken +- Automatisierte Vergleichsauswertung über mehrere Hosts +- Ergänzung der Template-Dokumentation mit Beispielplots + +## Lizenz +Veröffentlicht unter der **MIT-Lizenz**. + +--- + +*Hinweis:* Diese Inhalte wurden automatisch von einer KI erstellt. Nutzung und Änderungen erfolgen auf eigenes Risiko. \ No newline at end of file