accentuator / README.md
Den4ikAI's picture
Update README.md
532937c verified
---
license: apache-2.0
language:
- ru
---
# RUAccent
RUAccent - это библиотека для автоматической расстановки ударений на русском языке.
**Внимание!!! Смена лицензии на Apache 2.0**
**По вопросам коммерческого использования пишите на [telegram аккаунт](https://t.me/chckdskeasfsd)**
## Установка
С помощью pip
```
pip install ruaccent
```
С помощью GIT
```
pip install git+https://github.com/Den4ikAI/ruaccent.git
```
## Параметры работы
load(omograph_model_size='turbo', use_dictionary=True, custom_dict={}, device="CPU", workdir=None)
- На данный момент доступно 4 модели - **turbo**, **big_poetry**, **medium_poetry**, **small_poetry**
- Переменная **use_dictionary** отвечает за загрузку всего словаря (требуется больше ОЗУ), иначе все ударения расставляет нейросеть.
- Функция **custom_dict** отвечает за добавление своих вариантов ударений в словарь. Формат такой: `{'слово': 'сл+ово с удар+ением'}`
- Выбор устройства CPU или CUDA. **Для работы с CUDA требуется установить onnxruntime-gpu и CUDA.**
- workdir - принимает строку. Является путём, куда скачиваются модели.
**Для стабильной работы требуется минимум 3 гигабайта ОЗУ**
## Пример использования
```python
from ruaccent import RUAccent
accentizer = RUAccent()
accentizer.load(omograph_model_size='turbo', use_dictionary=True)
text = 'на двери висит замок.'
print(accentizer.process_all(text))
```
Файлы моделей и словарей располагаются по [ссылке](https://huggingface.co/ruaccent/accentuator). Мы будем признательны фидбеку на [telegram аккаунт](https://t.me/chckdskeasfsd)