huspacy 0.12.1
HuSpaCy: industrial strength Hungarian natural language processing
License: Apache-2.0
Requires Python: <3.14,>=3.9
Keywords: nlp, huspacy, Hungarian, text processing, text processing, language processing, text mining, tokenization, sentence boundary detection, sbd, sentence splitting, pos tagging, tagging, lemmatization, ner, named entity recognition, parsing, word embeddings, word vectors, spacy, spacy model


# 

<div align="center" markdown>

![project logo](https://raw.githubusercontent.com/huspacy/huspacy/develop/.github/resources/logo.png)

[![python version](https://img.shields.io/badge/Python-%3E=3.7-blue)](https://github.com/huspacy/huspacy)
[![spacy](https://img.shields.io/badge/built%20with-spaCy-09a3d5.svg)](https://spacy.io)
![PyPI - Wheel](https://img.shields.io/pypi/wheel/huspacy)
[![PyPI version](https://badge.fury.io/py/huspacy.svg)](https://pypi.org/project/huspacy/)
[![Demo](https://img.shields.io/badge/Try%20the-Demo-important)](https://huggingface.co/spaces/huspacy/demo)
<br/>
[![Build](https://github.com/huspacy/huspacy/actions/workflows/build.yml/badge.svg)](https://github.com/huspacy/huspacy/actions/workflows/build.yml)
[![Models](https://github.com/huspacy/huspacy/actions/workflows/test_models.yml/badge.svg)](https://github.com/huspacy/huspacy/actions/workflows/test_models.yml)
[![Downloads](https://static.pepy.tech/personalized-badge/huspacy?period=month&units=international_system&left_color=grey&right_color=green&left_text=Downloads/month)](https://pepy.tech/project/huspacy)
[![Downloads](https://static.pepy.tech/personalized-badge/huspacy?period=total&units=international_system&left_color=grey&right_color=green&left_text=Downloads)](https://pepy.tech/project/huspacy)
[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fhuspacy%2Fhuspacy&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=true)](https://hits.seeyoufarm.com)
[![stars](https://img.shields.io/github/stars/huspacy/huspacy?style=social)](https://github.com/huspacy/huspacy)
</div>

HuSpaCy is a [spaCy](https://spacy.io) library providing industrial-strength Hungarian language processing facilities through spaCy models. 
The released pipelines consist of a tokenizer, sentence splitter, lemmatizer, tagger (predicting morphological features as well), dependency parser and a named entity recognition module. 
Word and phrase embeddings are also available through spaCy's API.
All models have high throughput, decent memory usage and close to state-of-the-art accuracy. 
A live demo is available [here](https://huggingface.co/spaces/huspacy/demo), model releases are published to [Hugging Face Hub](https://huggingface.co/huspacy/).

This repository contains material to build HuSpaCy and all of its models in a reproducible way.

#  Installation

To get started using the tool, first, we need to download one of the models. The easiest way to achieve this is to install `huspacy` (from [PyPI](https://pypi.org/project/huspacy/)) and then fetch a model through its API.

```bash
pip install huspacy
```

```python
import huspacy

# Download the latest CPU optimized model
huspacy.download()
```

### Install the models directly

You can install the latest models directly from 🤗 Hugging Face Hub:

- CPU optimized [large model](https://huggingface.co/huspacy/hu_core_news_lg): `pip install hu_core_news_lg@https://huggingface.co/huspacy/hu_core_news_lg/resolve/main/hu_core_news_lg-any-py3-none-any.whl`
- GPU optimized [transformers model](https://huggingface.co/huspacy/hu_core_news_trf): `pip install hu_core_news_trf@https://huggingface.co/huspacy/hu_core_news_trf/resolve/main/hu_core_news_trf-any-py3-none-any.whl`

To speed up inference on GPU, CUDA must be installed as described in [https://spacy.io/usage](https://spacy.io/usage).

Read more on the models [here](https://huspacy.github.io/models)

#  Quickstart
HuSpaCy is fully compatible with [spaCy's API](https://spacy.io/api/doc/), newcomers can easily get started with [spaCy 101](https://spacy.io/usage/spacy-101) guide.

Although HuSpacy models can be loaded with `spacy.load(...)`, the tool provides convenience methods to easily access downloaded models.

```python
# Load the model using spacy.load(...)
import spacy
nlp = spacy.load("hu_core_news_lg")
```

```python
# Load the default large model (if downloaded)
import huspacy
nlp = huspacy.load()
```

```python
# Load the model directly as a module
import hu_core_news_lg
nlp = hu_core_news_lg.load()
```

To process texts, you can simply call the loaded model (i.e. the [`nlp` callable object](https://spacy.io/api/language#call)) 

<!--pytest-codeblocks:cont-->

```python
doc = nlp("Csiribiri csiribiri zabszalma - négy csillag közt alszom ma.")
```

As HuSpaCy is built on spaCy, the returned [`doc` document](https://spacy.io/api/doc#_title) contains all the annotations given by the pipeline components.

API Documentation is available in [our website](https://huspacy.github.io/).

#  Models overview

We provide several pretrained models:

1. [`hu_core_news_lg`](https://huggingface.co/huspacy/hu_core_news_lg) is a CNN-based large model which achieves a good
   balance between accuracy and processing speed. This default model provides tokenization, sentence splitting,
   part-of-speech tagging (UD labels w/ detailed morphosyntactic features), lemmatization, dependency parsing and named
   entity recognition and ships with pretrained word vectors.
2. [`hu_core_news_trf`](https://huggingface.co/huspacy/hu_core_news_trf) is built
   on [huBERT](https://huggingface.co/SZTAKI-HLT/hubert-base-cc) and provides the same functionality as the large model
   except the word vectors. It comes with much higher accuracy in the price of increased computational resource usage.
   We suggest using it with GPU support.
3. [`hu_core_news_md`](https://huggingface.co/huspacy/hu_core_news_md) greatly improves on `hu_core_news_lg`'s
   throughput by loosing some accuracy. This model could be a good choice when processing speed is crucial.
4. [`hu_core_news_trf_xl`](https://huggingface.co/huspacy/hu_core_news_trf_xl) is an experimental model built
   on [XLM-RoBERTa-large](https://huggingface.co/xlm-roberta-large). It provides the same functionality as
   the `hu_core_news_trf` model, however it comes with slightly higher accuracy in the price of significantly increased
   computational resource usage.
   We suggest using it with GPU support.

HuSpaCy's model versions follows [spaCy's versioning scheme](https://spacy.io/models#model-versioning).

A demo of the models is available at [Hugging Face Spaces](https://huggingface.co/spaces/huspacy/demo).

To read more about the model's architecture we suggest
reading [the relevant sections from spaCy's documentation](https://spacy.io/models#design).

### Comparison

| Models          | `md`                                                                                                                     | `lg`                                                                                             | `trf`                                                                                                                                | `trf_xl`                                                                                                                 |
|-----------------|--------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|   
| Embeddings      | 100d floret                                                                                                              | 300d floret                                                                                      | transformer:<br/>[`huBERT`](https://huggingface.co/SZTAKI-HLT/hubert-base-cc)                                                        | transformer:<br/>[`XLM-RoBERTa-large`](https://huggingface.co/xlm-roberta-large)                                         |
| Target hardware | CPU                                                                                                                      | CPU                                                                                              | GPU                                                                                                                                  | GPU                                                                                                                      |
| Accuracy        | ⭑⭑⭑⭒             | ⭑⭑⭑⭑ | ⭑⭑⭑⭑⭒ | ⭑⭑⭑⭑⭑ |
| Resource usage  | ⭑⭑⭑⭑⭑ | ⭑⭑⭑⭑ | ⭑⭑                                                                                     | ⭒                                                                                     |

# Citation
 
If you use HuSpaCy or any of its models, please cite it as: 

[![arxiv](http://img.shields.io/badge/cs.CL-arXiv%3A2308.12635-B31B1B.svg)](https://arxiv.org/abs/2308.12635)

```bibtex
@InProceedings{HuSpaCy:2023,
    author= {"Orosz, Gy{\"o}rgy and Szab{\'o}, Gerg{\H{o}} and Berkecz, P{\'e}ter and Sz{\'a}nt{\'o}, Zsolt and Farkas, Rich{\'a}rd"},
    editor= {"Ek{\v{s}}tein, Kamil and P{\'a}rtl, Franti{\v{s}}ek and Konop{\'i}k, Miloslav"},
    title = {{"Advancing Hungarian Text Processing with HuSpaCy: Efficient and Accurate NLP Pipelines"}},
    booktitle = {{"Text, Speech, and Dialogue"}},
    year = "2023",
    publisher = {{"Springer Nature Switzerland"}},
    address = {{"Cham"}},
    pages = "58--69",
    isbn = "978-3-031-40498-6"
}
```

[![arxiv](http://img.shields.io/badge/cs.CL-arXiv%3A2201.01956-B31B1B.svg)](https://arxiv.org/abs/2201.01956)

```bibtex
@InProceedings{HuSpaCy:2021,
  title = {{HuSpaCy: an industrial-strength Hungarian natural language processing toolkit}},
  booktitle = {{XVIII. Magyar Sz{\'a}m{\'\i}t{\'o}g{\'e}pes Nyelv{\'e}szeti Konferencia}},
  author = {Orosz, Gy{\"o}rgy and Sz{\' a}nt{\' o}, Zsolt and Berkecz, P{\' e}ter and Szab{\' o}, Gerg{\H o} and Farkas, Rich{\' a}rd},
  location = {{Szeged}},
  pages = "59--73",
  year = {2022},
}
```

#  Contact

For feature requests, issues and bugs please use the [GitHub Issue Tracker](https://github.com/huspacy/huspacy/issues). Otherwise, reach out to us in the [Discussion Forum](https://github.com/huspacy/huspacy/discussions).

## Authors

HuSpaCy is implemented in the [SzegedAI](https://szegedai.github.io/) team, coordinated by [Orosz György](mailto:gyorgy@orosz.link) in the [Hungarian AI National Laboratory, MILAB](https://mi.nemzetilabor.hu/) program.

#  License

This library is released under the [Apache 2.0 License](https://github.com/huspacy/huspacy/blob/master/LICENSE)

Trained models have their own license ([CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)) as described on the [models page](https://huggingface.co/huspacy/).