diff --git a/.obsidian/graph.json b/.obsidian/graph.json index 95255d5..761368c 100644 --- a/.obsidian/graph.json +++ b/.obsidian/graph.json @@ -4,19 +4,62 @@ "showTags": true, "showAttachments": false, "hideUnresolved": false, - "showOrphans": false, - "collapse-color-groups": true, - "colorGroups": [], + "showOrphans": true, + "collapse-color-groups": false, + "colorGroups": [ + { + "query": "file:Tasks", + "color": { + "a": 1, + "rgb": 14701138 + } + }, + { + "query": "file:Fragen", + "color": { + "a": 1, + "rgb": 14725458 + } + }, + { + "query": "path:Exposé ", + "color": { + "a": 1, + "rgb": 11657298 + } + }, + { + "query": "path:Thesis ", + "color": { + "a": 1, + "rgb": 5431378 + } + }, + { + "query": "path: Themen", + "color": { + "a": 1, + "rgb": 5431473 + } + }, + { + "query": "path: Umsetzung ", + "color": { + "a": 1, + "rgb": 5419488 + } + } + ], "collapse-display": false, "showArrow": false, - "textFadeMultiplier": 0, - "nodeSizeMultiplier": 1.22291666666667, + "textFadeMultiplier": 0.1, + "nodeSizeMultiplier": 1.35052083333333, "lineSizeMultiplier": 3.2390625, "collapse-forces": false, - "centerStrength": 0.119791666666667, - "repelStrength": 0, - "linkStrength": 0.734375, - "linkDistance": 258, - "scale": 0.6094112847442601, + "centerStrength": 0.942708333333333, + "repelStrength": 20, + "linkStrength": 0.5625, + "linkDistance": 30, + "scale": 0.25972394690573425, "close": false } \ No newline at end of file diff --git a/.obsidian/workspace.json b/.obsidian/workspace.json index 746a4df..23a6e27 100644 --- a/.obsidian/workspace.json +++ b/.obsidian/workspace.json @@ -13,15 +13,30 @@ "state": { "type": "markdown", "state": { - "file": "Umsetzung/Responses.md", + "file": "Tasks.md", "mode": "source", "source": false }, "icon": "lucide-file", - "title": "Responses" + "title": "Tasks" + } + }, + { + "id": "1d18b9de81e07b7d", + "type": "leaf", + "state": { + "type": "markdown", + "state": { + "file": "Exposé/3_Verwendete_Methoden.md", + "mode": "source", + "source": false + }, + "icon": "lucide-file", + "title": "3_Verwendete_Methoden" } } - ] + ], + "currentTab": 1 } ], "direction": "vertical" @@ -113,12 +128,12 @@ "state": { "type": "outgoing-link", "state": { - "file": "Umsetzung/Responses.md", + "file": "Tasks.md", "linksCollapsed": false, "unlinkedCollapsed": true }, "icon": "links-going-out", - "title": "Outgoing links from Responses" + "title": "Outgoing links from Tasks" } }, { @@ -156,13 +171,13 @@ "state": { "type": "outline", "state": { - "file": "Fragen.md", + "file": "Tasks.md", "followCursor": false, "showSearch": false, "searchQuery": "" }, "icon": "lucide-list", - "title": "Outline of Fragen" + "title": "Outline of Tasks" } }, { @@ -194,44 +209,45 @@ "obsidian-git:Open Git source control": false } }, - "active": "48e5fb98d63b2d4f", + "active": "1d18b9de81e07b7d", "lastOpenFiles": [ - "Fragen.md", - "Umsetzung/Responses.md", - "Umsetzung", + "Tasks.md", "Ideen Vorgehensweise.md", - "Themen/Grammatik.md", - "Exposé/0_Problembeschreibung.md", - "Exposé/1_Ziele.md", + "Umsetzung/3_Service_Layer/Response Orchestrator.md", + "Umsetzung/3_Service_Layer/Scoring Model.md", + "Umsetzung/3_Service_Layer/API Endpoints.md", "Exposé/3_Verwendete_Methoden.md", - "Themen/Architektur.md", - "Themen/Natural Language Processing.md", - "Architektur.md", + "Exposé/1_Ziele.md", "Exposé/4_Zeitplan.md", - "Exposé/_Inhalt.md", + "Themen/Architektur.md", + "Umsetzung/1_Core_Layer/Plug-In-Manager.md", + "Umsetzung/3_Service_Layer/Socket Connector.md", + "Umsetzung/2.2_Extended_Analysis_Plugins/Hallucination Checker.md", + "Umsetzung/2.2_Extended_Analysis_Plugins/Fact Checker.md", + "Umsetzung/2.2_Extended_Analysis_Plugins/Context Checker.md", + "Umsetzung/2.1_Analysis_Orchestrator/Workflow.md", + "Umsetzung/2.1_Analysis_Orchestrator/Pipeline.md", + "Umsetzung/2_Core_Analysis/Repetition Checker.md", + "Umsetzung/2_Core_Analysis/Grammar Checker.md", + "Umsetzung/2_Core_Analysis/Spelling Checker.md", + "Umsetzung/2_Core_Analysis/Punctuation Checker.md", + "Umsetzung/1_Core_Layer/Documentation Tool.md", + "Umsetzung/1_Core_Layer/Performance Metric Observator.md", + "Umsetzung/1_Core_Layer/Port Listener.md", + "Umsetzung/1_Core_Layer/Logger.md", + "Umsetzung/1_Core_Layer/Parser.md", + "Umsetzung/1_Core_Layer/CLI.md", + "Umsetzung/3_Service_Layer", + "Umsetzung/2.2_Extended_Analysis_Plugins", + "Umsetzung/2.1_Analysis_Orchestrator", + "Umsetzung/2_Core_Analysis", + "Umsetzung/1_Core_Layer", + "Themen/assets/Architecture.png", + "Themen/assets", + "Untitled", + "Umsetzung", "Untitled.base", - "_Hinweise.md", "Themen", - "Thesis/04_ Ausblick/01_Zusammenfassung/_Inhalt.md", - "Thesis/04_ Ausblick/02_Ausblick/_Inhalt.md", - "Thesis/03_Ergebnisse/_Inhalt.md", - "Thesis/02_Versuchsbeschreibung/03_Versuchsdurchführung/_Inhalt.md", - "Thesis/02_Versuchsbeschreibung/02_Konzepterstellung/_Inhalt.md", - "Thesis/02_Versuchsbeschreibung/01_Analyse der Aufgabenstellung/_Inhalt.md", - "Thesis/02_Versuchsbeschreibung/_Inhalt.md", - "Thesis/01_Theorie/_Inhalt.md", - "Thesis/00_Einleitung/03_Gliederung der Arbeit/_Inhalt.md", - "Thesis/00_Einleitung/03_Gliederung der Arbeit", - "Thesis/00_Einleitung/02_Aufgabenstellung/_Inhalt.md", - "Thesis/00_Einleitung/01_Motivation/_Inhalt.md", - "Thesis/00_Einleitung/02_Aufgabenstellung", - "Thesis/00_Einleitung/_Inhalt.md", - "Thesis/00_Einleitung/01_Motivation", - "Thesis/00_Einleitung", - "Thesis/02_Versuchsbeschreibung/03_Versuchsdurchführung/Versuchsdurchführung.md", - "Thesis/04_ Ausblick/02_Ausblick", - "Thesis/04_ Ausblick/01_Zusammenfassung", - "Thesis/02_Versuchsbeschreibung/03_Versuchsdurchführung", "Untitled.canvas" ] } \ No newline at end of file diff --git a/Exposé/3_Verwendete_Methoden.md b/Exposé/3_Verwendete_Methoden.md index e88c0fb..159e815 100644 --- a/Exposé/3_Verwendete_Methoden.md +++ b/Exposé/3_Verwendete_Methoden.md @@ -2,3 +2,31 @@ tags: - Methoden --- +Für das Erstellen der Thesis werden folgende Werkzeuge, die mit folgendem Zweck verwendet werden. + +| Werkzeug | Zweck | +| ---------------- | -------------------------------------------------------- | +| Obsidian | Knowledge Graph, Persönliche Dokumentation, Organisation | +| Gitea | Online Repository und Code Organisation, Management | +| LaTeX / Typst | Schreiben der Thesis / Exposé | +| Zotero | Dokumentation und Datenbank der verwendeten Quellen | +| DrawIO / Mermaid | Graphenerstellung | +| VSCode | Development Environment | +| Python | Ausgewählte Programmiersprache | +| Docker / Podman | Containerisierung | +| CI/CD | Gitea Worker | + +# Repository Strategien + +## Branching +Für Sicherheitserhöhung soll parallel zum `main` Branch ein `beta` Branch existieren. Arbeitspakete gehen vom `beta` Branch aus und werden bereits dort durch die CI/CD-Pipeline. Damit soll mehrfach geprüft werden, dass implementierte Module / Features vernünftig funktionieren und Probleme nicht direkt auf den `main` Branch veröffentlicht werden. + +## CI / CD +Für die CI/CD Pipeline sind folgende Module von Interesse: +1. Linter +2. Modultests +3. Automatische Generierung der Dokumentation + +# Code Stil +Für den Code Stil wird sich an die Vorgaben durch Google gehalten, folgender [Styleguide](https://google.github.io/styleguide/pyguide.html) wird dafür verwendet. Dem Linter wird dieses Styleguide ebenfalls übergeben, sodass die Code-Architektur Einheitlich durchgeführt wird. + diff --git a/Tasks.md b/Tasks.md new file mode 100644 index 0000000..0d29d7e --- /dev/null +++ b/Tasks.md @@ -0,0 +1,32 @@ +- [ ] #task Besprechung der Response Objekte aus 🔽 +- [ ] Exposé + - [ ] Bearbeitung von [[0_Problembeschreibung]] + - [ ] Bearbeitung von [[1_Ziele]] + - [ ] Bearbeitung von [[3_Verwendete_Methoden]] + - [ ] Bearbeitung von [[4_Zeitplan]] +- [ ] Betrachtung der Einzelnen Module und ihrer Abhängigkeiten🔺 + - [ ] Core Layer + - [ ] [[Plug-In-Manager]] + - [ ] [[Parser]] + - [ ] [[Logger]] + - [ ] [[CLI]] + - [ ] [[Port Listener]] + - [ ] [[Performance Metric Observator]] + - [ ] [[Documentation Tool]] + - [ ] Core Analysis + - [ ] [[Punctuation Checker]] + - [ ] [[Grammar Checker]] + - [ ] [[Repetition Checker]] + - [ ] [[Spelling Checker]] + - [ ] Analysis Orchestrator + - [ ] [[Pipeline]] + - [ ] [[Workflow]] + - [ ] Extended-Analysis-Plug-Ins + - [ ] [[Context Checker]] + - [ ] [[Fact Checker]] + - [ ] [[Hallucination Checker]] + - [ ] Service Layer + - [ ] [[API Endpoints]] + - [ ] [[Response Orchestrator]] + - [ ] [[Scoring Model]] + - [ ] [[Socket Connector]] diff --git a/Themen/Architektur.md b/Themen/Architektur.md index 38724d1..3dda433 100644 --- a/Themen/Architektur.md +++ b/Themen/Architektur.md @@ -2,8 +2,8 @@ tags: - Architektur --- - Für die #Architektur kann eine #PlugInArchitektur verwendet werden. Diese Bietet das Erstellen von Modulen direkt womit man manche Module an bzw. ausschalten kann. Es ermöglicht zudem das vereinfachte erstellen von #Modultests. #Architektur/ChannelsAndFilter bietet das erstellen einzelner Filter, welches im Rahmen der Thesis passen könnte. Problematisch wäre jedoch die Zeitversetzung und Umsetzung selbst. Da mehrere unterschiedliche Services (z.B. Wikipedia) zur Datenverifikation verwendet werden sollen wäre eine Nutzer-angepasste Architektur interessanter (siehe #Architektur/PlugInArchitektur) +![[Architecture.png]] diff --git a/Themen/assets/Architecture.png b/Themen/assets/Architecture.png new file mode 100644 index 0000000..0a1fd17 Binary files /dev/null and b/Themen/assets/Architecture.png differ diff --git a/Thesis/02_Versuchsbeschreibung/01_Analyse der Aufgabenstellung/_Inhalt.md b/Thesis/01_Analyse der Aufgabenstellung/_Inhalt.md similarity index 100% rename from Thesis/02_Versuchsbeschreibung/01_Analyse der Aufgabenstellung/_Inhalt.md rename to Thesis/01_Analyse der Aufgabenstellung/_Inhalt.md diff --git a/Thesis/01_Theorie/_Inhalt.md b/Thesis/02_Versuchsbeschreibung/01_Theorie/_Inhalt.md similarity index 100% rename from Thesis/01_Theorie/_Inhalt.md rename to Thesis/02_Versuchsbeschreibung/01_Theorie/_Inhalt.md diff --git a/Thesis/04_ Ausblick/01_Zusammenfassung/_Inhalt.md b/Thesis/04_Ausblick/01_Zusammenfassung/_Inhalt.md similarity index 100% rename from Thesis/04_ Ausblick/01_Zusammenfassung/_Inhalt.md rename to Thesis/04_Ausblick/01_Zusammenfassung/_Inhalt.md diff --git a/Thesis/04_ Ausblick/02_Ausblick/_Inhalt.md b/Thesis/04_Ausblick/02_Ausblick/_Inhalt.md similarity index 100% rename from Thesis/04_ Ausblick/02_Ausblick/_Inhalt.md rename to Thesis/04_Ausblick/02_Ausblick/_Inhalt.md diff --git a/Umsetzung/1_Core_Layer/CLI.md b/Umsetzung/1_Core_Layer/CLI.md new file mode 100644 index 0000000..e69de29 diff --git a/Umsetzung/1_Core_Layer/Documentation Tool.md b/Umsetzung/1_Core_Layer/Documentation Tool.md new file mode 100644 index 0000000..e69de29 diff --git a/Umsetzung/1_Core_Layer/Logger.md b/Umsetzung/1_Core_Layer/Logger.md new file mode 100644 index 0000000..e69de29 diff --git a/Umsetzung/1_Core_Layer/Parser.md b/Umsetzung/1_Core_Layer/Parser.md new file mode 100644 index 0000000..e69de29 diff --git a/Umsetzung/1_Core_Layer/Performance Metric Observator.md b/Umsetzung/1_Core_Layer/Performance Metric Observator.md new file mode 100644 index 0000000..e69de29 diff --git a/Umsetzung/1_Core_Layer/Plug-In-Manager.md b/Umsetzung/1_Core_Layer/Plug-In-Manager.md new file mode 100644 index 0000000..e69de29 diff --git a/Umsetzung/1_Core_Layer/Port Listener.md b/Umsetzung/1_Core_Layer/Port Listener.md new file mode 100644 index 0000000..e69de29 diff --git a/Umsetzung/2.1_Analysis_Orchestrator/Pipeline.md b/Umsetzung/2.1_Analysis_Orchestrator/Pipeline.md new file mode 100644 index 0000000..e69de29 diff --git a/Umsetzung/2.1_Analysis_Orchestrator/Workflow.md b/Umsetzung/2.1_Analysis_Orchestrator/Workflow.md new file mode 100644 index 0000000..e69de29 diff --git a/Umsetzung/2.2_Extended_Analysis_Plugins/Context Checker.md b/Umsetzung/2.2_Extended_Analysis_Plugins/Context Checker.md new file mode 100644 index 0000000..e69de29 diff --git a/Umsetzung/2.2_Extended_Analysis_Plugins/Fact Checker.md b/Umsetzung/2.2_Extended_Analysis_Plugins/Fact Checker.md new file mode 100644 index 0000000..e69de29 diff --git a/Umsetzung/2.2_Extended_Analysis_Plugins/Hallucination Checker.md b/Umsetzung/2.2_Extended_Analysis_Plugins/Hallucination Checker.md new file mode 100644 index 0000000..e69de29 diff --git a/Umsetzung/2_Core_Analysis/Grammar Checker.md b/Umsetzung/2_Core_Analysis/Grammar Checker.md new file mode 100644 index 0000000..e69de29 diff --git a/Umsetzung/2_Core_Analysis/Punctuation Checker.md b/Umsetzung/2_Core_Analysis/Punctuation Checker.md new file mode 100644 index 0000000..e69de29 diff --git a/Umsetzung/2_Core_Analysis/Repetition Checker.md b/Umsetzung/2_Core_Analysis/Repetition Checker.md new file mode 100644 index 0000000..e69de29 diff --git a/Umsetzung/2_Core_Analysis/Spelling Checker.md b/Umsetzung/2_Core_Analysis/Spelling Checker.md new file mode 100644 index 0000000..e69de29 diff --git a/Umsetzung/3_Service_Layer/API Endpoints.md b/Umsetzung/3_Service_Layer/API Endpoints.md new file mode 100644 index 0000000..e69de29 diff --git a/Umsetzung/Responses.md b/Umsetzung/3_Service_Layer/Response Orchestrator.md similarity index 87% rename from Umsetzung/Responses.md rename to Umsetzung/3_Service_Layer/Response Orchestrator.md index 4df3d87..5078423 100644 --- a/Umsetzung/Responses.md +++ b/Umsetzung/3_Service_Layer/Response Orchestrator.md @@ -18,4 +18,3 @@ Beispielweise als JSON Objekt: } ``` -#task Besprechung der Response Objekte \ No newline at end of file diff --git a/Umsetzung/3_Service_Layer/Scoring Model.md b/Umsetzung/3_Service_Layer/Scoring Model.md new file mode 100644 index 0000000..e69de29 diff --git a/Umsetzung/3_Service_Layer/Socket Connector.md b/Umsetzung/3_Service_Layer/Socket Connector.md new file mode 100644 index 0000000..e69de29