update hf demo

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025, University of Zurich (UZH)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -5,8 +5,36 @@ colorFrom: purple
 colorTo: yellow
 sdk: gradio
 sdk_version: 5.43.1
+tags:
+  - beta
 app_file: app.py
 pinned: false
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Basic Lemmatizer for Romansh Varieties <span style="color:gray">(Beta)</span>: Demo
+
+This demo visualises the functionalities of the package "romansh_lemmatizer", available at:
+
+https://github.com/ZurichNLP/romansh_lemmatizer
+
+The underlying Python package presents a basic dictionary-based lemmatizer for the Romansh language.
+Provided a Romansh text, the lemmatizer splits it into words and looks up each word in the [Pledari Grond](https://pledarigrond.ch/) dictionaries for the five standard Romansh idioms: Sursilvan, Sutsilvan, Surmiran, Puter, and Vallader, as well as the dictionary for Rumantsch Grischun.
+
+For example, if a Romansh text contains the word _lavuraiva_, the lemmatizer traces the word back to the Vallader and Puter dictionaries:
+
+<img src="illustration.png" alt="illustration" width="400"/>
+
+Typical use cases for the lemmatizer include:
+- Accessing potential German translations (glosses) of Romansh words
+- Automatically detecting the variety of a Romansh text, based on how many words are found in the respective dictionaries
+
+A limitation of the current version is that the lemmatizer does not disambiguate between multiple possible ways of lemmatizing a word. Specifically:
+1. If a word has multiple dictionary entries, all the dictionary entries are returned, irrespective of the context in which the word occurs.
+2. If there are multiple ways of morphologically analysing a given word form, all possible analyses are returned.
+
+## Acknowledgements and Data Rights
+This demo incorporates dictionary data from the [Pledari Grond](https://pledarigrond.ch/) project.
+
+- The dictionaries for Rumantsch Grischun, Surmiran, Sursilvan and Sutsilvan are openly licensed. © **Lia Rumantscha** 1980 – 2025
+- The dictionaries for Vallader and Puter are kindly provided by [**Uniun dals Grischs**](https://www.udg.ch/dicziunari) and may only be used in the context of this lemmatizer. © Uniun dals Grischs. All rights reserved.
+