failed09 commited on
Commit
ff079a4
·
verified ·
1 Parent(s): b03c74b

Translate model card to English

Browse files
Files changed (1) hide show
  1. README.md +11 -21
README.md CHANGED
@@ -11,41 +11,31 @@ tags:
11
 
12
  # Bashkir LID
13
 
14
- Компактная модель для определения того, является ли короткий текст
15
- башкирским или русским. Модель ориентирована на фильтрацию башкирских
16
- корпусов и локальные приложения, где важны скорость и небольшой размер.
17
 
18
- ## Использование
19
 
20
  ```python
21
  from lid import LanguageIdentifier
22
-
23
  lid = LanguageIdentifier()
24
  print(lid.predict(["Мин башҡорт телен яратам."]))
25
  ```
26
 
27
- Для запуска требуется `onnxruntime` и `numpy`.
28
 
29
- ## Модель
30
 
31
- Используются символьные n-граммы TF-IDF (`char_wb`, 2–4) и линейный
32
- классификатор, экспортированный в ONNX. Веса и словарь признаков поставляются
33
- в репозитории; исходные тренировочные тексты не распространяются.
34
 
35
- ## Ограничения
36
 
37
- Модель бинарная: `ba` против `ru`. Она не предназначена для надёжного
38
- различения татарского, чувашского и других языков. Для многоязычного шлюза
39
- используйте отдельную LID-модель. Короткие строки, имена, OCR и смешанный текст
40
- могут классифицироваться неоднозначно.
41
 
42
- ## Лицензия и происхождение
43
 
44
- Код и экспорт модели распространяются под Apache-2.0. Тренировочные тексты
45
- остаются в исходном проекте и не включены в этот репозиторий. Если отдельный
46
- источник имеет более строгие условия, применяются условия этого источника.
47
 
48
- ## Цитирование
49
 
50
  ```bibtex
51
  @software{failed09_bashkir_lid,
@@ -57,4 +47,4 @@ print(lid.predict(["Мин башҡорт телен яратам."]))
57
  }
58
  ```
59
 
60
- Башҡорт теле өсөн эшләнгән асыҡ сығанаҡлы инструмент.
 
11
 
12
  # Bashkir LID
13
 
14
+ A compact language identification model for deciding whether short text is Bashkir or Russian. It is intended for Bashkir corpus filtering and local applications where speed and a small footprint matter.
 
 
15
 
16
+ ## Usage
17
 
18
  ```python
19
  from lid import LanguageIdentifier
 
20
  lid = LanguageIdentifier()
21
  print(lid.predict(["Мин башҡорт телен яратам."]))
22
  ```
23
 
24
+ Requires `onnxruntime` and `numpy`.
25
 
26
+ ## Model
27
 
28
+ Character TF-IDF n-grams (`char_wb`, 2–4) and a linear classifier exported to ONNX. Training texts are not redistributed.
 
 
29
 
30
+ ## Limitations
31
 
32
+ This is a binary `ba` vs `ru` classifier. It is not designed to reliably distinguish Tatar, Chuvash, or other languages. Short strings, names, OCR artifacts, and mixed-language text may be ambiguous.
 
 
 
33
 
34
+ ## License and provenance
35
 
36
+ The code and model export are released under Apache-2.0. Training texts remain in the source project and are not included here.
 
 
37
 
38
+ ## Citation
39
 
40
  ```bibtex
41
  @software{failed09_bashkir_lid,
 
47
  }
48
  ```
49
 
50
+ An open-source tool for the Bashkir language.