Upload README.md with huggingface_hub

README.md

@@ -16,10 +16,10 @@ pipeline_tag: token-classification
 
 ## Model Description
 
-This is a Telugu-language model based on [COMBO-NLP](https://gitlab.clarin-pl.eu/syntactic-tools/combo-nlp), an open-source natural language preprocessing system. It performs:
+This is a Telugu-language model based on [combo-nlp](https://pypi.org/project/combo-nlp/), an open-source natural language preprocessing system. It performs:
 
-- sentence segmentation (via [LAMBO](https://gitlab.clarin-pl.eu/syntactic-tools/lambo))
-- tokenisation (via [LAMBO](https://gitlab.clarin-pl.eu/syntactic-tools/lambo))
+- sentence segmentation (via [combo-seg](https://pypi.org/project/combo-seg/))
+- tokenisation (via [combo-seg](https://pypi.org/project/combo-seg/))
 - part-of-speech tagging
 - morphological analysis
 - lemmatisation
@@ -32,22 +32,22 @@ The Telugu model uses ``FacebookAI/xlm-roberta-base`` as its base encoder and is
 Evaluation was performed on the UD_Telugu-MTG test split using the standard [CoNLL 2018 eval script](https://universaldependencies.org/conll18/conll18_ud_eval.py).
 
 Two evaluation rows are reported:
-- **Full-text (F1)**: raw text is segmented by [LAMBO](https://gitlab.clarin-pl.eu/syntactic-tools/lambo), then parsed and compared against gold — measures end-to-end pipeline performance including segmentation quality.
+- **Full-text (F1)**: raw text is segmented by [combo-seg](https://pypi.org/project/combo-seg/), then parsed and compared against gold — measures end-to-end pipeline performance including segmentation quality.
 - **Aligned accuracy**: accuracy on correctly segmented (aligned) tokens — measures parsing quality on tokens that were correctly identified by the segmenter.
 
 ### Morphosyntactic Tagging
 
 | Metric | Tokens | Sentences | Words | UPOS | XPOS | UFeats | AllTags | Lemmas |
 | ------ | ------ | --------- | ----- | ---- | ---- | ------ | ------- | ------ |
-| Full-text (F1) | 99.79 | 96.60 | 99.79 | 94.94 | 94.80 | 98.96 | 94.66 | 99.79 |
-| Aligned accuracy | 0.00 | 0.00 | 0.00 | 95.14 | 95.00 | 99.17 | 94.86 | 100.00 |
+| Full-text (F1) | 99.79 | 97.58 | 99.79 | 94.80 | 94.80 | 98.96 | 94.53 | 99.79 |
+| Aligned accuracy | 0.00 | 0.00 | 0.00 | 95.00 | 95.00 | 99.17 | 94.72 | 100.00 |
 
 ### Dependency Parsing
 
 | Metric | UAS | LAS | CLAS | MLAS | BLEX |
 | ------ | --- | --- | ---- | ---- | ---- |
-| Full-text (F1) | 91.61 | 84.13 | 80.76 | 77.33 | 80.76 |
-| Aligned accuracy | 91.81 | 84.31 | 80.92 | 77.48 | 80.92 |
+| Full-text (F1) | 90.64 | 83.16 | 79.43 | 76.19 | 79.43 |
+| Aligned accuracy | 90.83 | 83.33 | 79.58 | 76.34 | 79.58 |
 
 
 ## Usage
@@ -58,16 +58,14 @@ Install the library from PyPI (assuming you have a virtual environment created):
 pip install combo-nlp
 ```
 
-Install the Lambo segmenter - only needed when passing raw text strings to COMBO:
-
-```bash
-pip install --index-url https://pypi.clarin-pl.eu/ lambo
-```
+The [combo-seg](https://pypi.org/project/combo-seg/) segmenter (used to split and
+tokenise raw text) is installed automatically as a dependency of `combo-nlp`, so
+no extra install step is needed.
 
 ```python
 from combo import COMBO
 
-# Load a pre-trained model with corresponding Lambo segmenter
+# Load a pre-trained model with the corresponding combo-seg segmenter
 nlp = COMBO("Telugu")
 
 # Parse raw text (handles sentence splitting + tokenization)
@@ -79,10 +77,10 @@ for sentence in result:
         print(f"{token.form:<15} {token.lemma:<15} {token.upos:<8} head={token.head}  {token.deprel}")
 ```
 
-Refer to the COMBO-NLP documentation for installation and usage instructions:
+Refer to the combo-nlp documentation for installation and usage instructions:
 
-- [https://gitlab.clarin-pl.eu/syntactic-tools/combo-nlp](https://gitlab.clarin-pl.eu/syntactic-tools/combo-nlp)
-- [https://gitlab.clarin-pl.eu/syntactic-tools/lambo](https://gitlab.clarin-pl.eu/syntactic-tools/lambo)
+- [https://pypi.org/project/combo-nlp/](https://pypi.org/project/combo-nlp/)
+- [https://pypi.org/project/combo-seg/](https://pypi.org/project/combo-seg/)
 
 ## License
 
@@ -112,7 +110,7 @@ Ulewicz, M., Jabłońska, M., Klimaszewski, M., Przybyła, P., Pszenny, Ł., Ryb
 
 ## Resources
 
-- COMBO-NLP: [https://gitlab.clarin-pl.eu/syntactic-tools/combo-nlp](https://gitlab.clarin-pl.eu/syntactic-tools/combo-nlp)
-- LAMBO: [https://gitlab.clarin-pl.eu/syntactic-tools/lambo](https://gitlab.clarin-pl.eu/syntactic-tools/lambo)
+- combo-nlp: [https://pypi.org/project/combo-nlp/](https://pypi.org/project/combo-nlp/)
+- combo-seg: [https://pypi.org/project/combo-seg/](https://pypi.org/project/combo-seg/)
 - UD_Telugu-MTG: [https://github.com/UniversalDependencies/UD_Telugu-MTG](https://github.com/UniversalDependencies/UD_Telugu-MTG)