Den4ikAI commited on
Commit
532937c
1 Parent(s): 20a943f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +10 -9
README.md CHANGED
@@ -7,6 +7,9 @@ language:
7
 
8
  RUAccent - это библиотека для автоматической расстановки ударений на русском языке.
9
 
 
 
 
10
  ## Установка
11
  С помощью pip
12
  ```
@@ -18,26 +21,24 @@ RUAccent - это библиотека для автоматической ра
18
  ```
19
  ## Параметры работы
20
 
21
- load(omograph_model_size='big_poetry', use_dictionary=True, custom_dict={})
22
 
23
- - На данный момент доступно 6 моделей. **big** (рекомендуется к использованию), **medium** и **small**. Рекомендуются к использованию модели версии **poetry**. Их названия **big_poetry**, **medium_poetry**, **small_poetry**.
24
- - Модель **big** имеет 178 миллионов параметров, **medium** 85 миллионов, а **small** 12 миллионов
25
  - Переменная **use_dictionary** отвечает за загрузку всего словаря (требуется больше ОЗУ), иначе все ударения расставляет нейросеть.
26
  - Функция **custom_dict** отвечает за добавление своих вариантов ударений в словарь. Формат такой: `{'слово': 'сл+ово с удар+ением'}`
27
-
28
- **Для работы требуется 5 гигабайт ОЗУ**
 
 
29
  ## Пример использования
30
  ```python
31
  from ruaccent import RUAccent
32
 
33
  accentizer = RUAccent()
34
- accentizer.load(omograph_model_size='big_poetry', use_dictionary=True)
35
 
36
  text = 'на двери висит замок.'
37
  print(accentizer.process_all(text))
38
-
39
- text = 'ежик нашел в лесу ягоды.'
40
- print(accentizer.process_yo(text))
41
  ```
42
 
43
  Файлы моделей и словарей располагаются по [ссылке](https://huggingface.co/ruaccent/accentuator). Мы будем признательны фидбеку на [telegram аккаунт](https://t.me/chckdskeasfsd)
 
7
 
8
  RUAccent - это библиотека для автоматической расстановки ударений на русском языке.
9
 
10
+ **Внимание!!! Смена лицензии на Apache 2.0**
11
+
12
+ **По вопросам коммерческого использования пишите на [telegram аккаунт](https://t.me/chckdskeasfsd)**
13
  ## Установка
14
  С помощью pip
15
  ```
 
21
  ```
22
  ## Параметры работы
23
 
24
+ load(omograph_model_size='turbo', use_dictionary=True, custom_dict={}, device="CPU", workdir=None)
25
 
26
+ - На данный момент доступно 4 модели - **turbo**, **big_poetry**, **medium_poetry**, **small_poetry**
 
27
  - Переменная **use_dictionary** отвечает за загрузку всего словаря (требуется больше ОЗУ), иначе все ударения расставляет нейросеть.
28
  - Функция **custom_dict** отвечает за добавление своих вариантов ударений в словарь. Формат такой: `{'слово': 'сл+ово с удар+ением'}`
29
+ - Выбор устройства CPU или CUDA. **Для работы с CUDA требуется установить onnxruntime-gpu и CUDA.**
30
+ - workdir - принимает строку. Является путём, куда скачиваются модели.
31
+
32
+ **Для стабильной работы требуется минимум 3 гигабайта ОЗУ**
33
  ## Пример использования
34
  ```python
35
  from ruaccent import RUAccent
36
 
37
  accentizer = RUAccent()
38
+ accentizer.load(omograph_model_size='turbo', use_dictionary=True)
39
 
40
  text = 'на двери висит замок.'
41
  print(accentizer.process_all(text))
 
 
 
42
  ```
43
 
44
  Файлы моделей и словарей располагаются по [ссылке](https://huggingface.co/ruaccent/accentuator). Мы будем признательны фидбеку на [telegram аккаунт](https://t.me/chckdskeasfsd)