feature/refactoring-to-config-yamls (#1)

- refactored interfaces to load data from yamls (c968e7e49a06f10fa6dbb5db88515babfa8c1912)
- added pre-commit hooks (86c6b7a57b59dd8e472b98e98631564c39b326a0)
- reformatted with black (8baa175c53a2ccfea9fefd5a45ac29b7235d5cd9)
- added gitignore (41de85cf1736b8be3aacb7ae3b65f6280db360d8)
- created new generic class WrappedGradioObjects, and GradioTabWrapper (7408f28aba5894a10feb2fe1c1976ce721e74745)
- allows to read tabs from yaml (70533e977986bab9ef25d7417627b4cb3d56cc97)


Co-authored-by: Mättu <maettubfh@users.noreply.huggingface.co>

.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+
+-   repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+    -   id: black

app.py

@@ -1,56 +1,5 @@
-import gradio as gr
+from nlp_circle_demo.wrapped_gradio_objects import GradioTabWrapper
 
-qa_text = '<a href="https://huggingface.co/deepset/gelectra-large-germanquad">Gelelctra</a> </br> 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. '
-gpt2_text = '<a href="https://huggingface.co/dbmdz/german-gpt2/tree/main">GPT-2</a> </br> 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.  '
-summarization_text = '<a href="https://huggingface.co/Einmalumdiewelt/T5-Base_GNAD">T5-Base</a> </br> Hier wurde ein sogenanntes T5-Sprachmodell auf den Task der Text-Zusammenfassung spezialisiert. Das Modell versteht nur Deutsch und hat 220 Millionen Parameter.'
-simplifaction_text = '<a href="https://huggingface.co/haining/scientific_abstract_simplification">Scientific Abstract Simplification</a> </br> 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.'
-legal_text = '<a href="https://huggingface.co/joelito/legal-german-roberta-large">Roberta German</a> </br><a href="https://huggingface.co/xlm-roberta-large">Roberta</a> </br> 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 XLM-RoBERTa-Modell deutlich allgemeinere Wörter wie Freiheit, Demokratie oder Öffentlichkeit voraussagt. Beide Modelle haben 354 Millionen Parameter.'
-gbert_desc = '<a href="https://huggingface.co/harshildarji/gbert-legal-ner">GBert Legal</a> </br>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).'
-zero_shot_desc = '<a href="https://huggingface.co/Sahajtomar/German_Zeroshot]">German Zeroshot</a> </br> 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 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 wurde auf deutschsprachige Texte trainiert. '
-
-
-qaExamples = [["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 Einzelbäumen, die in 16.000 Arten unterteilt sind.", "Welcher Name wird auch verwendet, um den Amazonas-Regenwald auf Englisch zu beschreiben?"]]
-
-sumExamples = [
-    "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."]
-
-legalExample = ["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."]
-
-bertExample = ["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."]
-
-gbertExample = ["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 ."]
-
-zeroShotExample = [["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, Finanzen, Medizin, Gesundheit", True]]
-
-qaInterface = gr.Interface.load("huggingface/deepset/gelectra-large-germanquad",
-                                title=None,
-                                description=qa_text,
-                                examples=qaExamples
-                                )
-
-gptInterface = gr.Interface.load(
-    "huggingface/gpt2", title=None, description=gpt2_text)
-
-summarizationInterface = gr.Interface.load(
-    "huggingface/Einmalumdiewelt/T5-Base_GNAD", title=None, description=summarization_text)
-
-simplicationInterface = gr.Interface.load(
-    "huggingface/haining/scientific_abstract_simplification", title=None, description=simplifaction_text)
-
-robertaGer = gr.Interface.load(
-    "huggingface/joelito/legal-german-roberta-large", title=None, description=legal_text, examples=legalExample)
-
-roberta = gr.Interface.load(
-    "huggingface/deepset/gbert-large", title=None, description=legal_text, examples=bertExample)
-
-gbert = gr.Interface.load("huggingface/harshildarji/gbert-legal-ner", title=None, description=gbert_desc, examples=gbertExample)
-
-zeroShot = gr.Interface.load("huggingface/Sahajtomar/German_Zeroshot", title=None, description=zero_shot_desc, examples=zeroShotExample)
-
-legalInterface = gr.TabbedInterface([robertaGer, roberta], ["Roberta Legal", "Bert"])
-
-demo = gr.TabbedInterface([gptInterface, legalInterface ,qaInterface, summarizationInterface, simplicationInterface, gbert, zeroShot], [
-                          "GPT", "Legal", "Question Answering", "Summarization", "Simplification", "Named Entity Recognition", "Zero-Shot-Klassifizierung"])
-
-demo.launch()
+if __name__ == "__main__":
+    demo = GradioTabWrapper.from_yaml("resources/tabs/app_tab.yml")
+    demo.launch()

packages.txt

@@ -0,0 +1 @@
+PyYAML

poetry.toml

@@ -0,0 +1,2 @@
+[virtualenvs]
+create = false

pyproject.toml

@@ -0,0 +1,20 @@
+[tool.poetry]
+name = "nlp-circle-demo"
+version = "0.1.0"
+description = ""
+authors = ["Your Name <you@example.com>"]
+readme = "README.md"
+packages = []
+
+[tool.poetry.dependencies]
+python = "^3.10"
+gradio = "^3.26.0"
+pyyaml = "^6.0"
+
+[tool.poetry.dev-dependencies]
+pre-commit = "^3.2"
+black = "^23.3"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

resources/interfaces/gbert_interface.yml

@@ -0,0 +1,12 @@
+title: German BERT
+name: huggingface/deepset/gbert-large
+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
+        und Art. 36 BV wahren müsse.

resources/interfaces/gpt2_interface.yml

@@ -0,0 +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
+    1400x kleiner als ChatGPT - und somit auch erkennbar schlechter in der Textgenerierung.
+examples:
+    - Paris is the capital of
+    - Auf Deutsch funktioniert das Modell deutlich

resources/interfaces/legal_german_roberta_interface.yml

@@ -0,0 +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
+    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
+        und Art. 36 BV wahren müsse.

resources/interfaces/ner_interface.yml

@@ -0,0 +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
+    Law (=Gesetz).'
+examples:
+    - >
+        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/interfaces/qa_interface.yml

@@ -0,0 +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
+    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
+            Einzelbäumen, die in 16.000 Arten unterteilt sind.
+        - Welcher Name wird auch verwendet, um den Amazonas-Regenwald auf Englisch zu beschreiben?

resources/interfaces/simplification_interface.yml

@@ -0,0 +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
+    Modell funktioniert nur auf Englisch.

resources/interfaces/summarization_interface.yml

@@ -0,0 +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
+    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
+        12,174,880, or about 18 percent of the population of France as of 2017.

resources/interfaces/zero_shot_interface.yml

@@ -0,0 +1,48 @@
+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:
+    <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
+    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
+    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
+            14,83 Millionen Toten.
+        -
+            - Wirtschaft
+            - Familie
+            - Politik
+            - Finanzen
+            - Medizin
+            - Gesundheit
+        - True

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/templates/template_interface.yml

@@ -0,0 +1,20 @@
+title: Some Title # will be used as tab title and for the link.
+name: huggingface/deepset/gelectra-large-germanquad # path to model
+description: > # Adding > here allows multiline strings
+    This
+    is
+    a
+    string
+    accross
+    multiple
+    lines
+examples:
+    # This is how we can do nested lists
+    - # First example
+        - 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/wrapped_gradio_objects.py

@@ -0,0 +1,78 @@
+import gradio as gr
+import yaml
+
+
+class WrappedGradioObject:
+    def __init__(self, title, gradio_element):
+        self.title = title
+        self.gradio_element = gradio_element
+
+    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."""
+        content_dict = cls.read_yaml(path)
+        return cls.create_interface(**content_dict)
+
+    @classmethod
+    def create_interface(cls, name, title, description, examples=None):
+        """Creates Gradio-Element containing an interface."""
+        description = cls._prepend_link_to_description(name, title, description)
+        interface = gr.load(
+            name,
+            title=None,  # Having the Tab-Name is sufficient.
+            description=description,
+            examples=examples,
+        )
+        return cls(title, interface)
+
+    @staticmethod
+    def _prepend_link_to_description(name, title, description):
+        without_huggingface = name.removeprefix("huggingface/")
+        link = f"https://huggingface.co/{without_huggingface}"
+        return f'<a href="{link}">{title}</a> </br> {description}'
+
+
+class GradioTabWrapper(WrappedGradioObject):
+    @classmethod
+    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],
+            [obj.title for obj in gradio_objects],
+        )
+        return cls(title, interface)
+
+    @classmethod
+    def from_yaml(cls, path):
+        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."
+        )