intro-tab (#7)

- Put Introduction into separate Tab (fac72ad1067c8dc1cfd6c9701921f140a4bd1490)


Co-authored-by: Mättu <[email protected]>

resources/markdown/einführung.md

@@ -0,0 +1,18 @@
+# NLP Demo-Seite
+Spätestens seit der Veröffentlichung von ChatGPT geniessen moderne Sprachmodelle grosse öffentliche Aufmerksamkeit. Allerdings ist es für nicht-Experten schwierig einzuschätzen, inwiefern diese in ihrem Arbeitsumfeld eingesetzt werden könnten. Damit auch sie sich ein Bild von Möglichkeiten und Limitierungen von grossen Sprachmodellen machen können, haben wir diese interaktive Webseite entwickelt.
+
+Grundsätzlich sind Sprachmodelle nichts als statistische Modelle, welche die menschliche Sprache abbilden. Sie werden zunächst mit sehr zahlreichen Texten auf gewisse, sehr allgemeine Aufgaben "vortrainiert", wodurch sie die Grundstruktur der Sprache erlernen können. Solche allgemeinen Modelle werden "Foundation Models" genannt.
+
+#### GPT als Beispiel für ein Foundation Model
+Eine solche Aufgabe ist es zum Beispiel, das nächste Wort in einem Text vorauszusagen. Um dies lösen zu können, braucht ein Modell einerseits ein Verständnis für Grammatik. Anderseits muss es aber auch lernen, welche Wörter in einem Kontext gemeinsam vorkommen, um stets das richtige Wort voraussagen zu können. Ein Beispiel für ein solches Modell ist GPT-2, welches Sie in der nachfolgenden Demo ausprobieren können. Die vortrainierten Sprachmodelle haben also bereits ein Verständnis für Sprache und bilden daher die Basis für zahlreiche Anwendungen.
+
+#### Anwendung von Foundation Models
+Die Anwendung von Foundation Models kann grob in zwei Kategorien unterteilt werden: Bei der **Zero-Shot Anwendung** wird das Modell direkt dafür verwendet, um eine Aufgabe zu lösen. Wir können hierfür einfach ein Modell etwas fragen, und das Modell die Antwort generieren lassen - so wie wir es beispielsweise bei der Verwendung von ChatGPT tun. Beim **Finetuning** wird das Modell hingegen anhand von weiteren Beispielen auf eine ganz bestimmte Anwendung spezialisiert. Dies führt oft noch zu besseren Resultaten als die Zero-Shot-Verwendung, allerdings erfordert die Spezialisierung  Beispieldaten für die Aufgabe und ist mit grösserem technischem Aufwand verbunden.
+
+#### Modellgrösse
+Die Qualität des Sprachmodells hängt stark von der Grösse des Modells und des Datensatzes ab. Während die Technologien hinter ChatGPT bereits weitestgehend bekannt waren, ist das einzige Geheimnis hinter den verblüffenden Resultaten die Modellgrösse: Das Modell hat 175 Milliarden Parameter und wurde auf über 8 Milliarden Textdokumenten trainiert. Dadurch konnte es ein so gutes Verständnis für Sprache und das Erkennen von thematischen Kontexten erlangen, dass man das Gefühl hat, man interagiere mit einem anderen Menschen.
+
+#### Über diese Demoseite
+Mit dieser Demoseite wollen wir eine Intuition für verschiedene Anwendungsmöglichkeiten von Foundation Models vermitteln. In den Reiter "GPT2" und "Legal" kann direkt mit Foundation Models interagiert werden. "Question Answering", "Text-Zusammenfassung" und "Named Entity Recognition" sind beispiele für Modelle, welche mittels Finetuning spezialisiert wurden. Im "Zero-Shot Interface" ist schliesslich ein Beispiel für eine Zero-Shot Verwendung aufgezeigt.
+
+Die Demoseite wurde am Institut für Public Sector Transformation der Berner Fachhochschule entwickelt.

resources/tabs/app_tab.yml

@@ -1,5 +1,6 @@
 title: NLP Demo-Seite
 dependencies:
+- markdown/einführung.md
 - interfaces/gpt2_interface.yml
 - tabs/legal_tab.yml
 - interfaces/qa_interface.yml

src/nlp_circle_demo/wrapped_gradio_objects.py

@@ -1,5 +1,6 @@
 import gradio as gr
 import yaml
+import os
 
 
 class WrappedGradioObject:
@@ -15,6 +16,11 @@ class WrappedGradioObject:
         with open(path) as f:
             return yaml.safe_load(f)
 
+    @staticmethod
+    def read_file(path):
+        with open(path) as f:
+            return f.read()
+
 
 class GradioInterfaceWrapper(WrappedGradioObject):
     @classmethod
@@ -71,8 +77,26 @@ class GradioTabWrapper(WrappedGradioObject):
             return GradioInterfaceWrapper.from_yaml(full_path)
         if path.startswith("tabs"):
             return GradioTabWrapper.from_yaml(full_path)
+        if path.startswith("markdown"):
+            return GradioMarkdownWrapper.from_markdown(full_path)
         raise ValueError(
             "Gradio Object Type could not be inferred from path name. Make sure "
-            "that all interface object yamls are in resources/interfaces, and that "
-            "all tab object yamls are in resources/tabs."
+            "that all interface object yamls are in resources/interfaces, "
+            "all tab object yamls are in resources/tabs, and all markdown objects "
+            "are in resources/markdown."
         )
+
+
+class GradioMarkdownWrapper(WrappedGradioObject):
+    @classmethod
+    def from_markdown(cls, path):
+        """Creates text from markdown. The title is inferred from the file name."""
+        content = cls.read_file(path)
+        title = cls.title_from_path(path)
+        return cls(title, gr.Markdown(content))
+
+    @staticmethod
+    def title_from_path(path):
+        _, last = os.path.split(path)
+        name, _ = os.path.splitext(last)
+        return name.capitalize()