Incorporate NLP capabilities and detach wilhelm-vocabulary's database loading responsibility

.github/load_all_in_parallel.py

@@ -1,48 +0,0 @@
-# Copyright Jiaqi Liu
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-from multiprocessing import Process, Queue
-
-from wilhelm_python_sdk import latin_loader
-from wilhelm_python_sdk import german_loader
-from wilhelm_python_sdk import ancient_greek_loader
-
-def load_latin(queue):
-    latin_loader.load_into_database("latin.yaml")
-    queue.put("Latin loads successfully")
-
-
-def load_german(queue):
-    german_loader.load_into_database("german.yaml")
-    queue.put("German loads successfully")
-
-
-def load_ancient_greek(queue):
-    ancient_greek_loader.load_into_database("ancient_greek.yaml")
-    queue.put("Ancient Greek loads successfully")
-
-
-if __name__ == "__main__":
-    queue = Queue()
-
-    latin = Process(target=load_latin, args=(queue, ))
-    german = Process(target=load_german, args=(queue, ))
-    ancient_greek = Process(target=load_ancient_greek, args=(queue, ))
-
-    latin.start()
-    german.start()
-    ancient_greek.start()
-
-    # Blocking
-    result = queue.get()

.github/load_ancient_greek.py

@@ -1,18 +0,0 @@
-# Copyright Jiaqi Liu
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-from wilhelm_python_sdk.ancient_greek_loader import load_into_database
-
-if __name__ == "__main__":
-    load_into_database("ancient-greek.yaml")

.github/load_german.py

@@ -1,18 +0,0 @@
-# Copyright Jiaqi Liu
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-from wilhelm_python_sdk.german_loader import load_into_database
-
-if __name__ == "__main__":
-    load_into_database("german.yaml")

.github/load_latin.py

@@ -1,18 +0,0 @@
-# Copyright Jiaqi Liu
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-from wilhelm_python_sdk.latin_loader import load_into_database
-
-if __name__ == "__main__":
-    load_into_database("latin.yaml")

.github/workflows/ci-cd.yaml

@@ -45,13 +45,6 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actionshub/yamllint@main
 
-  markdown-lint:
-    name: Markdown Style Check
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actionshub/markdownlint@main
-
   linkChecker:
     name: Link Check
     runs-on: ubuntu-latest
@@ -62,97 +55,69 @@ jobs:
         with:
           fail: true
 
-  tests:
-    needs: [yaml-lint, markdown-lint, linkChecker]
+  code-style:
+    name: Python Code Style Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: PEP 8 check
+        run: python setup.py pep8
+      - name: Check import orders
+        run: python setup.py isort
+
+  unit-tests:
+    name: Unit Tests
+    needs: [yaml-lint, linkChecker, code-style]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ env.PYTHON_VERSION }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Run tests
+        run: python setup.py test
+
+  sync-to-huggingface-space:
+    needs: [yaml-lint, linkChecker, code-style]
     runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [
-          {
-            name: German,
-            load-script: .github/load_german.py
-          },
-          {
-            name: Ancient Greek,
-            load-script: .github/load_ancient_greek.py
-          },
-          {
-            name: Latin,
-            load-script: .github/load_latin.py
-          },
-          {
-            name: all languages (race condition test ①),
-            load-script: .github/load_all_in_parallel.py
-          },
-          {
-            name: all languages (race condition test ②),
-            load-script: .github/load_all_in_parallel.py
-          },
-          {
-            name: all languages (race condition test ③),
-            load-script: .github/load_all_in_parallel.py
-          },
-          {
-            name: all languages (race condition test ④),
-            load-script: .github/load_all_in_parallel.py
-          },
-          {
-            name: all languages (race condition test ⑤),
-            load-script: .github/load_all_in_parallel.py
-          },
-          {
-            name: all languages (race condition test ⑥),
-            load-script: .github/load_all_in_parallel.py
-          },
-          {
-            name: all languages (race condition test ⑦),
-            load-script: .github/load_all_in_parallel.py
-          },
-          {
-            name: all languages (race condition test ⑧),
-            load-script: .github/load_all_in_parallel.py
-          },
-          {
-            name: all languages (race condition test ⑨),
-          },
-          {
-            name: all languages (race condition test ⑩),
-            load-script: .github/load_all_in_parallel.py
-          }
-        ]
     steps:
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0
+          lfs: true
       - name: Set up Python ${{ env.PYTHON_VERSION }}
         uses: actions/setup-python@v4
         with:
           python-version: ${{ env.PYTHON_VERSION }}
-      - name: Startup a Neo4J database
+      - name: Install dependencies
+        run: pip3 install -e .
+      - name: Generate Hugging Face Datasets
         run: |
-          docker run \
-              --publish=7474:7474 \
-              --publish=7687:7687 \
-              --env=NEO4J_AUTH=none \
-              --env=NEO4J_ACCEPT_LICENSE_AGREEMENT=yes neo4j:${{ env.NEO4J_ENTERPRISE_VERSION }} &
-      - name: Wait for database to be ready
-        uses: iFaxity/wait-on-action@v1
-        with:
-          resource: http://localhost:7474
-      - name: Test loading ${{ matrix.language.name }}
+          cd huggingface
+          python3 ./generate_datasets.py
+      - name: Push to hub
+        if: github.ref == 'refs/heads/master'
         run: |
-          pip3 install --upgrade --force-reinstall wilhelm-python-sdk
-          python3 ${{ matrix.language.load-script }}
+          git config --global user.name "QubitPi"
+          git config --global user.email "jack20220723@gmail.com"
+
+          git lfs install
+          git lfs track "*-graph-data.jsonl"
+          git add *-graph-data.jsonl
+
+          git commit -m "Generate Hugging Face Datasets"
+          git push https://QubitPi:[email protected]/datasets/QubitPi/wilhelm-vocabulary master:main -f
         env:
-          NEO4J_URI: ${{ env.NEO4J_URI }}
-          NEO4J_DATABASE: ${{ env.NEO4J_DATABASE }}
-          NEO4J_USERNAME: ${{ env.NEO4J_USERNAME }}
-          NEO4J_PASSWORD: ${{ env.NEO4J_PASSWORD }}
+          HF_TOKEN: ${{ secrets.HF_TOKEN }}
 
   docker:
-    name: Test Docker build and publish image to DockerHub
-    needs: [yaml-lint, markdown-lint, linkChecker]
+    name: Test Docker Build and Publish Data Image to DockerHub
+    needs: [sync-to-huggingface-space]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -177,10 +142,11 @@ jobs:
           resource: http://localhost:7474
       - name: Load all languages into the intermediate container
         run: |
-          pip3 install --upgrade --force-reinstall wilhelm-python-sdk
-          python3 .github/load_german.py
-          python3 .github/load_ancient_greek.py
-          python3 .github/load_latin.py
+          git clone https://github.com/QubitPi/wilhelm-data-loader.git ../wilhelm-data-loader
+          cd ../wilhelm-data-loader
+          pip3 install -r requirements.txt
+          pip3 install -e .
+          python3 wilhelm_vocabulary/load_all_in_parallel.py
         env:
           NEO4J_URI: ${{ env.NEO4J_URI }}
           NEO4J_DATABASE: ${{ env.NEO4J_DATABASE }}
@@ -215,78 +181,15 @@ jobs:
           repository: jack20191124/wilhelm-vocabulary
           readme-filepath: README.md
 
-  cleanup-neo4j:
-    if: github.ref == 'refs/heads/master'
-    needs: [tests, docker]
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - name: Set up Python ${{ env.PYTHON_VERSION }}
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ env.PYTHON_VERSION }}
-      - name: Cleanup
-        run: |
-          pip3 install --upgrade --force-reinstall wilhelm-python-sdk
-          python3 .github/cleanup_neo4j.py
-        env:
-          NEO4J_URI: ${{ secrets.NEO4J_URI }}
-          NEO4J_DATABASE: ${{ secrets.NEO4J_DATABASE }}
-          NEO4J_USERNAME: ${{ secrets.NEO4J_USERNAME }}
-          NEO4J_PASSWORD: ${{ secrets.NEO4J_PASSWORD }}
-
-  load-vocabulary:
-    name: Load ${{ matrix.language.name }} vocabularies
+  triggering:
+    name: Triggering data model acceptance tests CI/CD
+    needs: [sync-to-huggingface-space]
     if: github.ref == 'refs/heads/master'
-    needs: cleanup-neo4j
     runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [
-          {
-            name: German,
-            load-script: .github/load_german.py
-          },
-          {
-            name: Ancient Greek,
-            load-script: .github/load_ancient_greek.py
-          },
-          {
-            name: Latin,
-            load-script: .github/load_latin.py
-          }
-        ]
     steps:
-      - uses: actions/checkout@v3
+      - name: Trigger wilhelm-data-loader to load all vocabularies into graph database
+        uses: peter-evans/repository-dispatch@v2
         with:
-          fetch-depth: 0
-      - name: Set up Python ${{ env.PYTHON_VERSION }}
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ env.PYTHON_VERSION }}
-      - name: Load ${{ matrix.language.name }}
-        run: |
-          pip3 install --upgrade --force-reinstall wilhelm-python-sdk
-          python3 ${{ matrix.language.load-script }}
-        env:
-          NEO4J_URI: ${{ secrets.NEO4J_URI }}
-          NEO4J_DATABASE: ${{ secrets.NEO4J_DATABASE }}
-          NEO4J_USERNAME: ${{ secrets.NEO4J_USERNAME }}
-          NEO4J_PASSWORD: ${{ secrets.NEO4J_PASSWORD }}
-
-  sync-to-huggingface-space:
-    if: github.ref == 'refs/heads/master'
-    needs: tests
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-          lfs: true
-      - name: Push to hub
-        run: git push https://QubitPi:[email protected]/datasets/QubitPi/wilhelm-vocabulary master:main -f
-        env:
-          HF_TOKEN: ${{ secrets.HF_TOKEN }}
+          token: ${{ secrets.QUBITPI_DOWNSTREAM_CICD_TRIGGERING_TOKEN }}
+          repository: QubitPi/wilhelm-data-loader
+          event-type: wilhelm-vocabulary-changes

.isort.cfg

@@ -0,0 +1,2 @@
+[settings]
+force_single_line = True

.mdlrc

@@ -1,2 +0,0 @@
-rules "~MD002", "~MD003", "~MD005", "~MD007", "~MD013", "~MD022", "~MD024", "~MD027", "~MD028", "~MD029", "~MD033", "~MD034", "~MD036", "~MD041", "~MD055", "~MD057"
-style "#{File.dirname(__FILE__)}/markdownlint.rb"

README.md

@@ -1,51 +1,89 @@
+---
+license: apache-2.0
+pretty_name: Wilhelm Vocabulary
+language:
+  - en
+  - de
+  - la
+  - grc
+configs:
+  - config_name: Graph Data
+    data_files:
+    - split: German
+      path: german-graph-data.jsonl
+    - split: Latin
+      path: latin-graph-data.jsonl
+    - split: AncientGreek
+      path: ancient-greek-graph-data.jsonl
+tags:
+  - Natural Language Processing
+  - NLP
+  - Vocabulary
+  - German
+  - Latin
+  - Ancient Greek
+  - Knowledge Graph
+size_categories:
+  - 1K<n<10K
+---
+
 Wilhelm Vocabulary
 ==================
 
+[![Hugging Face dataset badge]][Hugging Face dataset URL]
+
 [![Vocabulary count - German]][Docker Hub URL]
 [![Vocabulary count - Latin]][Docker Hub URL]
 [![Vocabulary count - Ancient Greek]][Docker Hub URL]
 [![Docker Hub][Docker Pulls Badge]][Docker Hub URL]
-
 [![GitHub workflow status badge][GitHub workflow status badge]][GitHub workflow status URL]
 [![Hugging Face sync status badge]][Hugging Face sync status URL]
-[![Hugging Face dataset badge]][Hugging Face dataset URL]
 [![Apache License Badge]][Apache License, Version 2.0]
 
 <!-- TOC -->
+* [Wilhelm Vocabulary](#wilhelm-vocabulary)
+  * [Development](#development)
+    * [Environment Setup](#environment-setup)
+    * [Installing Dependencies](#installing-dependencies)
+    * [Data Format](#data-format)
+    * [Encoding Table in YAML](#encoding-table-in-yaml)
+  * [Data Pipeline](#data-pipeline)
+  * [How Data (Vocabulary) is Stored in a Graph Database](#how-data-vocabulary-is-stored-in-a-graph-database)
+    * [Why Graph Database](#why-graph-database)
+    * [Base Schema](#base-schema)
+  * [Languages](#languages)
+    * [German](#german)
+      * [Pronoun](#pronoun)
+      * [Noun](#noun)
+    * [Ancient Greek](#ancient-greek)
+      * [Diacritic Mark Convention](#diacritic-mark-convention)
+      * [Pronoun](#pronoun-1)
+      * [Noun](#noun-1)
+      * [Adjective Declension](#adjective-declension)
+      * [Verb Conjugation](#verb-conjugation)
+    * [Latin](#latin)
+    * [Classical Hebrew (Coming Soon)](#classical-hebrew-coming-soon)
+    * [Korean](#korean)
+  * [License](#license)
+<!-- TOC -->
 
-- [Wilhelm Vocabulary](#wilhelm-vocabulary)
-  - [Docker](#docker)
-    - [Interesting Queries](#interesting-queries)
-  - [Data Format](#data-format)
-    - [Encoding Table in YAML](#encoding-table-in-yaml)
-  - [Data Pipeline](#data-pipeline)
-  - [How Data (Vocabulary) is Stored in a Graph Database](#how-data-vocabulary-is-stored-in-a-graph-database)
-    - [Why Graph Database](#why-graph-database)
-    - [Base Schema](#base-schema)
-  - [Languages](#languages)
-    - [German](#german)
-      - [Pronoun](#pronoun)
-      - [Noun](#noun)
-    - [Ancient Greek](#ancient-greek)
-      - [Diacritic Mark Convention](#diacritic-mark-convention)
-      - [Pronoun](#pronoun-1)
-      - [Noun](#noun-1)
-      - [Adjective Declension](#adjective-declension)
-      - [Verb Conjugation](#verb-conjugation)
-    - [Latin](#latin)
-    - [Classical Hebrew (Coming Soon)](#classical-hebrew-coming-soon)
-    - [Korean](#korean)
-  - [License](#license)
+__wilhelm-vocabulary__ is the data sources used for the flashcard contents on [wilhelmlang.com]. Specifically it's a
+datasource manually made from the accumulation of the daily language studies of [myself](https://github.com/Qubitpi).
 
-<!-- TOC -->
+The data is available on 🤗 [Hugging Face Datasets][Hugging Face dataset URL]
 
-__Wilhelm Vocabulary__ is the data that drives the [wilhelmlang.com](https://wilhelmlang.com/).
+```python
+from datasets import load_dataset
+dataset = load_dataset("QubitPi/wilhelm-vocabulary")
+```
 
-Docker
-------
+> [!TIP]
+> 
+> If `dataset = load_dataset("QubitPi/wilhelm-vocabulary")` throws an error, please upgrade the `datasets` package to
+> its _latest version_
 
-A Docker image has been made to allow us to explore the vocabulary in Neo4J browser backed by a Neo4J database in
-container. To get the image and run the container, simply do:
+In addition, a Docker image has been made to allow us exploring the vocabulary in Neo4J browser backed by a Neo4J
+database. To get the image and run the container, simply do:
 
 ```console
 docker run \
@@ -70,10 +108,7 @@ docker run \
 
 ![Connecting to Neo4J Docker](docs/neo4j-docker-connect.png "Error loading neo4j-docker-connect.png")
 
-We have offered some queries that can be used to quickly explore our language data in the
-[next section](#interesting-queries)
-
-### Interesting Queries
+We have offered some queries that can be used to quickly explore the vocabulary in graph representations:
 
 - Search for all Synonyms: `MATCH (term:Term)-[r]-(synonym:Term) WHERE r.name = "synonym" RETURN term, r, synonym`
 - Finding all [gerunds](https://en.wiktionary.org/wiki/Appendix:Glossary#gerund):
@@ -104,15 +139,69 @@ We have offered some queries that can be used to quickly explore our language da
 
 - `MATCH (term:Term{label:'die Schwester'})  CALL apoc.path.expand(term, "LINK", null, 1, -1)  YIELD path  RETURN path, length(path) AS hops  ORDER BY hops;`
 
-Data Format
+Development
 -----------
 
-The data that serves [wilhelmlang.com](https://wilhelmlang.com/). They are written in YAML format, because
+### Environment Setup
+
+Get the source code:
+
+```console
+git clone [email protected]:QubitPi/wilhelm-vocabulary.git
+cd wilhelm-vocabulary
+```
+
+It is strongly recommended to work in an isolated environment. Install virtualenv and create an isolated Python
+environment by
+
+```console
+python3 -m pip install --user -U virtualenv
+python3 -m virtualenv .venv
+```
+
+To activate this environment:
+
+```console
+source .venv/bin/activate
+```
+
+or, on Windows
+
+```console
+./venv\Scripts\activate
+```
+
+> [!TIP]
+>
+> To deactivate this environment, use
+>
+> ```console
+> deactivate
+> ```
+
+### Installing Dependencies
+
+```console
+pip3 install -r requirements.txt
+```
+
+### Data Format
+
+The raw data is written in YAML format, because
 
 1. it is machine-readable so that it can be consumed quickly in data pipelines
 2. it is human-readable and, thus, easy to read and modify
 3. it supports multi-lines value which is very handy for language data
 
+The YAML data files are
+
+- [german.yaml](./german.yaml)
+- [latin.yaml](./latin.yaml)
+- [ancient-greek.yaml](./ancient-greek.yaml)
+
+These YAML files are then [transformed](huggingface/generate_datasets.py) to Hugging Face Datasets formats in
+[CI/CD](https://github.com/QubitPi/wilhelm-vocabulary/actions/workflows/ci-cd.yaml)
+
 ### Encoding Table in YAML
 
 To encode the inflections which are common in most Indo-European languages, an
@@ -570,15 +659,17 @@ The use and distribution terms for [wilhelm-vocabulary]() are covered by the [Ap
 [Docker Pulls Badge]: https://img.shields.io/docker/pulls/jack20191124/wilhelm-vocabulary?style=for-the-badge&logo=docker&color=2596EC
 [Docker Hub URL]: https://hub.docker.com/r/jack20191124/wilhelm-vocabulary
 
-[Hugging Face dataset badge]: https://img.shields.io/badge/Hugging%20Face%20Dataset-wilhelm--vocabulary-FFD21E?style=for-the-badge&logo=huggingface&logoColor=white
+[Hugging Face dataset badge]: https://img.shields.io/badge/Datasets-wilhelm--vocabulary-FF9D00?style=for-the-badge&logo=huggingface&logoColor=white&labelColor=6B7280
 [Hugging Face dataset URL]: https://huggingface.co/datasets/QubitPi/wilhelm-vocabulary
 
 [Hugging Face sync status badge]: https://img.shields.io/github/actions/workflow/status/QubitPi/wilhelm-vocabulary/ci-cd.yaml?branch=master&style=for-the-badge&logo=github&logoColor=white&label=Hugging%20Face%20Sync%20Up
 [Hugging Face sync status URL]: https://github.com/QubitPi/wilhelm-vocabulary/actions/workflows/ci-cd.yaml
 
-[GitHub workflow status badge]: https://img.shields.io/github/actions/workflow/status/QubitPi/wilhelm-vocabulary/ci-cd.yaml?branch=master&style=for-the-badge&logo=github&logoColor=white&label=Database%20Loading
+[GitHub workflow status badge]: https://img.shields.io/github/actions/workflow/status/QubitPi/wilhelm-vocabulary/ci-cd.yaml?branch=master&style=for-the-badge&logo=github&logoColor=white&label=CI/CD
 [GitHub workflow status URL]: https://github.com/QubitPi/wilhelm-vocabulary/actions/workflows/ci-cd.yaml
 
 [Vocabulary count - German]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.paion-data.dev%2Fwilhelm%2Flanguages%2Fgerman%2Fcount&query=%24%5B0%5D.count&suffix=%20Words&style=for-the-badge&logo=neo4j&logoColor=white&label=German&color=4581C3
 [Vocabulary count - Latin]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.paion-data.dev%2Fwilhelm%2Flanguages%2Flatin%2Fcount&query=%24%5B0%5D.count&suffix=%20Words&style=for-the-badge&logo=neo4j&logoColor=white&label=Latin&color=4581C3
 [Vocabulary count - Ancient Greek]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.paion-data.dev%2Fwilhelm%2Flanguages%2FancientGreek%2Fcount&query=%24%5B0%5D.count&suffix=%20Words&style=for-the-badge&logo=neo4j&logoColor=white&label=Ancient%20Greek&color=4581C3
+
+[wilhelmlang.com]: https://wilhelmlang.com/

docs/data-pipeline.drawio

@@ -1,62 +1,77 @@
-<mxfile host="app.diagrams.net" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36" version="24.7.15">
+<mxfile host="app.diagrams.net" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36" version="25.0.1">
   <diagram name="Page-1" id="-PRZJL_y_DcYyeR3ZVRW">
-    <mxGraphModel dx="2583" dy="976" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
+    <mxGraphModel dx="2924" dy="1145" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
       <root>
         <mxCell id="0" />
         <mxCell id="1" parent="0" />
-        <mxCell id="CBPTevJeyTvfQtbZMOis-2" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;curved=1;strokeColor=#2088FF;strokeWidth=3;" edge="1" parent="1" source="jEus2W5ITfwieqKF0qT7-1" target="jEus2W5ITfwieqKF0qT7-7">
-          <mxGeometry relative="1" as="geometry" />
-        </mxCell>
-        <mxCell id="CBPTevJeyTvfQtbZMOis-6" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeWidth=3;" edge="1" parent="1" source="jEus2W5ITfwieqKF0qT7-1">
+        <mxCell id="lBE7YV5RTTJSdhW3G_g6-8" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;fontSize=12;strokeWidth=3;" edge="1" parent="1" source="jEus2W5ITfwieqKF0qT7-1">
           <mxGeometry relative="1" as="geometry">
-            <mxPoint x="-290" y="470" as="targetPoint" />
+            <mxPoint x="-325" y="470" as="targetPoint" />
           </mxGeometry>
         </mxCell>
         <mxCell id="jEus2W5ITfwieqKF0qT7-1" value="" style="shape=image;verticalLabelPosition=bottom;labelBackgroundColor=default;verticalAlign=top;aspect=fixed;imageAspect=0;image=https://upload.wikimedia.org/wikipedia/en/thumb/0/06/Wiktionary-logo-v2.svg/1200px-Wiktionary-logo-v2.svg.png;" parent="1" vertex="1">
-          <mxGeometry x="-340" y="273" width="100" height="100" as="geometry" />
+          <mxGeometry x="-375" y="263.25" width="100" height="100" as="geometry" />
         </mxCell>
         <mxCell id="jEus2W5ITfwieqKF0qT7-7" value="" style="shape=image;verticalLabelPosition=bottom;labelBackgroundColor=default;verticalAlign=top;aspect=fixed;imageAspect=0;image=https://dist.neo4j.com/wp-content/uploads/20210616181554/neo4j-connects-data.svg;" parent="1" vertex="1">
-          <mxGeometry x="270" y="442" width="256.2" height="137" as="geometry" />
+          <mxGeometry x="300" y="441" width="256.2" height="137" as="geometry" />
         </mxCell>
-        <mxCell id="jEus2W5ITfwieqKF0qT7-11" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeWidth=3;strokeColor=#2088FF;" parent="1" target="jEus2W5ITfwieqKF0qT7-7" edge="1">
+        <mxCell id="jEus2W5ITfwieqKF0qT7-11" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeWidth=3;strokeColor=#FAA627;" parent="1" target="jEus2W5ITfwieqKF0qT7-7" edge="1">
           <mxGeometry relative="1" as="geometry">
-            <mxPoint x="-40" y="510" as="sourcePoint" />
+            <mxPoint x="200" y="509" as="sourcePoint" />
           </mxGeometry>
         </mxCell>
         <mxCell id="jEus2W5ITfwieqKF0qT7-10" value="" style="shape=image;verticalLabelPosition=bottom;labelBackgroundColor=default;verticalAlign=top;aspect=fixed;imageAspect=0;image=https://upload.wikimedia.org/wikipedia/commons/9/91/Octicons-mark-github.svg;" parent="1" vertex="1">
-          <mxGeometry x="-120" y="478.5" width="64" height="64" as="geometry" />
+          <mxGeometry x="-150" y="478" width="64" height="64" as="geometry" />
         </mxCell>
         <mxCell id="jEus2W5ITfwieqKF0qT7-30" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeWidth=3;" parent="1" edge="1">
           <mxGeometry relative="1" as="geometry">
-            <mxPoint x="-240" y="509.75" as="sourcePoint" />
-            <mxPoint x="-130" y="509.75" as="targetPoint" />
+            <mxPoint x="-275" y="509.75" as="sourcePoint" />
+            <mxPoint x="-165" y="509.75" as="targetPoint" />
           </mxGeometry>
         </mxCell>
         <mxCell id="jEus2W5ITfwieqKF0qT7-18" value="" style="shape=image;editableCssRules=.*;verticalLabelPosition=bottom;labelBackgroundColor=default;verticalAlign=top;aspect=fixed;imageAspect=0;image=data:image/svg+xml,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9Ii0wLjUgLTAuNSAyOCAyOCIgaGVpZ2h0PSIyOCIgd2lkdGg9IjI4Ij4mI3hhOwkgIDxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI+LnN0MCB7IHN0b3AtY29sb3I6IHJnYig5MSwgMTE1LCAxMzkpOyB9IC5zdDEgeyBzdG9wLWNvbG9yOiByZ2IoMzQsIDUzLCA3Mik7IH0gPC9zdHlsZT4mI3hhOwk8ZGVmcz4mI3hhOwkJPGxpbmVhckdyYWRpZW50IGdyYWRpZW50VW5pdHM9InVzZXJTcGFjZU9uVXNlIiB5Mj0iMjUuMzA5IiB4Mj0iMjMuNDU0IiB5MT0iMy40NzQiIHgxPSIyLjAzOSIgaWQ9IkEiPiYjeGE7CQkJPHN0b3AgY2xhc3M9InN0MCIvPiYjeGE7CQkJPHN0b3AgY2xhc3M9InN0MSIgb2Zmc2V0PSIxIi8+JiN4YTsJCTwvbGluZWFyR3JhZGllbnQ+JiN4YTsJPC9kZWZzPiYjeGE7CTxwYXRoIGZpbGw9InVybCgjQSkiIGQ9Ik0tLjUgMTMuNDcyYzAtMS45My4zNzEtMy43MyAxLjExMy01LjQuNzQyLTEuNzA3IDEuNzQ0LTMuMTkyIDMuMDA2LTQuNDUzUzYuMzY1IDEuMzU2IDguMDczLjYxMyAxMS41OTgtLjUgMTMuNTI4LS41czMuNzMuMzcxIDUuNCAxLjExM2MxLjcwNy43NDIgMy4xOTIgMS43NDQgNC40NTMgMy4wMDZzMi4yNjQgMi43NDYgMy4wMDYgNC40NTNjLjc0MiAxLjY3IDEuMTEzIDMuNDcgMS4xMTMgNS40cy0uMzcxIDMuNzQ4LTEuMTEzIDUuNDU1LTEuNzQ0IDMuMTkyLTMuMDA2IDQuNDUzYTE0LjI4IDE0LjI4IDAgMCAxLTQuNDUzIDMuMDA2Yy0xLjY3Ljc0Mi0zLjQ3IDEuMTEzLTUuNCAxLjExM3MtMy43NDgtLjM3MS01LjQ1NS0xLjExM2ExNC4yOCAxNC4yOCAwIDAgMS00LjQ1My0zLjAwNiAxNC4yOCAxNC4yOCAwIDAgMS0zLjAwNi00LjQ1M0MtLjEyOSAxNy4yMi0uNSAxNS40MDItLjUgMTMuNDcyem0xNi44MTEgNC4yMzFhNi42NSA2LjY1IDAgMCAxIDMuMjg0LjgzNWMxLjAwMi41MiAxLjgxOCAxLjI0MyAyLjQ0OSAyLjE3MWExMC4xNCAxMC4xNCAwIDAgMCAxLjk0OC0zLjI4NGMuNDgyLTEuMjI1LjcyNC0yLjU0Mi43MjQtMy45NTIgMC0xLjU1OS0uMjk3LTMuMDA2LS44OTEtNC4zNDItLjU5NC0xLjM3My0xLjM5Mi0yLjU2MS0yLjM5NC0zLjU2M3MtMi4xOS0xLjgtMy41NjMtMi4zOTRjLTEuMzM2LS41OTQtMi43ODMtLjg5MS00LjM0Mi0uODkxcy0zLjAyNC4yOTctNC4zOTguODkxYy0xLjMzNi41OTQtMi41MjQgMS4zOTItMy41NjMgMi4zOTRBMTEuMzUgMTEuMzUgMCAwIDAgMy4xNzQgOS4xM2MtLjU5NCAxLjMzNi0uODkxIDIuNzgzLS44OTEgNC4zNDIgMCAxLjQxLjIyMyAyLjcyOC42NjggMy45NTIuNDgyIDEuMjI1IDEuMTUgMi4zMTkgMi4wMDQgMy4yODQuNjMxLS45MjggMS40NDctMS42NTEgMi40NDktMi4xNzFhNi42NSA2LjY1IDAgMCAxIDMuMjg0LS44MzV6bTIuNzgzLTcuMDE0YTUuNjggNS42OCAwIDAgMS0uNDQ1IDIuMjI3IDUuODcgNS44NyAwIDAgMS0xLjIyNSAxLjc4MWMtLjQ4Mi40ODItMS4wNTguODcyLTEuNzI2IDEuMTY5cy0xLjM5Mi40NDUtMi4xNzEuNDQ1YTUuNjggNS42OCAwIDAgMS0yLjIyNy0uNDQ1IDYuNDQgNi40NCAwIDAgMS0xLjc4MS0xLjE2OSA2LjQ0IDYuNDQgMCAwIDEtMS4xNjktMS43ODEgNS42OCA1LjY4IDAgMCAxLS40NDUtMi4yMjdjMC0uNzc5LjE0OC0xLjUwMy40NDUtMi4xNzFBNi40NCA2LjQ0IDAgMCAxIDkuNTIgNi43MzdhNS44NyA1Ljg3IDAgMCAxIDEuNzgxLTEuMjI1IDUuNjggNS42OCAwIDAgMSAyLjIyNy0uNDQ1Yy43NzkgMCAxLjUwMy4xNDggMi4xNzEuNDQ1czEuMjQzLjcwNSAxLjcyNiAxLjIyNWE1Ljg3IDUuODcgMCAwIDEgMS4yMjUgMS43ODFjLjI5Ny42NjguNDQ1IDEuMzkyLjQ0NSAyLjE3MXptLTIuNzgzIDBjMC0uNzc5LS4yNzgtMS40MjktLjgzNS0xLjk0OC0uNTU3LS41NTctMS4yMDYtLjgzNS0xLjk0OC0uODM1YTIuNzMgMi43MyAwIDAgMC0yLjAwNC44MzVjLS41NTcuNTItLjgzNSAxLjE2OS0uODM1IDEuOTQ4YTIuNzMgMi43MyAwIDAgMCAuODM1IDIuMDA0Yy41NTcuNTIgMS4yMjUuNzc5IDIuMDA0Ljc3OS43NDIgMCAxLjM5Mi0uMjYgMS45NDgtLjc3OWEyLjczIDIuNzMgMCAwIDAgLjgzNS0yLjAwNHpNNy4wNzEgMjIuNjU3Yy44OTEuNjMxIDEuODc0IDEuMTMyIDIuOTUgMS41MDMgMS4xMTMuMzcxIDIuMjgyLjU1NyAzLjUwNy41NTcgMS4xODggMCAyLjMxOS0uMTg2IDMuMzk2LS41NTcgMS4xMTMtLjM3MSAyLjExNS0uODcyIDMuMDA2LTEuNTAzLS4zNzEtLjY2OC0uODkxLTEuMTg4LTEuNTU5LTEuNTU5LS42MzEtLjQwOC0xLjMxNy0uNjEyLTIuMDYtLjYxMmgtNS42MjJjLS43NDIgMC0xLjQ0Ny4yMDQtMi4xMTUuNjEyLS42MzEuMzcxLTEuMTMyLjg5MS0xLjUwMyAxLjU1OXoiLz4mI3hhOzwvc3ZnPg==;" parent="1" vertex="1">
-          <mxGeometry x="-322.25" y="478" width="64.5" height="64.5" as="geometry" />
+          <mxGeometry x="-357.25" y="478" width="64.5" height="64.5" as="geometry" />
         </mxCell>
-        <mxCell id="CBPTevJeyTvfQtbZMOis-7" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeWidth=3;" edge="1" parent="1" source="jEus2W5ITfwieqKF0qT7-20">
+        <mxCell id="CBPTevJeyTvfQtbZMOis-7" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeWidth=3;" parent="1" source="jEus2W5ITfwieqKF0qT7-20" edge="1">
           <mxGeometry relative="1" as="geometry">
-            <mxPoint x="-330" y="510.5" as="targetPoint" />
+            <mxPoint x="-365" y="510.5" as="targetPoint" />
           </mxGeometry>
         </mxCell>
         <mxCell id="jEus2W5ITfwieqKF0qT7-20" value="" style="shape=image;verticalLabelPosition=bottom;labelBackgroundColor=default;verticalAlign=top;aspect=fixed;imageAspect=0;image=https://cdn-icons-png.flaticon.com/512/8832/8832880.png;" parent="1" vertex="1">
-          <mxGeometry x="-501.25" y="474" width="73" height="73" as="geometry" />
+          <mxGeometry x="-536.25" y="474" width="73" height="73" as="geometry" />
         </mxCell>
-        <mxCell id="CBPTevJeyTvfQtbZMOis-8" style="rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=1;exitDx=0;exitDy=0;entryX=0;entryY=0;entryDx=0;entryDy=0;strokeWidth=3;" edge="1" parent="1" source="jEus2W5ITfwieqKF0qT7-23" target="jEus2W5ITfwieqKF0qT7-18">
+        <mxCell id="CBPTevJeyTvfQtbZMOis-8" style="rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=1;exitDx=0;exitDy=0;entryX=0;entryY=0;entryDx=0;entryDy=0;strokeWidth=3;" parent="1" source="jEus2W5ITfwieqKF0qT7-23" target="jEus2W5ITfwieqKF0qT7-18" edge="1">
           <mxGeometry relative="1" as="geometry" />
         </mxCell>
         <mxCell id="jEus2W5ITfwieqKF0qT7-23" value="" style="shape=image;verticalLabelPosition=bottom;labelBackgroundColor=default;verticalAlign=top;aspect=fixed;imageAspect=0;image=data:image/png,iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAABL1BMVEX///8AAABU2fj/kae+2u5W3///lawAxPOamppS1vQveYsSLzaHh4fD4PX4+/1ldH6ES1aPUV3/VHcgICBNyOQDCgsscYEoaHYIFhrt7e1hNz//iqH/UHRhIC3Z2dmlpaV0dHQAaIFY4/9r3vmu7PvIyMieWmizZnXm5uZQUFD0i6DKc4RA1vcAwe8AzP1HuNLbfI90QkzDb4A5OTmC4fnL8vxzhJDQ0NBjY2MsLCw5lKkeTVhBqcENIichExZGKC5UMDe5ubkcSVONjY0/Pz89nrUjW2gAaYOEKz0xHCD/sL8AfpwuzfUAWG42i58VNz8AocgmFRl/0uY9Rk0AlrwAO0kAS10AHCInwOUAT2IAepcAsdsAm8BeXl5OTk4yEBeUqbnc6/auyNpWY2x9Vl5ipT6lAAASKklEQVR4nO2de0MbNxLAY6e2MRAXDptHegfUKZgYBzD0yvsd6HGhoWnT6/Vocu3dff/PcN7VjDSSRto1qwXceP5I2JW81k8jzYweKz95Ysn8ws5uo+CVuTjjij/TfUtjd2dh3sYxpbawleJhj5Iwlq2Fmh9waTfVcx4vYaGwe+oDXEz5lB++juSHXEt6d1l0t9CXaZ9RL0aynmcxs8hLV0tNDfjYCQsvecBxlWNsZtQn04KwPu3Ndd/y3ZgCGOcATzF19m21lCBFIUnZ7leu1169mUUIxtzU0IrOVBFg0KRSWXv1HVDs2l1xAZJGB5WvGCFW1r4FjgWLEBz9zAADFq8jRNDilgk4L+43qg9dykzSI6y8gojTDOBGxO23g6xCUOIbgTJiEH4QtwdbhTFh5ZVA+WAQCtXeDLYKi52IsCL8YsMg/APYmSIQoq1hCacfHeGLWNwXL7TcgvDLQSL8WpTu6/jihbj4Kr7oiIu/dmj2IeGQ8AFkSDj4hF/94QlffBXLC3ohcIvaBcgAEvYpQ8Ih4eOXIeGQ8PHLkLBHWKwOtHRe9aTiI/xDyZBw8GVIOPjyiRK+HBlw+SaSHz2E508GXJ5F8rmHkF0cHiCpfdaTIeFAy5BwSPj4ZUh4D4S12lwtYXtkpsf3R1ibT5LU37yyvTSyuPPh49bW7tTu1tbHDzuLI0vbKyGgNOmTcD4p8PuY6kuXzl9OOR4w9fL8dC4Y3pO+CRM3yDp2AFK6cRccwRxfCtZu75dw7nQnkQ5lJ5Aq75NwaSdhM7whjZ2lQSKsLSQ3TlumRjK31tCW5jX/NSvjzk80yL+cjGc0r30Szo0s+IXdFL/i3A1/uVcXu5XG6nv7rkyLmRjvwePXnPqbqZdKTSBslkr1GaceM7TV/AkXXMW+rDeLxWIJCKO1g2bdqUd782tayZtwXnvdpjF9Jv++aMbLCpSwd7Un08++1PrmVvpo6V4JtQY6tle9kH/XYcFHJyyW1g9lFVy/GaMfv2NBciWcp+8T3RyUmvJtjDO5Nd4gLJaqUs3rzev3P5En7N5Jjf0SztnitAIjpHRn681SsY7tbl+t2JmEvTvYGRv1Umfte8po7vHNgXCl0DDFpeQaCdDGDuL3MbDo+2R5zyZU+c56N6/X3pO2utO/UQ0Q0/CEKySEeVuMLeVbuLypJhBWb/CDPWvUWau8UY+a6ts35kW4pNL3wajU4bpRLyYQyqziZarrtVf/UI/rN1bNiVA5wcYFlh0Vs15KJCyhSbqJL68ra++V6+jTNeZDqGzMmfQK2EaNlxtYQjN3p7J2qyxOf+sMASJvm/Bcpo2qvgVKOCvqwhMWi+AzoElH2w2+lU/tC7HfyHtn0RKr1Sg3f9CUIBhz1g0SFyF2RXxVoNJrqb5mE4owjUgNHtZLVoGtF3BchLKdYpX0EG9/voMWwxPKPnhDAJuXAG1tznERFksQvu1jO4hefZGdMb3vD04oregZ9XpoGw/6IDyAz6zjHQ3R+3Z2noTSD+7TIpcumZsJhDJ6u5RJ0eYm6RnT+sXAhNKbXGqFxV643hchKl4qMX7T7hf8ipTRTWBCHExoTbRYmja1kYZQal7trOvQhrr7EIQYbI/pb/RVLWWkIpS9V3mYGBEj8Z37J0Qro0ee0vCfNfskbILbJy7mmrwRmi5+C0koO6HR3Zpg921DmkCI5vSQVE0Pce37frpiSMLX8L0XRmmhsc1yKvQSFpuzdvOukOjGMTubFyG6+mmDpAkB2x4PgbOJLD5MTM2Q1A59/zyF4w9HiG10rG4KdJt1KyGSKhBW2VRQf4Pe++ft7a20NsntNBwhvBddmDUFABtWghDXx7wf/hk/Zr67nCPhaeFhJDF6C0VYS3cQUXhhDrvIh9A5d5+7JDnFUIQPBmiVOifCEXcBcpcEjxGGsAZfdjljCUTPY3YKiLCKs870MfbR3/UERxn+nhiGEHrhYbFpHvLThLWYPSsFM6j1Qz4dnP6FnmGtJxWIBv09MQwhGFImasERkDkBlS5qiwTGlsbhFfTEEuvYmfCEp9ASuaBMJM06ARIJS+D0m/ptcp6H3ycGIYRwhjvIhtdAX4QzbCugSvQGNiEIMSJlDrLB8Q8fdacjhNGlMWLpkGNnvNFpCEKYIOXOy8L5C2c3TCYUg6/Z/QPjNn3pzucwQhA23BQwSp91n1OUTFi9HD2ol5rm7fjsoFvx1ebJOoEJYS2DPYuoKgw6M4uYnjA65I67HSsRpqU8698BCM89XQ3Gd573UFMQOoTaGs8sfwDCLXcjRUNjzmsEIeyQZupxidkJwZKyDRHtIDeNmJlQuESYA3db0+yEELGxp7o5fNldCJnOWCHN1O30sxMuetQESw+HvpKnICyVqusXb0fN29SaLuZHCIN7HgKmmW6amQghth0zXY44iU2sKW45BxiZCaEbXrIQELNx6xX9E9ptPW6mvyR0xMyEpyIXby3rnj7aB+Goj/B9QkfMTHju6YboDj3OIhXhheM74o4IU/xOj5iZEJab2AJi0dgFiz4IXV41JqyIROdCVGZCEZQ6JuWT3WEqW7ruaOziyAthaqZyIxSZ+PGfswP1SQjd2R68eA59DEa44qhejdBT+HQe30v4L5HqMqZZCZccXUSUHkKaZkbCpquh0KjGtXMhK+Gpr6fhbopAhLZbpcbU5S6yEi74eloJxr+ZCcWc6hlPCHGba04xKyG4Q34MXxIbLnlDi6X3rZDqeewxNj0j2OUQsxJC3M0ub9brYoR/w69+guA7Mx6BPcOHVkK0WHqbEHtnJQSHb+3+hj3g3tRQeUSiy+VnJcSV34cX16RpVsL0v3+Rt7jeCxwSDlvp4yHMy9KALZ3mRXjqw1FHMskz68syeujK82UkogiLORHCrnX+x1fQU7tWP9OskMZ5bhx5ruOFUn85sxLCAr43pqEb7+w8aaI2iBy8MU1eURvEpd7Iu5GZUDh1e9L5PuLSU5GJn6fASbLMhOIx9tginsVImIrKSrgtMvEroLh66J3tTTMjLB5jr+/Q8eF2ToRzIhP/a0I4xvf9ykkawqrrSypkJ6ZrSjjQPA27wVnORAWap3HMRP3EFj4c4WtPV8MNsIFmE62uIAhFonO7cGbCcY+aUiwf9jMjbFUUNaXOYmYmXPCpqe6o/D4J9xy1GBP+KhKdG6MyE867rAAh9B22nIbQtaGDTiY6V/IzE4Ix5RfQcKMCm5iaEDZ0HFommRoa53E92VdIxQixwdtLUTbfNFMaQpHlzLwvuqGId9wn/2QnPPd0RAhqPNtp0hBWxfDDCmloN3RvxshOCFENu3KBLj/bToV1R1enqxauiCYE4RysPnF6SrG8lkzo8jliZ5vo6Q33qVkB9tN88OjJVf19EToaAp3S9+xODEB4KvKxLgHel/Es5KcgFJ3ZsmV0655nh2kAQvAX7BoalP8m0849PkeHLAD7tnqH2Jv4ge8npP4z7b50bOi4JtsUfFtoQxBCM+WcfnLsnbyD1hF3U3fv2wYdZBc0vpzGlC/R1CQT8oamQ+yMb3tpGEIYX9C3BKWIJHvpLz3hGdvNqTP0nrAQhBA3ejO9DSYC3Uv5yf2Q7QN066X/JcQw71vAvDAT1+Aw39kRk1ZIsRsaA3z6M7/+d7rDEELkxr0mClHN9J1XSGHodKHfjVZG8YVnd8QWjlC+5GxLfwd6usX9nIRjbwMRbju/P3/xqzDY+4cfHwww6VzfUISJB5vmJkkH8QV709l5RGnOsphUsGCEc+5C5CqJxymHex8fX5S9GTUENrc1ps0EIbBCyidOgwmdIbemv+0JnjiQfKhCwFMj8H31urGQCT69sM4ugnpXSPGwTC01WhXFaCbFGTUBCdHYmLN+OL7gN7v7T/6AwRcdV8Tnt+ChXynO+wx5tgkeY2aO5PAAHnYY7CVkPtmhJymlOdQs6Ak86BRHdW3hMJgdQnnPpxm1q4yebJLuEP+QhPIIngsNEY+0YqdNfYRVPJ5GJdLTadKdhRX2nKhT/G5jKAFDKG6vtO8kLBiX3Khb0QlDv+KXpDuyLfBZX+csIk6b2isPXkJY9SATQNoRSilPFgx9Ip3cI6WdFYVlZZToOa/trVkvGmDyyTT5EKpxFEXEgxEYc+oeAaMh3cOkDgVMc0TUXQmZ46CJzMuBnDZmhXv2QNh9ihIMfdX+496gVxqZxry/GFkIa/5fcWiwQ1X+biq50wOn1BRxcMLHIUPCIeHjlyFhGsKriUcnf4vk38EIn5cfmzz9UyR/CUj49JHJF38eEg4JP2XCuJ9rV+a1XhZvfit72tz5Ebbbm8vdwpH8zuVYNvBysnCyvNluqzK2N1qTJ4UJ/PyGyC8fd1XoLq+2Se7lyePCpp67JZN7Xqu10c6XsNwV+bBQG+JysqwnK8KC9vleDcSCNdIWl90y/7QT9sta5VwJl7Ui4mUB06/iqyOpozLcwMt3IvuyjoSX7SPt24AfdVpukcv8CFe1MgGAJDZ00sswoakBiApXZa2CsFmWj0WqyF3eLGiP056VYz8U+aBjYYmRGPhbipDWu1I51IjBb/QBvMIWorWH/AjLVAlY/kLhWCNYVeZP0znoSNXBMSVQzxOfb7/D3KsiuUDKkiPhc5FRu0ClmHZIFUs0tLbMDg8UFyfy6Vp9yAYCpkezQzkSUlOjSiyUUhaWQvqSSIjtUSqHSjAMjd6PsQnLT0O33MybcFMRSVMgc1CFPdU6U1tXeVxOJCbdVlTRVXzxTuXeIMSiC+cY0xBTo0wBIBj+jOo86krgDGQtoHdUjRrrgDwslkjL4B2Pcvb4Uk+xaSFliJSiG04oszKv+KeQp8rw2PWxQe1uQfTU9pX8MwuhOXvOECpTo5W4pxTT+Btdi3SsQmwvwS6fEELVB6SrRWTQ6UQKwh9ZwtfsXZtQdQe9xAWpk3c6oShppPMjmr1XUr3MRh9o08w95LLuax2Ev0eEn4mc5lIAbKpcSiSUTRFUUIDeuFE2gi6tax21ywCE5qZMjZbRB67K+DUQmj4vGyGth/DZbyKn2eNOWXCmlUpzgiXeNG5M6IRYMvxjs2vc2KC5nyM+Rt1gUduGr3UQxo10i1WWPEp+IYkQNHWCpqAF9X6kOyyza22CJyg8bWGNGEMHrT6gkR5jV9gExwoRrYMwVuE3QGICyp+I204ghIJdoSVsY71vMDohOocyn5Rl4aGHsvUB/09g9+savpYnfKbaKLNQKNfllxIIobnAV59Iu94SCUeaoZE674Lqeq7tRHtAV1M54E+C6lZlb6eDQxfh7wSQW/eXi9aLZEGOIYSidmWJoVRXx6AbnRCHRGD927JGnutl1urjSo4jsEKxWjhCVMezZ//5L0Kw+6fUztidkaV5IcxMlOYG4zZ5TG90TULNqRw/1aMVOXDQ+4B6Fg0NC6rTaoSiqNu/ffOjzMevGnO/ylmwCTVPFYWQaB6EtEzCFk2NIjrdmeuNWq+PyGjpjpGbieLEscfPuW9UIyyTkFjEoJpSdJ2YqRtmjVzpFaLXR3yHxOuqIAmEzg1iK44fkNEJ6VeuWswmoBa+ilEDbefmVOyGmaYxL6ci3PXsLqrxe2N1QhoTl82mdWSUWA6JYhHRQJk8YNnITxtlyxgJE1/rI1z0/8rHNreJWyckfV+YFTpqMA2NPsgSppDe2TS7LemkMF9zbN7xEr5O2OweNdVxq63qTYlUM070qTumTnSdl606apu5Ff2J9fl3SYS75yl/kn1uewmEW7cgPHaxVm1CpWFUMKkjMzvpdsasqlYOzVtgYbcTd0kzwhKemN9IimXqRONBT6KM1YlFqOpDrhXIOxM84R24pLBrT8raS98nId7ZgDgbRfBVjUxaKpePupLfJw3ZJk/Y/6/MJxG2zBIrpdiGhrRha2LZjg+IxhS8VKsK6vMllOVTTUxC2zohOieTatjQ7UYtK4uEDnCHBPX3REjsJloD0/jHZUbTqVQg7SNDiEnkFjQCEtTnTIjjHzISRKdlDA41fDrqgFsndmasD9LemVs5E5Zb3W60p6Vs32JMaU/nE1Fil/a58kSUvWt3w17u53ESrat2/PAuabd567BsLm6zt+6an0mxbuVN+PAyJBwSfoqEjv1zsdx5+10G+YLfuXdnwqtJVpYFYItPzVf43Zd3JnSIGK5py4gPITkSwraQCV+ee5A8Cf8ey//uC8UhORLC7y6N+/Lcg+RP+FDvrqN88oT/B28HJZ+GpTewAAAAAElFTkSuQmCC;" parent="1" vertex="1">
-          <mxGeometry x="-505" y="282.75" width="80.5" height="80.5" as="geometry" />
+          <mxGeometry x="-540" y="282.75" width="80.5" height="80.5" as="geometry" />
         </mxCell>
-        <mxCell id="jEus2W5ITfwieqKF0qT7-49" value="wilhelm-python-sdk" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontColor=#2088FF;fontFamily=Ubuntu;fontStyle=1;fontSize=18;" parent="1" vertex="1">
-          <mxGeometry x="50" y="430" width="190" height="30" as="geometry" />
+        <mxCell id="jEus2W5ITfwieqKF0qT7-49" value="&lt;font color=&quot;#faa627&quot;&gt;wilhelm-data-loader&lt;/font&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontColor=#2088FF;fontFamily=Ubuntu;fontStyle=1;fontSize=18;strokeColor=none;" parent="1" vertex="1">
+          <mxGeometry x="67" y="549" width="190" height="30" as="geometry" />
         </mxCell>
-        <mxCell id="CBPTevJeyTvfQtbZMOis-4" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;" edge="1" parent="1" source="jEus2W5ITfwieqKF0qT7-49" target="jEus2W5ITfwieqKF0qT7-49">
-          <mxGeometry relative="1" as="geometry" />
+        <mxCell id="CBPTevJeyTvfQtbZMOis-4" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;" parent="1" edge="1">
+          <mxGeometry relative="1" as="geometry">
+            <mxPoint x="162" y="578" as="sourcePoint" />
+            <mxPoint x="162" y="578" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="CBPTevJeyTvfQtbZMOis-9" value="Pull Request" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontColor=#000000;fontFamily=Ubuntu;fontStyle=1;fontSize=18;" parent="1" vertex="1">
+          <mxGeometry x="-320" y="517" width="190" height="30" as="geometry" />
+        </mxCell>
+        <mxCell id="lBE7YV5RTTJSdhW3G_g6-1" value="" style="shape=image;verticalLabelPosition=bottom;labelBackgroundColor=default;verticalAlign=top;aspect=fixed;imageAspect=0;image=https://upload.wikimedia.org/wikipedia/commons/9/91/Octicons-mark-github.svg;" vertex="1" parent="1">
+          <mxGeometry x="130" y="477" width="64" height="64" as="geometry" />
+        </mxCell>
+        <mxCell id="lBE7YV5RTTJSdhW3G_g6-2" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeWidth=3;" edge="1" parent="1">
+          <mxGeometry relative="1" as="geometry">
+            <mxPoint x="-70" y="510" as="sourcePoint" />
+            <mxPoint x="120" y="510" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="lBE7YV5RTTJSdhW3G_g6-6" value="&lt;font color=&quot;#60c203&quot;&gt;wilhelm-vocabulary&lt;/font&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontColor=#2088FF;fontFamily=Ubuntu;fontStyle=1;fontSize=18;strokeColor=none;" vertex="1" parent="1">
+          <mxGeometry x="-200" y="549" width="190" height="30" as="geometry" />
         </mxCell>
-        <mxCell id="CBPTevJeyTvfQtbZMOis-9" value="manual" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontColor=#000000;fontFamily=Ubuntu;fontStyle=1;fontSize=18;" vertex="1" parent="1">
-          <mxGeometry x="-290" y="517" width="190" height="30" as="geometry" />
+        <mxCell id="lBE7YV5RTTJSdhW3G_g6-7" value="repository_dispatch" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontColor=#000000;fontFamily=Ubuntu;fontStyle=1;fontSize=18;" vertex="1" parent="1">
+          <mxGeometry x="-70" y="470" width="190" height="30" as="geometry" />
         </mxCell>
       </root>
     </mxGraphModel>

huggingface/generate_ancient_greek_dataset.py

@@ -0,0 +1,51 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import json
+
+from vocabulary_parser import ANCIENT_GREEK
+from vocabulary_parser import get_attributes
+from vocabulary_parser import get_definitions
+from vocabulary_parser import get_vocabulary
+from wilhelm_python_sdk.database_clients import get_node_label_attribute_key
+
+
+def generate_dataset(yaml_path: str, dataset_path: str):
+    """
+    Generates a Hugging Face Dataset from https://github.com/QubitPi/wilhelm-vocabulary/blob/master/ancient-greek.yaml
+
+    :param yaml_path:  The absolute or relative path (to the invoking script) to the YAML file above
+    :param dataset_path:  The absolute or relative path (to the invoking script) to the generated dataset file
+    """
+    vocabulary = get_vocabulary(yaml_path)
+    label_key = get_node_label_attribute_key()
+
+    all_nodes = {}
+
+    with open(dataset_path, "w") as graph:
+        for word in vocabulary:
+            term = word["term"]
+            attributes = get_attributes(word, ANCIENT_GREEK, label_key)
+            source_node = attributes
+
+            all_nodes[term] = source_node
+
+            for definition_with_predicate in get_definitions(word):
+                predicate = definition_with_predicate[0]
+                definition = definition_with_predicate[1]
+
+                target_node = {label_key: definition}
+                label = {label_key: predicate if predicate else "definition"}
+
+                graph.write(json.dumps({"source": source_node, "target": target_node, label_key: label}))
+                graph.write("\n")

.github/cleanup_neo4j.py → huggingface/generate_datasets.py

@@ -11,8 +11,11 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
-from wilhelm_python_sdk.database_manager import cleanup_neo4j
+import generate_ancient_greek_dataset
+import generate_german_dataset
+import generate_latin_dataset
 
 if __name__ == "__main__":
-    cleanup_neo4j()
+    generate_german_dataset.generate_dataset("../german.yaml", "../german-graph-data.jsonl")
+    generate_latin_dataset.generate_dataset("../latin.yaml", "../latin-graph-data.jsonl")
+    generate_ancient_greek_dataset.generate_dataset("../ancient-greek.yaml", "../ancient-greek-graph-data.jsonl")

huggingface/generate_german_dataset.py

@@ -0,0 +1,60 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import json
+
+from german_parser import get_declension_attributes
+from vocabulary_parser import GERMAN
+from vocabulary_parser import get_attributes
+from vocabulary_parser import get_definitions
+from vocabulary_parser import get_inferred_links
+from vocabulary_parser import get_vocabulary
+from wilhelm_python_sdk.database_clients import get_node_label_attribute_key
+
+
+def generate_dataset(yaml_path: str, dataset_path: str):
+    """
+    Generates a Hugging Face Dataset from https://github.com/QubitPi/wilhelm-vocabulary/blob/master/german.yaml
+
+    :param yaml_path:  The absolute or relative path (to the invoking script) to the YAML file above
+    :param dataset_path:  The absolute or relative path (to the invoking script) to the generated dataset file
+    """
+    vocabulary = get_vocabulary(yaml_path)
+    label_key = get_node_label_attribute_key()
+
+    all_nodes = {}
+
+    with open(dataset_path, "w") as graph:
+        for word in vocabulary:
+            term = word["term"]
+            attributes = get_attributes(word, GERMAN, label_key, get_declension_attributes)
+            source_node = attributes
+            all_nodes[term] = source_node
+
+            for definition_with_predicate in get_definitions(word):
+                predicate = definition_with_predicate[0]
+                definition = definition_with_predicate[1]
+
+                target_node = {label_key: definition}
+                label = {label_key: predicate if predicate else "definition"}
+
+                graph.write(json.dumps({"source": source_node, "target": target_node, label_key: label}))
+                graph.write("\n")
+
+        for link in get_inferred_links(vocabulary, label_key, get_declension_attributes):
+            source_node = all_nodes[link["source_label"]]
+            target_node = all_nodes[link["target_label"]]
+            label = link["attributes"]
+
+            graph.write(json.dumps({"source": source_node, "target": target_node, label_key: label}))
+            graph.write("\n")

huggingface/generate_latin_dataset.py

@@ -0,0 +1,51 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import json
+
+from vocabulary_parser import LATIN
+from vocabulary_parser import get_attributes
+from vocabulary_parser import get_definitions
+from vocabulary_parser import get_vocabulary
+from wilhelm_python_sdk.database_clients import get_node_label_attribute_key
+
+
+def generate_dataset(yaml_path: str, dataset_path: str):
+    """
+    Generates a Hugging Face Dataset from https://github.com/QubitPi/wilhelm-vocabulary/blob/master/latin.yaml
+
+    :param yaml_path:  The absolute or relative path (to the invoking script) to the YAML file above
+    :param dataset_path:  The absolute or relative path (to the invoking script) to the generated dataset file
+    """
+    vocabulary = get_vocabulary(yaml_path)
+    label_key = get_node_label_attribute_key()
+
+    all_nodes = {}
+
+    with open(dataset_path, "w") as graph:
+        for word in vocabulary:
+            term = word["term"]
+            attributes = get_attributes(word, LATIN, label_key)
+            source_node = attributes
+
+            all_nodes[term] = source_node
+
+            for definition_with_predicate in get_definitions(word):
+                predicate = definition_with_predicate[0]
+                definition = definition_with_predicate[1]
+
+                target_node = {label_key: definition}
+                label = {label_key: predicate if predicate else "definition"}
+
+                graph.write(json.dumps({"source": source_node, "target": target_node, label_key: label}))
+                graph.write("\n")

huggingface/german_parser.py

@@ -0,0 +1,112 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+def get_declension_attributes(word: object) -> dict[str, str]:
+    """
+    Returns the declension of a word.
+
+    If the word does not have a "declension" field or the noun's declension is, for some reasons, "Unknown", this
+    function returns an empty dictionary.
+
+    The declension table is flattened with "declension index" as the map key and the declined form as map value.
+    Specifically:
+
+    - A regular noun declension with a map structure of::
+
+          term: der Hut
+          definition: the hat
+          declension:
+            - ["",         singular,      plural]
+            - [nominative, Hut,           Hüte  ]
+            - [genitive,   "Hutes, Huts", Hüte  ]
+            - [dative,     Hut,           Hüten ]
+            - [accusative, Hut,           Hüte  ]
+
+      The returned map would be::
+
+          {
+              "declension-0-0": "",
+              "declension-0-1": "singular",
+              "declension-0-2": "plural",
+              "declension-1-0": "nominative",
+              "declension-1-1": "Hut",
+              "declension-1-2": "Hüte",
+              ...
+          }
+
+    - A adjectival declension with a map structure of::
+
+          term: der Gefangener
+          definition: (adjectival, male) the prisoner
+          declension:
+            strong:
+              - ["",         singular,   plural    ]
+              - [nominative, Gefangener, Gefangene ]
+              - [genitive,   Gefangenen, Gefangener]
+              - [dative,     Gefangenem, Gefangenen]
+              - [accusative, Gefangenen, Gefangene ]
+            weak:
+              - ["",         singular,   plural    ]
+              - [nominative, Gefangene,  Gefangenen]
+              - [genitive,   Gefangenen, Gefangenen]
+              - [dative,     Gefangenen, Gefangenen]
+              - [accusative, Gefangenen, Gefangenen]
+            mixed:
+              - ["",         singular,   plural    ]
+              - [nominative, Gefangener, Gefangenen]
+              - [genitive,   Gefangenen, Gefangenen]
+              - [dative,     Gefangenen, Gefangenen]
+              - [accusative, Gefangenen, Gefangenen]
+
+      The returned map would be::
+
+        {
+            'strong-0-0': '',
+            'strong-0-1': 'singular',
+            'strong-0-2': 'plural',
+            'strong-1-0': 'nominative',
+            'strong-1-1': 'Gefangener',
+            'strong-1-2': 'Gefangene',
+            ...
+        }
+
+    :param word:  A vocabulary represented in YAML dictionary which has a "declension" key
+
+    :return: a flat map containing all the YAML encoded information about the noun excluding term and definition
+    """
+
+    if "declension" not in word:
+        return {}
+
+    declension = word["declension"]
+
+    if declension == "Unknown":
+        return {}
+
+    declension_tables = {}
+    if "strong" in declension and "weak" in declension and "mixed" in declension:
+        declension_tables["strong"] = declension["strong"]
+        declension_tables["weak"] = declension["weak"]
+        declension_tables["mixed"] = declension["mixed"]
+    else:
+        declension_tables["declension"] = declension
+
+    declension_attributes = {}
+    for declension_type, declension_table in declension_tables.items():
+        for i, row in enumerate(declension_table):
+            for j, col in enumerate(row):
+                declension_attributes[f"{declension_type}-{i}-{j}"] = declension_table[i][j]
+
+    return declension_attributes

huggingface/vocabulary_parser.py

@@ -0,0 +1,363 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import logging
+import re
+from typing import Callable
+
+import yaml
+
+logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
+
+"""
+The language identifier for German language.
+
+.. py:data:: GERMAN
+   :value: German
+   :type: string
+"""
+GERMAN = "German"
+
+"""
+The language identifier for Latin language.
+
+.. py:data:: LATIN
+   :value: Latin
+   :type: string
+"""
+LATIN = "Latin"
+
+"""
+The language identifier for Ancient Greek.
+
+.. py:data:: ANCIENT_GREEK
+   :value: Ancient Greek
+   :type: string
+"""
+ANCIENT_GREEK = "Ancient Greek"
+
+EXCLUDED_INFLECTION_ENTRIES = [
+    "",
+    "singular",
+    "plural",
+    "masculine",
+    "feminine",
+    "neuter",
+    "nominative",
+    "genitive",
+    "dative",
+    "accusative",
+    "N/A"
+]
+
+ENGLISH_PROPOSITIONS = {
+    "about", "above", "across", "after", "against", "along", "among", "around", "at", "before", "behind", "below",
+    "beneath", "beside", "between", "beyond", "by", "down", "during", "except", "for", "from", "in", "inside", "into",
+    "like", "near", "of", "off", "on", "onto", "out", "outside", "over", "past", "since", "through", "throughout", "to",
+    "toward", "under", "underneath", "until", "up", "upon", "with", "within", "without"
+}
+EXCLUDED_DEFINITION_TOKENS = {"the"} | ENGLISH_PROPOSITIONS
+
+
+def get_vocabulary(yaml_path: str) -> list:
+    with open(yaml_path, "r") as f:
+        return yaml.safe_load(f)["vocabulary"]
+
+
+def get_definitions(word) -> list[(str, str)]:
+    """
+    Extract definitions from a word as a list of bi-tuples, with the first element being the predicate and the second
+    being the definition.
+
+    For example (in YAML)::
+
+    definition:
+      - term: nämlich
+        definition:
+          - (adj.) same
+          - (adv.) namely
+          - because
+
+    The method will return `[("adj.", "same"), ("adv.", "namely"), (None, "because")]`
+
+    The method works for the single-definition case, i.e.::
+
+    definition:
+      - term: na klar
+        definition: of course
+
+    returns a list of one tupple `[(None, "of course")]`
+
+    Note that any definition are converted to string. If the word does not contain a field named exactly "definition", a
+    ValueError is raised.
+
+    :param word:  A dictionary that contains a "definition" key whose value is either a single-value or a list of
+                  single-values
+    :return: a list of two-element tuples, where the first element being the predicate (can be `None`) and the second
+             being the definition
+    """
+    logging.info("Extracting definitions from {}".format(word))
+
+    if "definition" not in word:
+        raise ValueError("{} does not contain 'definition' field. Maybe there is a typo".format(word))
+
+    predicate_with_definition = []
+
+    definitions = [word["definition"]] if not isinstance(word["definition"], list) else word["definition"]
+
+    for definition in definitions:
+        definition = str(definition)
+
+        definition = definition.strip()
+
+        match = re.match(r"\((.*?)\)", definition)
+        if match:
+            predicate_with_definition.append((match.group(1), re.sub(r'\(.*?\)', '', definition).strip()))
+        else:
+            predicate_with_definition.append((None, definition))
+
+    return predicate_with_definition
+
+
+def get_attributes(
+        word: object,
+        language: str,
+        node_label_attribute_key: str,
+        inflection_supplier: Callable[[object], dict]=lambda word: {}
+) -> dict[str, str]:
+    """
+    Returns a flat map as the Term node properties stored in Neo4J.
+
+    :param word:  A dict object representing a vocabulary
+    :param language:  The language of the vocabulary. Can only be one of the constants defined in this file:
+    :py:data:`GERMAN` / :py:data:`LATIN` / :py:data:`ANCIENT_GREEK`
+    :param node_label_attribute_key:  The attribute key in the returned map whose value contains the node caption
+    :param inflection_supplier:  A functional object that, given a YAML dictionary, returns the inflection table of that
+    word. The key of the table can be arbitrary but the value must be a sole inflected word
+
+    :return: a flat map containing all the YAML encoded information about the vocabulary
+    """
+    return {node_label_attribute_key: word["term"], "language": language} | inflection_supplier(word) | get_audio(word)
+
+
+def get_audio(word: object) -> dict:
+    """
+    Returns the pronunciation of a word in the form of a map with key being "audio" and value being a string pointing to
+    the URL of the audio file.
+
+    The word should be a dict object containing an "audio" string attribute, otherwise this function returns an empty
+    map
+
+    :param word:  A dict object representing a vocabulary
+
+    :return: a single-entry map or empty map
+    """
+    if "audio" not in word:
+        return {}
+    return {"audio": word["audio"]}
+
+
+def get_inferred_links(
+        vocabulary: list[dict],
+        label_key: str,
+        inflection_supplier: Callable[[object], dict[str, str]]=lambda word: {}
+) -> list[dict]:
+    """
+    Return a list of inferred links between related vocabularies.
+
+    This function is the point of extending link inference capabilities. At this point, the link inference includes
+
+    - :py:meth:`token sharing <wilhelm_python_sdk.vocabulary_parser.get_inferred_tokenization_links>`
+    - :py:meth:`token sharing <wilhelm_python_sdk.vocabulary_parser.get_levenshtein_links>`
+
+    :param vocabulary:  A wilhelm-vocabulary repo YAML file deserialized
+    :param label_key:  The name of the node attribute that will be used as the label in displaying the node
+    :param inflection_supplier:  A functional object that, given a YAML dictionary, returns the inflection table of that
+    word. The key of the table can be arbitrary but the value must be a sole inflected word
+
+    :return: a list of link object, each of which has a "source_label", a "target_label", and an "attributes" key
+    """
+    return (get_inferred_tokenization_links(vocabulary, label_key, inflection_supplier) +
+            get_structurally_similar_links(vocabulary, label_key))
+
+
+def get_definition_tokens(word: dict) -> set[str]:
+    definitions = [pair[1] for pair in get_definitions(word)]
+    tokens = set()
+
+    for token in set(sum([definition.split(" ") for definition in set().union(set(definitions))], [])):
+        cleansed = token.lower().strip()
+        if cleansed not in EXCLUDED_DEFINITION_TOKENS:
+            tokens.add(cleansed)
+
+    return tokens
+
+
+def get_term_tokens(word: dict) -> set[str]:
+    term = word["term"]
+    tokens = set()
+
+    for token in term.split(" "):
+        cleansed = token.lower().strip()
+        if cleansed not in {"der", "die", "das"}:
+            tokens.add(cleansed)
+
+    return tokens
+
+
+def get_inflection_tokens(
+        word: dict,
+        inflection_supplier: Callable[[object], dict[str, str]]=lambda word: {}
+) -> set[str]:
+    tokens = set()
+
+    for key, value in inflection_supplier(word).items():
+        if value not in EXCLUDED_INFLECTION_ENTRIES:
+            for inflection in value.split(","):
+                cleansed = inflection.lower().strip()
+                tokens.add(cleansed)
+
+    return tokens
+
+
+def get_tokens_of(word: dict, inflection_supplier: Callable[[object], dict[str, str]]=lambda word: {}) -> set[str]:
+    return get_inflection_tokens(word, inflection_supplier) | get_term_tokens(word) | get_definition_tokens(word)
+
+
+def get_inferred_tokenization_links(
+        vocabulary: list[dict],
+        label_key: str,
+        inflection_supplier: Callable[[object], dict[str, str]]=lambda word: {}
+) -> list[dict]:
+    """
+    Return a list of inferred links between related vocabulary terms which are related to one another.
+
+    This mapping will be used to create more links in graph database.
+
+    This was inspired by the spotting the relationships among::
+
+        vocabulary:
+          - term: das Jahr
+            definition: the year
+            declension:
+              - ["",         singular,        plural        ]
+              - [nominative, Jahr,            "Jahre, Jahr" ]
+              - [genitive,   "Jahres, Jahrs", "Jahre, Jahr" ]
+              - [dative,     Jahr,            "Jahren, Jahr"]
+              - [accusative, Jahr,            "Jahre, Jahr" ]
+          - term: seit zwei Jahren
+            definition: for two years
+          - term: in den letzten Jahren
+            definition: in recent years
+
+    1. Both 2nd and 3rd are related to the 1st and the two links can be inferred by observing that "Jahren" in 2nd and
+       3rd match the declension table of the 1st
+    2. In addition, the 2nd and 3rd are related because they both have "Jahren".
+
+    Given the 2 observations above, this function tokenizes the "term" and the declension table of each word. If two
+    words share at least 1 token, they are defined to be "related"
+
+    :param vocabulary:  A wilhelm-vocabulary repo YAML file deserialized
+    :param label_key:  The name of the node attribute that will be used as the label in displaying the node
+
+    :return: a list of link object, each of which has a "source_label", a "target_label", and an "attributes" key
+    """
+    all_vocabulary_tokenizations_by_term = dict(
+        [word["term"], get_tokens_of(word, inflection_supplier)] for word in vocabulary)
+    inferred_links = []
+    for this_word in vocabulary:
+        this_term = this_word["term"]
+
+        for that_term, that_term_tokens in all_vocabulary_tokenizations_by_term.items():
+            jump_to_next_term = False
+
+            if this_term == that_term:
+                continue
+
+            for this_token in get_term_tokens(this_word):
+                for that_token in that_term_tokens:
+                    if this_token.lower().strip() == that_token:
+                        inferred_links.append({
+                            "source_label": this_term,
+                            "target_label": that_term,
+                            "attributes": {label_key: "term related"},
+                        })
+                        jump_to_next_term = True
+                        break
+
+                if jump_to_next_term:
+                    break
+
+    return inferred_links
+
+
+def get_structurally_similar_links(vocabulary: list[dict], label_key: str) -> list[dict]:
+    """
+    Return a list of inferred links between structurally-related vocabulary terms that are determined by the function
+    :py:meth:`token sharing <wilhelm_python_sdk.vocabulary_parser.is_structurally_similar>`.
+
+    This was inspired by the spotting the relationships among::
+
+        vocabulary:
+          - term: anschließen
+            definition: to connect
+          - term: anschließend
+            definition:
+              - (adj.) following
+              - (adv.) afterwards
+          - term: nachher
+            definition: (adv.) afterwards
+
+    :param vocabulary:  A wilhelm-vocabulary repo YAML file deserialized
+    :param label_key:  The name of the node attribute that will be used as the label in displaying the node
+
+    :return: a list of link object, each of which has a "source_label", a "target_label", and an "attributes" key
+    """
+    inferred_links = []
+
+    for this in vocabulary:
+        for that in vocabulary:
+            this_term = this["term"]
+            that_term = that["term"]
+            if is_structurally_similar(this_term, that_term):
+                inferred_links.append({
+                    "source_label": this_term,
+                    "target_label": that_term,
+                    "attributes": {label_key: "structurally similar"},
+                })
+
+    return inferred_links
+
+
+def is_structurally_similar(this_word: str, that_word: str) -> bool:
+    """
+    Returns whether or not two string words are structurally similar.
+
+    Two words are structurally similar iff the two share the same word stem. If two word strings are equal, this
+    function returns `False`.
+
+    :param this_word:  The first word to compare structurally
+    :param that_word:  The second word to compare structurally
+
+    :return: `True` if two words are structurally similar, or `False` otherwise
+    """
+    if this_word is that_word:
+        return False
+
+    return get_stem(this_word) == get_stem(that_word)
+
+
+def get_stem(word: str) -> str:
+    from nltk.stem.snowball import GermanStemmer
+    stemmer = GermanStemmer()
+    return stemmer.stem(word)

markdownlint.rb

@@ -1,20 +0,0 @@
-# Copyright Jiaqi Liu
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-all
-rule 'MD003', style: :setext_with_atx
-rule 'MD004', style: :sublist
-rule 'MD013', line_length: 120
-rule 'MD029', style: :ordered
-rule 'MD026', punctuation: ".,;:!?"

setup.cfg

@@ -0,0 +1,3 @@
+[pep8]
+max-line-length = 120
+exclude = ./.eggs

setup.py

@@ -0,0 +1,19 @@
+from setuptools import find_packages
+from setuptools import setup
+
+setup(
+    name="wilhelm-vocabulary",
+    version="0.0.1",
+    description="A vocabulary processor specifically designed for QubitPi",
+    url="https://github.com/QubitPi/wilhelm-vocabulary",
+    author="Jiaqi Liu",
+    author_email="[email protected]",
+    license="Apache-2.0",
+    packages=find_packages(),
+    python_requires='>=3.10',
+    install_requires=["pyyaml", "nltk", "wilhelm_python_sdk"],
+    zip_safe=False,
+    include_package_data=True,
+    setup_requires=["setuptools-pep8", "isort"],
+    test_suite='tests',
+)

tests/test.yaml

@@ -0,0 +1,9 @@
+vocabulary:
+  - term: "null"
+    definition: 0
+  - term: eins
+    definition: 1
+  - term: Guten Tag
+    definition: Good day
+  - term: Hallo
+    definition: Hello

tests/test_german_loader.py

@@ -0,0 +1,133 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import unittest
+
+import yaml
+
+from huggingface.german_parser import get_declension_attributes
+
+
+class TestGermanParser(unittest.TestCase):
+
+    def test_get_declension_attributes_on_regular_noun(self):
+        hut_yaml = """
+            term: der Hut
+            definition: the hat
+            declension:
+              - ["",         singular,      plural]
+              - [nominative, Hut,           Hüte  ]
+              - [genitive,   "Hutes, Huts", Hüte  ]
+              - [dative,     Hut,           Hüten ]
+              - [accusative, Hut,           Hüte  ]
+        """
+
+        expected_declension_map = {
+            "declension-0-0": "",
+            "declension-0-1": "singular",
+            "declension-0-2": "plural",
+
+            "declension-1-0": "nominative",
+            "declension-1-1": "Hut",
+            "declension-1-2": "Hüte",
+
+            "declension-2-0": "genitive",
+            "declension-2-1": "Hutes, Huts",
+            "declension-2-2": "Hüte",
+
+            "declension-3-0": "dative",
+            "declension-3-1": "Hut",
+            "declension-3-2": "Hüten",
+
+            "declension-4-0": "accusative",
+            "declension-4-1": "Hut",
+            "declension-4-2": "Hüte",
+        }
+
+        self.assertEqual(expected_declension_map, get_declension_attributes(yaml.safe_load(hut_yaml)))
+
+    def test_get_declension_attributes_on_adjectival(self):
+        word_yaml = """
+            term: der Gefangener
+            definition: (adjectival, male) the prisoner
+            declension:
+              strong:
+                - ["",         singular,   plural    ]
+                - [nominative, Gefangener, Gefangene ]
+                - [genitive,   Gefangenen, Gefangener]
+                - [dative,     Gefangenem, Gefangenen]
+                - [accusative, Gefangenen, Gefangene ]
+              weak:
+                - ["",         singular,   plural    ]
+                - [nominative, Gefangene,  Gefangenen]
+                - [genitive,   Gefangenen, Gefangenen]
+                - [dative,     Gefangenen, Gefangenen]
+                - [accusative, Gefangenen, Gefangenen]
+              mixed:
+                - ["",         singular,   plural    ]
+                - [nominative, Gefangener, Gefangenen]
+                - [genitive,   Gefangenen, Gefangenen]
+                - [dative,     Gefangenen, Gefangenen]
+                - [accusative, Gefangenen, Gefangenen]
+        """
+
+        self.assertEqual(
+            {
+                'mixed-0-0': '',
+                'mixed-0-1': 'singular',
+                'mixed-0-2': 'plural',
+                'mixed-1-0': 'nominative',
+                'mixed-1-1': 'Gefangener',
+                'mixed-1-2': 'Gefangenen',
+                'mixed-2-0': 'genitive',
+                'mixed-2-1': 'Gefangenen',
+                'mixed-2-2': 'Gefangenen',
+                'mixed-3-0': 'dative',
+                'mixed-3-1': 'Gefangenen',
+                'mixed-3-2': 'Gefangenen',
+                'mixed-4-0': 'accusative',
+                'mixed-4-1': 'Gefangenen',
+                'mixed-4-2': 'Gefangenen',
+                'strong-0-0': '',
+                'strong-0-1': 'singular',
+                'strong-0-2': 'plural',
+                'strong-1-0': 'nominative',
+                'strong-1-1': 'Gefangener',
+                'strong-1-2': 'Gefangene',
+                'strong-2-0': 'genitive',
+                'strong-2-1': 'Gefangenen',
+                'strong-2-2': 'Gefangener',
+                'strong-3-0': 'dative',
+                'strong-3-1': 'Gefangenem',
+                'strong-3-2': 'Gefangenen',
+                'strong-4-0': 'accusative',
+                'strong-4-1': 'Gefangenen',
+                'strong-4-2': 'Gefangene',
+                'weak-0-0': '',
+                'weak-0-1': 'singular',
+                'weak-0-2': 'plural',
+                'weak-1-0': 'nominative',
+                'weak-1-1': 'Gefangene',
+                'weak-1-2': 'Gefangenen',
+                'weak-2-0': 'genitive',
+                'weak-2-1': 'Gefangenen',
+                'weak-2-2': 'Gefangenen',
+                'weak-3-0': 'dative',
+                'weak-3-1': 'Gefangenen',
+                'weak-3-2': 'Gefangenen',
+                'weak-4-0': 'accusative',
+                'weak-4-1': 'Gefangenen',
+                'weak-4-2': 'Gefangenen'
+            },
+            get_declension_attributes(yaml.safe_load(word_yaml))
+        )

tests/test_vocabulary_parser.py

@@ -0,0 +1,337 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import unittest
+
+import yaml
+
+from huggingface.german_parser import get_declension_attributes
+from huggingface.vocabulary_parser import GERMAN
+from huggingface.vocabulary_parser import get_attributes
+from huggingface.vocabulary_parser import get_definition_tokens
+from huggingface.vocabulary_parser import get_definitions
+from huggingface.vocabulary_parser import get_inferred_links
+from huggingface.vocabulary_parser import get_inferred_tokenization_links
+from huggingface.vocabulary_parser import get_inflection_tokens
+from huggingface.vocabulary_parser import get_structurally_similar_links
+from huggingface.vocabulary_parser import get_term_tokens
+from huggingface.vocabulary_parser import is_structurally_similar
+
+UNKOWN_DECLENSION_NOUN_YAML = """
+    term: die Grilltomate
+    definition: the grilled tomato
+    declension: Unknown
+"""
+
+LABEL_KEY = "label"
+
+
+class TestVocabularyParser(unittest.TestCase):
+
+    def test_get_definitions(self):
+        self.assertEqual(
+            [("adj.", "same"), ("adv.", "namely"), (None, "because")],
+            get_definitions({
+                "definition": ["(adj.) same", "(adv.) namely", "because"]
+            }),
+        )
+
+    def test_single_definition_term(self):
+        self.assertEqual(
+            [(None, "one")],
+            get_definitions({
+                "definition": "one"
+            }),
+        )
+
+    def test_numerical_definition(self):
+        self.assertEqual(
+            [(None, "1")],
+            get_definitions({
+                "definition": 1
+            }),
+        )
+
+    def test_missing_definition(self):
+        with self.assertRaises(ValueError):
+            get_definitions({"defintion": "I'm 23 years old."})
+
+    def test_get_attributes_basic(self):
+        self.assertEqual(
+            {"label": "der Hut", "language": "German"},
+            get_attributes({"term": "der Hut", "definition": "the hat"}, GERMAN, LABEL_KEY),
+        )
+
+    def test_get_attributes_with_custom_inflection(self):
+        self.assertEqual(
+            {"label": "der Hut", "language": "German", "inflection": {"declension": "..."}},
+            get_attributes(
+                {
+                    "term": "der Hut",
+                    "definition": "the hat",
+                    "inflection": {"declension": "...", "inflection": None}
+                },
+                GERMAN,
+                LABEL_KEY,
+                lambda word: {"inflection": {"declension": "..."}}
+            ),
+        )
+
+    def test_get_attributes_with_audio(self):
+        self.assertEqual(
+            {
+                "label": "der Hut",
+                "language": "German",
+                "audio": "https://upload.wikimedia.org/wikipedia/commons/e/e9/De-Hut.ogg"
+            },
+            get_attributes(
+                {
+                    "term": "der Hut",
+                    "definition": "the hat",
+                    "audio": "https://upload.wikimedia.org/wikipedia/commons/e/e9/De-Hut.ogg"
+                },
+                GERMAN,
+                LABEL_KEY
+            ),
+        )
+
+    def test_get_inferred_links_on_unrelated_terms(self):
+        vocabulary = yaml.safe_load("""
+            vocabulary:
+              - term: der Beruf
+                definition: job
+                declension:
+                  - ["",         singular,          plural ]
+                  - [nominative, Beruf,             Berufe ]
+                  - [genitive,   "Berufes, Berufs", Berufe ]
+                  - [dative,     Beruf,             Berufen]
+                  - [accusative, Beruf,             Berufe ]
+              - term: der Qualitätswein
+                definition: The vintage wine
+                declension:
+                  - ["",         singular,                          plural         ]
+                  - [nominative, Qualitätswein,                     Qualitätsweine ]
+                  - [genitive,   "Qualitätsweines, Qualitätsweins", Qualitätsweine ]
+                  - [dative,     Qualitätswein,                     Qualitätsweinen]
+                  - [accusative, Qualitätswein,                     Qualitätsweine ]
+        """)["vocabulary"]
+        label_key = LABEL_KEY
+
+        self.assertEqual(
+            [],
+            get_inferred_links(vocabulary, label_key, get_declension_attributes)
+        )
+
+    def test_get_inferred_links_on_unrelated_terms_with_same_definite_article(self):
+        vocabulary = yaml.safe_load("""
+            vocabulary:
+              - term: die Biographie
+                definition: (alternative spelling of) die Biografie
+                declension:
+                  - ["",         singular,   plural     ]
+                  - [nominative, Biographie, Biographien]
+                  - [genitive,   Biographie, Biographien]
+                  - [dative,     Biographie, Biographien]
+                  - [accusative, Biographie, Biographien]
+              - term: die Mittagspause
+                definition: the lunchbreak
+                declension:
+                  - ["",         singular,     plural       ]
+                  - [nominative, Mittagspause, Mittagspausen]
+                  - [genitive,   Mittagspause, Mittagspausen]
+                  - [dative,     Mittagspause, Mittagspausen]
+                  - [accusative, Mittagspause, Mittagspausen]
+        """)["vocabulary"]  # "die Biographie" has "die" in its definition
+        label_key = LABEL_KEY
+
+        self.assertEqual(
+            [],
+            get_inferred_links(vocabulary, label_key, get_declension_attributes)
+        )
+
+    def test_get_definition_tokens(self):
+        vocabulary = yaml.safe_load("""
+                    vocabulary:
+                      - term: morgens
+                        definition:
+                          - (adv.) in the morning
+                          - (adv.) a.m.
+                """)["vocabulary"]
+        self.assertEqual(
+            {"morning", "a.m."},
+            get_definition_tokens(vocabulary[0])
+        )
+
+    def test_get_term_tokens(self):
+        vocabulary = yaml.safe_load("""
+                    vocabulary:
+                      - term: Viertel vor sieben
+                        definition: (clock time) a quarter before eight
+                """)["vocabulary"]
+        self.assertEqual(
+            {"sieben", "vor", "viertel"},
+            get_term_tokens(vocabulary[0])
+        )
+
+    def test_get_term_tokens_do_not_include_indefinite_articles(self):
+        vocabulary = yaml.safe_load("""
+                    vocabulary:
+                      - term: der Brief
+                      - term: die Biographie
+                      - term: das Jahr
+                """)["vocabulary"]
+        self.assertEqual({"brief"}, get_term_tokens(vocabulary[0]))
+        self.assertEqual({"biographie"}, get_term_tokens(vocabulary[1]))
+        self.assertEqual({"jahr"}, get_term_tokens(vocabulary[2]))
+
+    def test_get_declension_tokens(self):
+        vocabulary = yaml.safe_load("""
+                    vocabulary:
+                      - term: das Jahr
+                        definition: the year
+                        declension:
+                          - ["",         singular,        plural        ]
+                          - [nominative, Jahr,            "Jahre, Jahr" ]
+                          - [genitive,   "Jahres, Jahrs", "Jahre, Jahr" ]
+                          - [dative,     Jahr,            "Jahren, Jahr"]
+                          - [accusative, Jahr,            "Jahre, Jahr" ]
+                """)["vocabulary"]
+        self.assertEqual(
+            {"jahres", "jahre", "jahr", "jahren", "jahrs"},
+            get_inflection_tokens(vocabulary[0], get_declension_attributes)
+        )
+
+    def test_two_words_shring_some_same_declension_table_entries(self):
+        vocabulary = yaml.safe_load("""
+            vocabulary:
+              - term: die Reise
+                definition: the travel
+                declension:
+                  - ["",         singular, plural]
+                  - [nominative, Reise,    Reisen]
+                  - [genitive,   Reise,    Reisen]
+                  - [dative,     Reise,    Reisen]
+                  - [accusative, Reise,    Reisen]
+              - term: der Reis
+                definition: the rice
+                declension:
+                  - ["",         singular, plural]
+                  - [nominative, Reis,     Reise ]
+                  - [genitive,   Reises,   Reise ]
+                  - [dative,     Reis,     Reisen]
+                  - [accusative, Reis,     Reise ]
+        """)["vocabulary"]
+
+        self.assertEqual(
+            [
+                {
+                    'attributes': {LABEL_KEY: 'term related'},
+                    'source_label': 'die Reise',
+                    'target_label': 'der Reis'
+                }
+            ],
+            get_inferred_tokenization_links(vocabulary, LABEL_KEY, get_declension_attributes)
+        )
+
+    def test_get_inferred_tokenization_links(self):
+        vocabulary = yaml.safe_load("""
+            vocabulary:
+              - term: das Jahr
+                definition: the year
+                declension:
+                  - ["",         singular,        plural        ]
+                  - [nominative, Jahr,            "Jahre, Jahr" ]
+                  - [genitive,   "Jahres, Jahrs", "Jahre, Jahr" ]
+                  - [dative,     Jahr,            "Jahren, Jahr"]
+                  - [accusative, Jahr,            "Jahre, Jahr" ]
+              - term: seit zwei Jahren
+                definition: for two years
+              - term: letzte
+                definition: (adj.) last
+              - term: in den letzten Jahren
+                definition: in recent years
+        """)["vocabulary"]
+
+        self.assertEqual(
+            [
+                {
+                    'attributes': {LABEL_KEY: 'term related'},
+                    'source_label': 'seit zwei Jahren',
+                    'target_label': 'das Jahr'
+                },
+                {
+                    'attributes': {LABEL_KEY: 'term related'},
+                    'source_label': 'seit zwei Jahren',
+                    'target_label': 'in den letzten Jahren'
+                },
+                {
+                    'attributes': {LABEL_KEY: 'term related'},
+                    'source_label': 'in den letzten Jahren',
+                    'target_label': 'das Jahr'
+                },
+                {
+                    'attributes': {LABEL_KEY: 'term related'},
+                    'source_label': 'in den letzten Jahren',
+                    'target_label': 'seit zwei Jahren'
+                }
+            ],
+            get_inferred_tokenization_links(vocabulary, LABEL_KEY, get_declension_attributes)
+        )
+
+    def test_get_structurally_similar_links(self):
+        vocabulary = yaml.safe_load("""
+            vocabulary:
+              - term: anschließen
+                definition: to connect
+              - term: anschließend
+                definition:
+                  - (adj.) following
+                  - (adv.) afterwards
+              - term: nachher
+                definition: (adv.) afterwards
+        """)["vocabulary"]
+        label_key = LABEL_KEY
+
+        self.assertEqual(
+            [
+                {
+                    'attributes': {LABEL_KEY: 'structurally similar'},
+                    'source_label': 'anschließen',
+                    'target_label': 'anschließend'
+                },
+                {
+                    'attributes': {LABEL_KEY: 'structurally similar'},
+                    'source_label': 'anschließend',
+                    'target_label': 'anschließen'
+                }
+            ],
+            get_structurally_similar_links(vocabulary, label_key)
+        )
+
+    def test_get_structurally_similar_links_small_edit_distance_but_different_stem(self):
+        vocabulary = yaml.safe_load("""
+            vocabulary:
+              - term: die Bank
+              - term: die Sahne
+        """)["vocabulary"]
+        label_key = LABEL_KEY
+
+        self.assertEqual(
+            [],
+            get_structurally_similar_links(vocabulary, label_key)
+        )
+
+    def test_is_structurally_similar(self):
+        self.assertTrue(is_structurally_similar("anschließen", "anschließend"))
+        self.assertTrue(is_structurally_similar("anschließend", "anschließen"))
+        self.assertFalse(is_structurally_similar("die Bank", "die Sahne"))