Update README.md
Browse files
README.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
| 1 |
---
|
| 2 |
-
license:
|
| 3 |
language:
|
| 4 |
- ru
|
| 5 |
---
|
|
@@ -7,9 +7,8 @@ language:
|
|
| 7 |
|
| 8 |
RUAccent - это библиотека для автоматической расстановки ударений на русском языке.
|
| 9 |
|
| 10 |
-
**
|
| 11 |
|
| 12 |
-
**По вопросам коммерческого использования пишите на [telegram аккаунт](https://t.me/chckdskeasfsd)**
|
| 13 |
## Установка
|
| 14 |
С помощью pip
|
| 15 |
```
|
|
@@ -21,24 +20,30 @@ RUAccent - это библиотека для автоматической ра
|
|
| 21 |
```
|
| 22 |
## Параметры работы
|
| 23 |
|
| 24 |
-
load(omograph_model_size='
|
| 25 |
|
| 26 |
-
- На данный момент доступно
|
| 27 |
- Переменная **use_dictionary** отвечает за загрузку всего словаря (требуется больше ОЗУ), иначе все ударения расставляет нейросеть.
|
| 28 |
- Функция **custom_dict** отвечает за добавление своих вариантов ударений в словарь. Формат такой: `{'слово': 'сл+ово с удар+ением'}`
|
| 29 |
- Выбор устройства CPU или CUDA. **Для работы с CUDA требуется установить onnxruntime-gpu и CUDA.**
|
| 30 |
- workdir - принимает строку. Является путём, куда скачиваются модели.
|
| 31 |
-
|
| 32 |
-
|
|
|
|
|
|
|
| 33 |
## Пример использования
|
| 34 |
```python
|
| 35 |
from ruaccent import RUAccent
|
| 36 |
|
| 37 |
accentizer = RUAccent()
|
| 38 |
-
accentizer.load(omograph_model_size='
|
| 39 |
|
| 40 |
text = 'на двери висит замок.'
|
| 41 |
print(accentizer.process_all(text))
|
| 42 |
```
|
| 43 |
|
| 44 |
-
Файлы моделей и словарей располагаются по [ссылке](https://huggingface.co/ruaccent/accentuator). Мы будем признательны фидбеку на [telegram аккаунт](https://t.me/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
license: mit
|
| 3 |
language:
|
| 4 |
- ru
|
| 5 |
---
|
|
|
|
| 7 |
|
| 8 |
RUAccent - это библиотека для автоматической расстановки ударений на русском языке.
|
| 9 |
|
| 10 |
+
**Мы переходим на лицензию MIT для всей системы v1.**
|
| 11 |
|
|
|
|
| 12 |
## Установка
|
| 13 |
С помощью pip
|
| 14 |
```
|
|
|
|
| 20 |
```
|
| 21 |
## Параметры работы
|
| 22 |
|
| 23 |
+
load(omograph_model_size='turbo2', use_dictionary=True, custom_dict={}, device="CPU", workdir=None)
|
| 24 |
|
| 25 |
+
- На данный момент доступно 6 моделей - **tiny**, **tiny2**, **tiny2.1**, **turbo2**, **turbo3**, **turbo3.1**, **turbo**, **big_poetry**.
|
| 26 |
- Переменная **use_dictionary** отвечает за загрузку всего словаря (требуется больше ОЗУ), иначе все ударения расставляет нейросеть.
|
| 27 |
- Функция **custom_dict** отвечает за добавление своих вариантов ударений в словарь. Формат такой: `{'слово': 'сл+ово с удар+ением'}`
|
| 28 |
- Выбор устройства CPU или CUDA. **Для работы с CUDA требуется установить onnxruntime-gpu и CUDA.**
|
| 29 |
- workdir - принимает строку. Является путём, куда скачиваются модели.
|
| 30 |
+
- tiny_mode - принимает True или False. При True отключает руловый пайплайн и часть моделей. Также не загружается словарь ударений.
|
| 31 |
+
|
| 32 |
+
**Для стабильной работы требуется минимум 512 мегабайт ОЗУ (модель омографов - tiny)**
|
| 33 |
+
|
| 34 |
## Пример использования
|
| 35 |
```python
|
| 36 |
from ruaccent import RUAccent
|
| 37 |
|
| 38 |
accentizer = RUAccent()
|
| 39 |
+
accentizer.load(omograph_model_size='turbo3.1', use_dictionary=True, tiny_mode=False)
|
| 40 |
|
| 41 |
text = 'на двери висит замок.'
|
| 42 |
print(accentizer.process_all(text))
|
| 43 |
```
|
| 44 |
|
| 45 |
+
Файлы моделей и словарей располагаются по [ссылке](https://huggingface.co/ruaccent/accentuator). Мы будем признательны фидбеку на [telegram аккаунт](https://t.me/bceloss)
|
| 46 |
+
|
| 47 |
+
## Донат
|
| 48 |
+
Вы можете поддержать проект деньгами. Это поможет быстрее разрабатывать более качественные новые версии.
|
| 49 |
+
CloudTips: https://pay.cloudtips.ru/p/b9d86686
|