slovnet
Deep Learning based NLP modeling for Russian language
MIT License
SlovNet is a Python library for deep-learning based NLP modeling for Russian language. Library is integrated with other Natasha projects: Nerus — large automatically annotated corpus, Razdel — sentence segmenter, tokenizer and Navec — compact Russian embeddings. Slovnet provides high quality practical models for Russian NER, morphology and syntax, see evaluation section for more:
- NER is 1-2% worse than current BERT SOTA by DeepPavlov but 60 times smaller in size (~30 MB) and works fast on CPU (~25 news articles/sec).
- Morphology tagger and syntax parser have comparable accuracy on news dataset with large SOTA BERT models, take 50 times less space (~30 MB), work faster on CPU (~500 sentences/sec).
Downloads
Install
During inference Slovnet depends only on Numpy. Library supports Python 3.5+, PyPy 3.
$ pip install slovnet
Usage
Download model weights and vocabs package, use links from downloads section and Navec download section. Optionally install Ipymarkup to visualize NER markup.
Slovnet annotator map method has list of items as input and same size iterator over markups as output. Internally items are processed in batches of size batch_size. Default size is 8, larger batch — more RAM, better CPU utilization. __call__ method just calls map with a list of 1 item.
NER
>>> from navec import Navec
>>> from slovnet import NER
>>> from ipymarkup import show_span_ascii_markup as show_markup
>>> text = 'Европейский союз добавил в санкционный список девять политических деятелей из самопровозглашенных республик Донбасса — Донецкой народной республики (ДНР) и Луганской народной республики (ЛНР) — в связи с прошедшими там выборами. Об этом говорится в документе, опубликованном в официальном журнале Евросоюза. В новом списке фигурирует Леонид Пасечник, который по итогам выборов стал главой ЛНР. Помимо него там присутствуют Владимир Бидевка и Денис Мирошниченко, председатели законодательных органов ДНР и ЛНР, а также Ольга Позднякова и Елена Кравченко, председатели ЦИК обеих республик. Выборы прошли в непризнанных республиках Донбасса 11 ноября. На них удержали лидерство действующие руководители и партии — Денис Пушилин и «Донецкая республика» в ДНР и Леонид Пасечник с движением «Мир Луганщине» в ЛНР. Президент Франции Эмманюэль Макрон и канцлер ФРГ Ангела Меркель после встречи с украинским лидером Петром Порошенко осудили проведение выборов, заявив, что они нелегитимны и «подрывают территориальную целостность и суверенитет Украины». Позже к осуждению присоединились США с обещаниями новых санкций для России.'
>>> navec = Navec.load('navec_news_v1_1B_250K_300d_100q.tar')
>>> ner = NER.load('slovnet_ner_news_v1.tar')
>>> ner.navec(navec)
>>> markup = ner(text)
>>> show_markup(markup.text, markup.spans)
Европейский союз добавил в санкционный список девять политических
LOC─────────────
деятелей из самопровозглашенных республик Донбасса — Донецкой народной
LOC───── LOC──────────────
республики (ДНР) и Луганской народной республики (ЛНР) — в связи с
───────────────── LOC────────────────────────────────
прошедшими там выборами. Об этом говорится в документе, опубликованном
в официальном журнале Евросоюза. В новом списке фигурирует Леонид
LOC────── PER────
Пасечник, который по итогам выборов стал главой ЛНР. Помимо него там
──────── LOC
присутствуют Владимир Бидевка и Денис Мирошниченко, председатели
PER───────────── PER───────────────
законодательных органов ДНР и ЛНР, а также Ольга Позднякова и Елена
LOC LOC PER───────────── PER───
Кравченко, председатели ЦИК обеих республик. Выборы прошли в
───────── ORG
непризнанных республиках Донбасса 11 ноября. На них удержали лидерство
LOC─────
действующие руководители и партии — Денис Пушилин и «Донецкая
PER────────── ORG──────
республика» в ДНР и Леонид Пасечник с движением «Мир Луганщине» в ЛНР.
────────── LOC PER──────────── ORG────────── LOC
Президент Франции Эмманюэль Макрон и канцлер ФРГ Ангела Меркель после
LOC──── PER───────────── LOC PER───────────
встречи с украинским лидером Петром Порошенко осудили проведение
PER─────────────
выборов, заявив, что они нелегитимны и «подрывают территориальную
целостность и суверенитет Украины». Позже к осуждению присоединились
LOC────
США с обещаниями новых санкций для России.
LOC LOC───
Morphology
Morphology annotator processes tokenized text. To split the input into sentencies and tokens use Razdel.
>>> from razdel import sentenize, tokenize
>>> from navec import Navec
>>> from slovnet import Morph
>>> chunk = []
>>> for sent in sentenize(text):
>>> tokens = [_.text for _ in tokenize(sent.text)]
>>> chunk.append(tokens)
>>> chunk[:1]
[['Европейский', 'союз', 'добавил', 'в', 'санкционный', 'список', 'девять', 'политических', 'деятелей', 'из', 'самопровозглашенных', 'республик', 'Донбасса', '—', 'Донецкой', 'народной', 'республики', '(', 'ДНР', ')', 'и', 'Луганской', 'народной', 'республики', '(', 'ЛНР', ')', '—', 'в', 'связи', 'с', 'прошедшими', 'там', 'выборами', '.']]
>>> navec = Navec.load('navec_news_v1_1B_250K_300d_100q.tar')
>>> morph = Morph.load('slovnet_morph_news_v1.tar', batch_size=4)
>>> morph.navec(navec)
>>> markup = next(morph.map(chunk))
>>> for token in markup.tokens:
>>> print(f'{token.text:>20} {token.tag}')
Европейский ADJ|Case=Nom|Degree=Pos|Gender=Masc|Number=Sing
союз NOUN|Animacy=Inan|Case=Nom|Gender=Masc|Number=Sing
добавил VERB|Aspect=Perf|Gender=Masc|Mood=Ind|Number=Sing|Tense=Past|VerbForm=Fin|Voice=Act
в ADP
санкционный ADJ|Animacy=Inan|Case=Acc|Degree=Pos|Gender=Masc|Number=Sing
список NOUN|Animacy=Inan|Case=Acc|Gender=Masc|Number=Sing
девять NUM|Case=Nom
политических ADJ|Case=Gen|Degree=Pos|Number=Plur
деятелей NOUN|Animacy=Anim|Case=Gen|Gender=Masc|Number=Plur
из ADP
самопровозглашенных ADJ|Case=Gen|Degree=Pos|Number=Plur
республик NOUN|Animacy=Inan|Case=Gen|Gender=Fem|Number=Plur
Донбасса PROPN|Animacy=Inan|Case=Gen|Gender=Masc|Number=Sing
— PUNCT
Донецкой ADJ|Case=Gen|Degree=Pos|Gender=Fem|Number=Sing
народной ADJ|Case=Gen|Degree=Pos|Gender=Fem|Number=Sing
республики NOUN|Animacy=Inan|Case=Gen|Gender=Fem|Number=Sing
( PUNCT
ДНР PROPN|Animacy=Inan|Case=Gen|Gender=Fem|Number=Sing
) PUNCT
и CCONJ
Луганской ADJ|Case=Gen|Degree=Pos|Gender=Fem|Number=Sing
народной ADJ|Case=Gen|Degree=Pos|Gender=Fem|Number=Sing
республики NOUN|Animacy=Inan|Case=Gen|Gender=Fem|Number=Sing
( PUNCT
ЛНР PROPN|Animacy=Inan|Case=Gen|Gender=Fem|Number=Sing
) PUNCT
— PUNCT
в ADP
связи NOUN|Animacy=Inan|Case=Loc|Gender=Fem|Number=Sing
с ADP
прошедшими VERB|Aspect=Perf|Case=Ins|Number=Plur|Tense=Past|VerbForm=Part|Voice=Act
там ADV|Degree=Pos
выборами NOUN|Animacy=Inan|Case=Ins|Gender=Masc|Number=Plur
. PUNCT
Syntax
Syntax parser processes sentencies split into tokens. Use Razdel for segmentation.
>>> from ipymarkup import show_dep_ascii_markup as show_markup
>>> from razdel import sentenize, tokenize
>>> from navec import Navec
>>> from slovnet import Syntax
>>> chunk = []
>>> for sent in sentenize(text):
>>> tokens = [_.text for _ in tokenize(sent.text)]
>>> chunk.append(tokens)
>>> chunk[:1]
[['Европейский', 'союз', 'добавил', 'в', 'санкционный', 'список', 'девять', 'политических', 'деятелей', 'из', 'самопровозглашенных', 'республик', 'Донбасса', '—', 'Донецкой', 'народной', 'республики', '(', 'ДНР', ')', 'и', 'Луганской', 'народной', 'республики', '(', 'ЛНР', ')', '—', 'в', 'связи', 'с', 'прошедшими', 'там', 'выборами', '.']]
>>> navec = Navec.load('navec_news_v1_1B_250K_300d_100q.tar')
>>> syntax = Syntax.load('slovnet_syntax_news_v1.tar')
>>> syntax.navec(navec)
>>> markup = next(syntax.map(chunk))
# Convert CoNLL-style format to source, target indices
>>> words, deps = [], []
>>> for token in markup.tokens:
>>> words.append(token.text)
>>> source = int(token.head_id) - 1
>>> target = int(token.id) - 1
>>> if source > 0 and source != target: # skip root, loops
>>> deps.append([source, target, token.rel])
>>> show_markup(words, deps)
┌► Европейский amod
┌►└─ союз nsubj
┌───────┌─┌─└─── добавил
│ │ │ ┌──► в case
│ │ │ │ ┌► санкционный amod
│ │ └►└─└─ список obl
│ │ ┌──► девять nummod:gov
│ │ │ ┌► политических amod
│ ┌─────└►┌─└─└─ деятелей obj
│ │ │ ┌──► из case
│ │ │ │ ┌► самопровозглашенных amod
│ │ └►└─└─ республик nmod
│ │ └──► Донбасса nmod
│ │ ┌──────────► — punct
│ │ │ ┌──► Донецкой amod
│ │ │ │ ┌► народной amod
│ │ │ ┌─┌─┌─└─└─ республики
│ │ │ │ │ │ ┌► ( punct
│ │ │ │ │ └►┌─└─ ДНР parataxis
│ │ │ │ │ └──► ) punct
│ │ │ │ │ ┌────► и cc
│ │ │ │ │ │ ┌──► Луганской amod
│ │ │ │ │ │ │ ┌► народной amod
│ │ └─│ └►└─└─└─ республики conj
│ │ │ ┌► ( punct
│ │ └────►┌─└─ ЛНР parataxis
│ │ └──► ) punct
│ │ ┌──────► — punct
│ │ │ ┌►┌─┌─ в case
│ │ │ │ │ └► связи fixed
│ │ │ │ └──► с fixed
│ │ │ │ ┌►┌─ прошедшими acl
│ │ │ │ │ └► там advmod
│ └────►└─└─└─── выборами nmod
└──────────────► . punct
Documentation
Materials are in Russian:
- Article about distillation and quantization in Slovnet
- Slovnet section of Datafest 2020 talk
Evaluation
In addition to quality metrics we measure speed and models size, parameters that are important in production:
-
init— time between system launch and first response. It is convenient for testing and devops to have model that starts quickly. -
disk— file size of artefacts one needs to download before using the system: model weights, embeddings, binaries, vocabs. It is convenient to deploy compact models in production. -
ram— average CPU/GPU RAM usage. -
speed— number of input items processed per second: news articles, tokenized sentencies.
NER
4 datasets are used for evaluation: factru, gareev, ne5 and bsnlp. Slovnet is compared to deeppavlov, deeppavlov_bert, deeppavlov_slavic, pullenti, spacy, stanza, texterra, tomita, mitie.
For every column top 3 results are highlighted:
it/s — news articles per second, 1 article ≈ 1KB.
Morphology
Datasets from GramEval2020 are used for evaluation:
-
news— sample from Lenta.ru. -
wiki— UD GSD. -
fiction— SynTagRus + JZ. -
social,poetry— social, poetry subset of Taiga.
Slovnet is compated to a number of existing morphology taggers: deeppavlov, deeppavlov_bert, rupostagger, rnnmorph, maru, udpipe, spacy, stanza.
For every column top 3 results are highlighted. slovnet was trained only on news dataset:
it/s — sentences per second.
Syntax
Slovnet is compated to several existing syntax parsers: udpipe, spacy, deeppavlov, stanza.
it/s — sentences per second.
Support
- Chat — https://telegram.me/natural_language_processing
- Issues — https://github.com/natasha/slovnet/issues
- Commercial support — https://lab.alexkuk.ru
Development
Dev env
python -m venv ~/.venvs/natasha-slovnet
source ~/.venvs/natasha-slovnet/bin/activate
pip install -r requirements/dev.txt
pip install -e .
Test
make test
Rent GPU
yc compute instance create \
--name gpu \
--zone ru-central1-a \
--network-interface subnet-name=default,nat-ip-version=ipv4 \
--create-boot-disk image-folder-id=standard-images,image-family=ubuntu-1804-lts-ngc,type=network-ssd,size=20 \
--cores=8 \
--memory=96 \
--gpus=1 \
--ssh-key ~/.ssh/id_rsa.pub \
--folder-name default \
--platform-id gpu-standard-v1 \
--preemptible
yc compute instance delete --name gpu
Setup instance
sudo locale-gen ru_RU.UTF-8
sudo apt-get update
sudo apt-get install -y \
python3-pip
# grpcio long install ~10m, not using prebuilt wheel
# "it is not compatible with this Python"
sudo pip3 install -v \
jupyter \
tensorboard
mkdir runs
nohup tensorboard \
--logdir=runs \
--host=localhost \
--port=6006 \
--reload_interval=1 &
nohup jupyter notebook \
--no-browser \
--allow-root \
--ip=localhost \
--port=8888 \
--NotebookApp.token='' \
--NotebookApp.password='' &
ssh -Nf gpu -L 8888:localhost:8888 -L 6006:localhost:6006
scp ~/.slovnet.json gpu:~
rsync --exclude data -rv . gpu:~/slovnet
rsync -u --exclude data -rv 'gpu:~/slovnet/*' .
Intall dev
pip3 install -r slovnet/requirements/dev.txt -r slovnet/requirements/gpu.txt
pip3 install -e slovnet
Release
# Update setup.py version
git commit -am 'Up version'
git tag v0.6.0
git push
git push --tags
# Github Action builds dist and publishes to PyPi
Package Rankings
Top 31.61% on Conda-forge.org
Top 4.16% on Pypi.org