allows to read tabs from yaml

app.py

@@ -1,40 +1,5 @@
-import gradio as gr
+from nlp_circle_demo.wrapped_gradio_objects import GradioTabWrapper
 
-from src.nlp_circle_demo.interface import GradioInterfaceWrapper, GradioTabWrapper
-
-
-robertaGer = GradioInterfaceWrapper.from_yaml(
-    "resources/legal_german_roberta_interface.yml"
-)
-gbert = GradioInterfaceWrapper.from_yaml("resources/gbert_interface.yml")
-
-legalInterface = GradioTabWrapper.from_interface_list("Legal", [robertaGer, gbert])
-
-
-ner = GradioInterfaceWrapper.from_yaml("resources/ner_interface.yml")
-
-zeroShot = GradioInterfaceWrapper.from_yaml("resources/zero_shot_interface.yml")
-
-qaInterface = GradioInterfaceWrapper.from_yaml("resources/qa_interface.yml")
-simplicationInterface = GradioInterfaceWrapper.from_yaml(
-    "resources/simplification_interface.yml"
-)
-gptInterface = GradioInterfaceWrapper.from_yaml("resources/gpt2_interface.yml")
-summarizationInterface = GradioInterfaceWrapper.from_yaml(
-    "resources/summarization_interface.yml"
-)
-
-
-demo = GradioTabWrapper.from_interface_list(
-    "NLP Demo-Seite",
-    [
-        gptInterface,
-        legalInterface,
-        qaInterface,
-        summarizationInterface,
-        simplicationInterface,
-        ner,
-        zeroShot,
-    ],
-)
-demo.launch()
+if __name__ == "__main__":
+    demo = GradioTabWrapper.from_yaml("resources/tabs/app_tab.yml")
+    demo.launch()

resources/{gbert_interface.yml → interfaces/gbert_interface.yml}

@@ -1,12 +1,12 @@
 title: German BERT
 name: huggingface/deepset/gbert-large
-description: > 
+description: >
     Hier zeigen wir ein Vergleichsmodell, welches ebenfalls maskierte Wörter (hier mit dem Stichwort [Mask]) zu erraten
     versucht. Dieses Modell wurde allerdings nicht auf rechtliche Sprache spezialisiert, weshalb die prognostizierten
     Wörter deutlich weniger spezifisch sind. Beide Modelle haben 354 Millionen Parameter.
 examples:
     # This is how we can do nested lists
-    - > 
-        Die Beschwerdeführerin rügt sodann eine Verletzung des Verhältnismässigkeitsprinzips. Sie ist der 
-        Auffassung, dass die Publikationstätigkeit der WEKO den Grundsatz der [MASK] gemäss Art. 5 Abs. 2 
+    - >
+        Die Beschwerdeführerin rügt sodann eine Verletzung des Verhältnismässigkeitsprinzips. Sie ist der
+        Auffassung, dass die Publikationstätigkeit der WEKO den Grundsatz der [MASK] gemäss Art. 5 Abs. 2
         und Art. 36 BV wahren müsse.

resources/{gpt2_interface.yml → interfaces/gpt2_interface.yml}

@@ -1,11 +1,11 @@
 title: GPT2 # will be used as tab title and for the link.
 name: huggingface/gpt2 # path to model
-description: > 
-    GPT-3.5, auf dem ChatGPT beruht. Das Modell vervollständigt eingegebene Texte, in dem 
-    es immer ein wahrscheinliches nächstes Wort voraussagt. Allerdings hat es auch einen 
-    kleinen Zufallsfaktor, damit der gleiche Input nicht immer das gleiche Resultat liefern. 
-    Das hier vorgestellte deutschsprachige GPT-2 Modell hat 124 Millionen Parameter, ist also 
+description: >
+    GPT-3.5, auf dem ChatGPT beruht. Das Modell vervollständigt eingegebene Texte, in dem
+    es immer ein wahrscheinliches nächstes Wort voraussagt. Allerdings hat es auch einen
+    kleinen Zufallsfaktor, damit der gleiche Input nicht immer das gleiche Resultat liefern.
+    Das hier vorgestellte deutschsprachige GPT-2 Modell hat 124 Millionen Parameter, ist also
     1400x kleiner als ChatGPT - und somit auch erkennbar schlechter in der Textgenerierung.
 examples:
     - Paris is the capital of
-    - Auf Deutsch funktioniert das Modell deutlich 
+    - Auf Deutsch funktioniert das Modell deutlich

resources/{legal_german_roberta_interface.yml → interfaces/legal_german_roberta_interface.yml}

@@ -1,16 +1,16 @@
 title: Legal German RoBERTa
 name: huggingface/joelito/legal-german-roberta-large
-description: > 
-    Hier zeigen wir ein Modell, welches an unserem Institut darauf vortrainiert wurde, die rechtliche Sprache 
-    besser zu verstehen. Dabei wird in einem Text immer ein Wort (mit dem Stichwort <mask>) maskiert, und das 
-    Modell muss das fehlende Wort voraussagen. Dadurch, dass das Modell auf die rechtliche Sprache spezifiziert 
-    wurde, sind die Voraussagen deutlich besser, wie das nachfolgende Beispiel zeigt (BGE 142 II 268 S. 271, 
-    Erwägung 4.1): Unser spezialisiertes Modell gibt richtigerweise das Wort “Verhältnismässigkeit” aus, während 
-    ein generisches Modell (im anderen Tab) deutlich allgemeinere Wörter wie Freiheit, Demokratie oder Öffentlichkeit 
+description: >
+    Hier zeigen wir ein Modell, welches an unserem Institut darauf vortrainiert wurde, die rechtliche Sprache
+    besser zu verstehen. Dabei wird in einem Text immer ein Wort (mit dem Stichwort <mask>) maskiert, und das
+    Modell muss das fehlende Wort voraussagen. Dadurch, dass das Modell auf die rechtliche Sprache spezifiziert
+    wurde, sind die Voraussagen deutlich besser, wie das nachfolgende Beispiel zeigt (BGE 142 II 268 S. 271,
+    Erwägung 4.1): Unser spezialisiertes Modell gibt richtigerweise das Wort “Verhältnismässigkeit” aus, während
+    ein generisches Modell (im anderen Tab) deutlich allgemeinere Wörter wie Freiheit, Demokratie oder Öffentlichkeit
     voraussagt. Beide Modelle haben 354 Millionen Parameter.
 examples:
     # This is how we can do nested lists
-    - > 
-        Die Beschwerdeführerin rügt sodann eine Verletzung des Verhältnismässigkeitsprinzips. Sie ist der 
-        Auffassung, dass die Publikationstätigkeit der WEKO den Grundsatz der <mask> gemäss Art. 5 Abs. 2 
+    - >
+        Die Beschwerdeführerin rügt sodann eine Verletzung des Verhältnismässigkeitsprinzips. Sie ist der
+        Auffassung, dass die Publikationstätigkeit der WEKO den Grundsatz der <mask> gemäss Art. 5 Abs. 2
         und Art. 36 BV wahren müsse.

resources/{ner_interface.yml → interfaces/ner_interface.yml}

@@ -1,14 +1,13 @@
 title: Named Entity Recognition # will be used as tab title and for the link.
 name: huggingface/harshildarji/gbert-legal-ner # path to model
 description: >
-    Bei dieser Aufgabe geht es darum, automatisch Eigennamen oder Entitäten, engl. named entities, 
-    in einem Text zu erkennen und einer Klasse zuzuordnen. So wäre beispielsweise Max Mustermann ein 
-    Eigenname der Klasse Person; Berner Fachhochschule wäre ein Eigenname der Klasse Organisation. Das 
-    hier verwendete Beispielmodell wurde auf juristische Texte des Deutschen trainiert und erkennt 
-    Eigennamen, die für die juristischen Domäne relevant sind, wie zum Beispiel Lawyer (= Anwalt) oder 
+    Bei dieser Aufgabe geht es darum, automatisch Eigennamen oder Entitäten, engl. named entities,
+    in einem Text zu erkennen und einer Klasse zuzuordnen. So wäre beispielsweise Max Mustermann ein
+    Eigenname der Klasse Person; Berner Fachhochschule wäre ein Eigenname der Klasse Organisation. Das
+    hier verwendete Beispielmodell wurde auf juristische Texte des Deutschen trainiert und erkennt
+    Eigennamen, die für die juristischen Domäne relevant sind, wie zum Beispiel Lawyer (= Anwalt) oder
     Law (=Gesetz).'
 examples:
     - >
-        1. Das Bundesarbeitsgericht ist gemäß § 9 Abs. 2 Satz 2 ArbGG iVm. § 201 Abs. 1 Satz 2 GVG für 
+        1. Das Bundesarbeitsgericht ist gemäß § 9 Abs. 2 Satz 2 ArbGG iVm. § 201 Abs. 1 Satz 2 GVG für
         die beabsichtigte Klage gegen den Bund zuständig.
-        

resources/{qa_interface.yml → interfaces/qa_interface.yml}

@@ -1,24 +1,24 @@
 title: Question Answering
 name: huggingface/deepset/gelectra-large-germanquad
 description: >
-    Dieses deutschsprachige Modell wurde darauf spezialisiert, in einem Text die Antwort auf eine 
-    gestellte Frage zu finden. Es basiert auf XLM-RoBERTa, einem mehrsprachigen Modell mit 270 
+    Dieses deutschsprachige Modell wurde darauf spezialisiert, in einem Text die Antwort auf eine
+    gestellte Frage zu finden. Es basiert auf XLM-RoBERTa, einem mehrsprachigen Modell mit 270
     Millionen Parameter.
 examples:
-    - 
+    -
         - Mein Name ist Wolfgang und ich lebe in Berlin
         - Wo wohne ich?
-    - 
+    -
         - >
-            Der Amazonas-Regenwald, auf Englisch auch als Amazonien oder Amazonas-Dschungel bekannt, 
-            ist ein feuchter Laubwald, der den größten Teil des Amazonas-Beckens Südamerikas bedeckt. 
-            Dieses Becken umfasst 7.000.000 Quadratkilometer (2.700.000 Quadratmeilen), von denen 
-            5.500.000 Quadratkilometer (2.100.000 Quadratmeilen) vom Regenwald bedeckt sind. Diese 
-            Region umfasst Gebiete von neun Nationen. Der größte Teil des Waldes befindet sich in 
-            Brasilien mit 60% des Regenwaldes, gefolgt von Peru mit 13%, Kolumbien mit 10% und geringen 
-            Mengen in Venezuela, Ecuador, Bolivien, Guyana, Suriname und Französisch-Guayana. Staaten 
-            oder Abteilungen in vier Nationen enthalten \"Amazonas\" in ihren Namen. Der Amazonas 
-            repräsentiert mehr als die Hälfte der verbleibenden Regenwälder des Planeten und umfasst 
-            den größten und artenreichsten tropischen Regenwald der Welt mit geschätzten 390 Milliarden 
+            Der Amazonas-Regenwald, auf Englisch auch als Amazonien oder Amazonas-Dschungel bekannt,
+            ist ein feuchter Laubwald, der den größten Teil des Amazonas-Beckens Südamerikas bedeckt.
+            Dieses Becken umfasst 7.000.000 Quadratkilometer (2.700.000 Quadratmeilen), von denen
+            5.500.000 Quadratkilometer (2.100.000 Quadratmeilen) vom Regenwald bedeckt sind. Diese
+            Region umfasst Gebiete von neun Nationen. Der größte Teil des Waldes befindet sich in
+            Brasilien mit 60% des Regenwaldes, gefolgt von Peru mit 13%, Kolumbien mit 10% und geringen
+            Mengen in Venezuela, Ecuador, Bolivien, Guyana, Suriname und Französisch-Guayana. Staaten
+            oder Abteilungen in vier Nationen enthalten \"Amazonas\" in ihren Namen. Der Amazonas
+            repräsentiert mehr als die Hälfte der verbleibenden Regenwälder des Planeten und umfasst
+            den größten und artenreichsten tropischen Regenwald der Welt mit geschätzten 390 Milliarden
             Einzelbäumen, die in 16.000 Arten unterteilt sind.
         - Welcher Name wird auch verwendet, um den Amazonas-Regenwald auf Englisch zu beschreiben?

resources/{simplification_interface.yml → interfaces/simplification_interface.yml}

@@ -1,7 +1,7 @@
 title: Text-Vereinfachung # will be used as tab title and for the link.
 name: huggingface/haining/scientific_abstract_simplification # path to model
 description: > # Adding > here allows multiline strings
-    Bei dieser Aufgabe geht es darum, komplexe Sachverhalte einfach zu erklären. Dieses Beispielmodell kann die 
-    Abstracts von wissenschaftlichen Publikationen so vereinfachen, dass sie auch für Laien verständlich werden. 
-    Ähnliche Methoden könnten verwendet werden, um beispielsweise Schweizer Rechtstexte zu vereinfachen. Dieses 
+    Bei dieser Aufgabe geht es darum, komplexe Sachverhalte einfach zu erklären. Dieses Beispielmodell kann die
+    Abstracts von wissenschaftlichen Publikationen so vereinfachen, dass sie auch für Laien verständlich werden.
+    Ähnliche Methoden könnten verwendet werden, um beispielsweise Schweizer Rechtstexte zu vereinfachen. Dieses
     Modell funktioniert nur auf Englisch.

resources/{summarization_interface.yml → interfaces/summarization_interface.yml}

@@ -1,14 +1,13 @@
 title: Text-Zusammenfassung # will be used as tab title and for the link.
 name: huggingface/Einmalumdiewelt/T5-Base_GNAD # path to model
 description: >
-    Hier wurde ein sogenanntes T5-Sprachmodell auf den Task der Text-Zusammenfassung 
+    Hier wurde ein sogenanntes T5-Sprachmodell auf den Task der Text-Zusammenfassung
     spezialisiert. Das Modell versteht nur Deutsch und hat 220 Millionen Parameter.
 examples:
     # TODO: Hier ein deutsches Beispiel
     - >
-        Paris is the capital and most populous city of France, with an estimated population 
-        of 2,175,601 residents as of 2018, in an area of more than 105 square kilometres 
-        (41 square miles). The City of Paris is the centre and seat of government of the region 
-        and province of Île-de-France, or Paris Region, which has an estimated population of 
+        Paris is the capital and most populous city of France, with an estimated population
+        of 2,175,601 residents as of 2018, in an area of more than 105 square kilometres
+        (41 square miles). The City of Paris is the centre and seat of government of the region
+        and province of Île-de-France, or Paris Region, which has an estimated population of
         12,174,880, or about 18 percent of the population of France as of 2017.
-

resources/{zero_shot_interface.yml → interfaces/zero_shot_interface.yml}

@@ -1,44 +1,44 @@
 title: Zero-Shot Interface
 name: huggingface/Sahajtomar/German_Zeroshot
 description: >
-    Bei dieser Aufgabe handelt es sich um eine Textklassifizierungsaufgabe. Das heißt, das Modell 
-    bekommt einen Textinhalt vorgelegt und muss aus einer Liste vordefinierter Labels entscheiden, 
-    welches dieser Labels den Inhalt des Textes am besten beschreibt. Der Krux bei der ganzen Sache ist, 
-    dass das Modell keine Spezialisierung für die Labels erfahren hat und sozusagen beim ersten Mal die 
-    richtige Auswahl treffen muss; daher zero shot, denn es hat nur einen Versuch. Erreicht wird dies, in 
-    dem ein vortrainiertes Modell auf einen Datensatz für Natural Language Inference (dt. natürlichsprachliche 
-    Inferenz oder Rückschluss auf natürliche Sprache) spezialisiert wird. Bei dieser Aufgabe bekommt 
-    das Modell zwei Texte vorgelegt und muss lernen, in welchem Verhältnis die beiden Texte zueinanderstehen. 
-    Folgende Klassen stehen dabei zur Auswahl: 
+    Bei dieser Aufgabe handelt es sich um eine Textklassifizierungsaufgabe. Das heißt, das Modell
+    bekommt einen Textinhalt vorgelegt und muss aus einer Liste vordefinierter Labels entscheiden,
+    welches dieser Labels den Inhalt des Textes am besten beschreibt. Der Krux bei der ganzen Sache ist,
+    dass das Modell keine Spezialisierung für die Labels erfahren hat und sozusagen beim ersten Mal die
+    richtige Auswahl treffen muss; daher zero shot, denn es hat nur einen Versuch. Erreicht wird dies, in
+    dem ein vortrainiertes Modell auf einen Datensatz für Natural Language Inference (dt. natürlichsprachliche
+    Inferenz oder Rückschluss auf natürliche Sprache) spezialisiert wird. Bei dieser Aufgabe bekommt
+    das Modell zwei Texte vorgelegt und muss lernen, in welchem Verhältnis die beiden Texte zueinanderstehen.
+    Folgende Klassen stehen dabei zur Auswahl:
     <ul>
         <li>entailment: Text A ist eine logische Schlussfolgerung von Text B</li>
         <li>contradiction: Text A steht im Widerspruch zu Text B</li>
         <li>neutral: es lassen sich keine Schlussfolgerungen dieser Art ziehen</li>
         </ul>
     </br></br>
-    Nehmen wir als Beispiel den Ausgangstext «Die Kinder lächeln und winken in die Kamera». Nach der Spezialisierung 
-    sollte das Modell in der Lage sein zu sagen, dass die Aussage «Es sind Kinder anwesend.» eine logische 
-    Schlussfolgerung des Ausgangstextes ist, während die Aussage «Die Kinder runzeln die Stirn.» im Widerspruch 
+    Nehmen wir als Beispiel den Ausgangstext «Die Kinder lächeln und winken in die Kamera». Nach der Spezialisierung
+    sollte das Modell in der Lage sein zu sagen, dass die Aussage «Es sind Kinder anwesend.» eine logische
+    Schlussfolgerung des Ausgangstextes ist, während die Aussage «Die Kinder runzeln die Stirn.» im Widerspruch
     zum Ausgangstext steht.
     </br></br>
-    Es hat sich gezeigt, dass Modelle, die auf Natural Language Inference spezialisiert wurden, auch sehr gut darin sind, 
-    Texten thematisch passende Labels zuzuordnen. Wenn wir wieder den Ausgangstext von vorhin nehmen, wäre das Modell in 
-    der Lage zu sagen, dass von den möglichen Kandidatenlabels [Wirtschaft, Familie, Feier, Tragödie] Familie und Feier 
-    diejenigen Labels sind, die den Inhalt des Textes am besten beschreiben.</br></br>Das hier verwendete Beispielmodell 
+    Es hat sich gezeigt, dass Modelle, die auf Natural Language Inference spezialisiert wurden, auch sehr gut darin sind,
+    Texten thematisch passende Labels zuzuordnen. Wenn wir wieder den Ausgangstext von vorhin nehmen, wäre das Modell in
+    der Lage zu sagen, dass von den möglichen Kandidatenlabels [Wirtschaft, Familie, Feier, Tragödie] Familie und Feier
+    diejenigen Labels sind, die den Inhalt des Textes am besten beschreiben.</br></br>Das hier verwendete Beispielmodell
     wurde auf deutschsprachige Texte trainiert.
 examples:
     -
         - >
-            COVID-19 (Akronym von englisch coronavirus disease 2019, deutsch Coronavirus-Krankheit-2019), in den 
-            deutschsprachigen Ländern umgangssprachlich meist nur als „Corona“ oder „Covid“ bezeichnet, ist eine 
-            meldepflichtige Infektionskrankheit mit einem breiten aber unspezifischen Symptomspektrum, die durch eine 
-            Infektion (Ansteckung) mit dem Betacoronavirus SARS-CoV-2 verursacht wird. Das Virus wurde erstmals im 
-            Dezember 2019 in Wuhan (Volksrepublik China) beschrieben. Es verbreitete sich sehr schnell weltweit und ist 
-            Ursache der COVID-19-Pandemie. Bis 18. Oktober 2022 wurden weltweit rund 622 Millionen COVID-Infizierte registriert, 
-            es wird aber in vielen Ländern eine hohe Dunkelziffer vermutet. Laut einer Schätzung der Weltgesundheitsorganisation 
-            (WHO) gab es zwischen Anfang 2020 und Ende 2021 eine weltweite, durch COVID-19 verursachte Übersterblichkeit von 
+            COVID-19 (Akronym von englisch coronavirus disease 2019, deutsch Coronavirus-Krankheit-2019), in den
+            deutschsprachigen Ländern umgangssprachlich meist nur als „Corona“ oder „Covid“ bezeichnet, ist eine
+            meldepflichtige Infektionskrankheit mit einem breiten aber unspezifischen Symptomspektrum, die durch eine
+            Infektion (Ansteckung) mit dem Betacoronavirus SARS-CoV-2 verursacht wird. Das Virus wurde erstmals im
+            Dezember 2019 in Wuhan (Volksrepublik China) beschrieben. Es verbreitete sich sehr schnell weltweit und ist
+            Ursache der COVID-19-Pandemie. Bis 18. Oktober 2022 wurden weltweit rund 622 Millionen COVID-Infizierte registriert,
+            es wird aber in vielen Ländern eine hohe Dunkelziffer vermutet. Laut einer Schätzung der Weltgesundheitsorganisation
+            (WHO) gab es zwischen Anfang 2020 und Ende 2021 eine weltweite, durch COVID-19 verursachte Übersterblichkeit von
             14,83 Millionen Toten.
-        - 
+        -
             - Wirtschaft
             - Familie
             - Politik

resources/tabs/app_tab.yml

@@ -0,0 +1,9 @@
+title: NLP Demo-Seite
+dependencies:
+- interfaces/gpt2_interface.yml
+- tabs/legal_tab.yml
+- interfaces/qa_interface.yml
+- interfaces/summarization_interface.yml
+- interfaces/simplification_interface.yml
+- interfaces/ner_interface.yml
+- interfaces/zero_shot_interface.yml

resources/tabs/legal_tab.yml

@@ -0,0 +1,4 @@
+title: Legal # will be used as tab title
+dependencies:
+- interfaces/legal_german_roberta_interface.yml
+- interfaces/gbert_interface.yml

resources/{template_interface.yml → templates/template_interface.yml}

@@ -3,7 +3,7 @@ name: huggingface/deepset/gelectra-large-germanquad # path to model
 description: > # Adding > here allows multiline strings
     This
     is
-    a 
+    a
     string
     accross
     multiple
@@ -14,7 +14,7 @@ examples:
         - Foo
         - Bar
     - # Second example
-        - > 
+        - >
             Hello
             world
         - Hello who?

resources/templates/template_tab.yml

@@ -0,0 +1,3 @@
+title: Some Title # will be used as tab title
+dependencies:
+- templates/template_interface.yaml # provide all dependant interfaces as a list

src/nlp_circle_demo/{interface.py → wrapped_gradio_objects.py}

@@ -10,13 +10,17 @@ class WrappedGradioObject:
     def launch(self):
         return self.gradio_element.launch()
 
+    @staticmethod
+    def read_yaml(path):
+        with open(path) as f:
+            return yaml.safe_load(f)
+
 
 class GradioInterfaceWrapper(WrappedGradioObject):
     @classmethod
     def from_yaml(cls, path):
         """Initializes Interface from YAML file."""
-        with open(path) as f:
-            content_dict = yaml.safe_load(f)
+        content_dict = cls.read_yaml(path)
         return cls.create_interface(**content_dict)
 
     @classmethod
@@ -40,7 +44,7 @@ class GradioInterfaceWrapper(WrappedGradioObject):
 
 class GradioTabWrapper(WrappedGradioObject):
     @classmethod
-    def from_interface_list(cls, title, gradio_objects):
+    def from_gradio_object_list(cls, title, gradio_objects):
         """Constructs a GradioTabWrapper from a title and a list of WrappedGradioObjects."""
         interface = gr.TabbedInterface(
             [obj.gradio_element for obj in gradio_objects],
@@ -50,4 +54,25 @@ class GradioTabWrapper(WrappedGradioObject):
 
     @classmethod
     def from_yaml(cls, path):
-        pass
+        content_dict = cls.read_yaml(path)
+        gradio_objects = [
+            cls._read_dependency(dependency)
+            for dependency in content_dict["dependencies"]
+        ]
+        return cls.from_gradio_object_list(
+            content_dict["title"],
+            gradio_objects,
+        )
+
+    @staticmethod
+    def _read_dependency(path):
+        full_path = f"resources/{path}"
+        if path.startswith("interfaces"):
+            return GradioInterfaceWrapper.from_yaml(full_path)
+        if path.startswith("tabs"):
+            return GradioTabWrapper.from_yaml(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."
+        )