Upload folder using huggingface_hub

.dockerignore

@@ -0,0 +1,9 @@
+__pycache__
+*.pyc
+*.pyo
+*.pyd
+.venv
+venv-LexIR.v2
+checkpoints
+data
+artifacts

.gitattributes

@@ -33,3 +33,10 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+artifacts/indexes/finetuned/kz.faiss filter=lfs diff=lfs merge=lfs -text
+artifacts/indexes/finetuned/ru.faiss filter=lfs diff=lfs merge=lfs -text
+artifacts/indexes/labse/kz.faiss filter=lfs diff=lfs merge=lfs -text
+artifacts/indexes/labse/ru.faiss filter=lfs diff=lfs merge=lfs -text
+artifacts/indexes/mpnet_base/kz.faiss filter=lfs diff=lfs merge=lfs -text
+artifacts/indexes/mpnet_base/ru.faiss filter=lfs diff=lfs merge=lfs -text
+artifacts/models/finetuned_mpnet/tokenizer.json filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -0,0 +1,2 @@
+.vscode
+venv*

README.md

@@ -1,3 +1,219 @@
----
-license: unknown
----
+---
+license: other
+language:
+  - ru
+  - kk
+tags:
+  - legal
+  - semantic-search
+  - retrieval
+  - faiss
+  - sentence-transformers
+  - fastapi
+  - openai
+pipeline_tag: sentence-similarity
+---
+
+# LexIR
+
+LexIR — исследовательский прототип интеллектуального юридического ассистента с гибкой архитектурой под **любой правовой корпус**. Система сочетает семантический поиск (fine‑tuned MPNet + FAISS) и «grounded»‑ответы ассистента, которые строятся **только** на найденных нормах из подключенного корпуса.
+
+## Кратко о том, как все работает
+
+1. **Источник норм**: парсер/ETL вытягивает тексты правовых норм и приводит их к унифицированному формату.
+2. **Корпус**: RU/KZ JSONL‑набор норм (в демо — Конституция РК как пример).
+3. **Обучение bi‑encoder**: `src/train_biencoder.py` дообучает MPNet на парах «запрос → релевантная норма».
+4. **Индексы**: `src/build_index.py` строит FAISS‑индексы по RU/KZ для базовой/LaBSE/финетюн‑модели.
+5. **Retrieval API**: `site/backend/app.py` поднимает FastAPI и локально выполняет поиск по FAISS.
+6. **LLM‑оркестрация**: Azure OpenAI Assistant получает запрос, **обязан** вызвать инструмент `lexir_retrieve_constitution`, и формирует ответ только на основе возвращенных норм.
+7. **UI**: фронтенд отправляет запросы на `/api/chat`, хранит `thread_id` в sessionStorage и отображает ответы.
+
+## Архитектура (модули)
+
+- **Data ingestion**: `data_parser/adilet_zan_parser.py` → `data/clauses_constitution_ru_kz.jsonl` (в демо).
+- **Training**: `src/train_biencoder.py` → `artifacts/models/finetuned_mpnet/`.
+- **Indexing**: `src/build_index.py` → `artifacts/indexes/<alias>/{ru,kz}.faiss` + `*_meta.jsonl`.
+- **Evaluation**: `src/evaluate.py`, `src/plot_eval.py`, `src/validate.py` → `artifacts/reports/`.
+- **Backend**: `site/backend/app.py` (FastAPI + Azure OpenAI Assistants).
+- **Assistant tooling**: `site/backend/assistant/*.py`.
+- **Frontend**: `site/frontend/` (статический SPA‑интерфейс).
+
+## Структура репозитория (ключевое)
+
+```
+artifacts/
+  models/finetuned_mpnet/       # fine‑tuned MPNet
+  indexes/<alias>/              # FAISS индексы + meta JSONL
+  reports/                      # eval отчеты и графики
+data/
+  clauses_constitution_ru_kz.jsonl
+  legal_assistant_train.jsonl
+  legal_assistant_test.jsonl
+data_parser/
+  adilet_zan_parser.py
+site/
+  backend/
+    app.py
+    assistant/
+      assistant_create.py
+      assistant_edit.py
+      assistant_info.py
+      demo_assistant.py
+  frontend/
+    index.html
+    app.js
+    styles.css
+src/
+  build_index.py
+  train_biencoder.py
+  evaluate.py
+  plot_eval.py
+  validate.py
+  demo_cli.py
+  api.py
+```
+
+## Данные и формат
+
+`data/clauses_constitution_ru_kz.jsonl` — параллельный RU/KZ корпус (в демо — Конституция РК как пример). Каждая строка:
+
+```json
+{
+  "id": "KZ.CONST.1995:ART18:PAR2:cl1",
+  "text": "русский абзац ...",
+  "text_kz": "қазақша абзац ...",
+  "meta": {
+    "doc_id": "KZ.CONST.1995",
+    "article_number": "18",
+    "paragraph_number": 2,
+    "article_title_ru": "...",
+    "article_title_kz": "...",
+    "source_ru": "...",
+    "source_kz": "..."
+  }
+}
+```
+
+## Retrieval и ранжирование
+
+- Модель: `SentenceTransformer` (по умолчанию fine‑tuned MPNet).
+- Эмбеддинги нормализуются и индексируются в **FAISS IndexFlatIP** (cosine similarity).
+- Поиск возвращает `top_k`, затем применяется порог `min_score` (в ассистенте по умолчанию 0.25).
+- Результат — список норм с `id`, `text`, `meta`, `score`.
+
+## Ассистент (LLM)
+
+Файл `site/backend/assistant/assistant_create.py` создает ассистента Azure OpenAI с:
+
+- обязательным вызовом инструмента `lexir_retrieve_constitution`,
+- запретом на «галлюцинации» и просьбой отвечать на языке пользователя,
+- политикой «grounded only» — ответы строятся исключительно на найденных нормах корпуса.
+
+Созданный `assistant_id` сохраняется в `site/backend/assistant/assistant_id.txt`.
+
+## Запуск (локально)
+
+### 1) Подготовка окружения
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -r site/backend/requirements.txt
+```
+
+### 2) Переменные окружения
+
+Минимальный набор (см. `site/backend/app.py`):
+
+```
+AZURE_OPENAI_API_KEY=...
+AZURE_OPENAI_VERSION=...
+AZURE_OPENAI_ENDPOINT=...
+```
+
+Опционально:
+
+```
+ASSISTANT_ID=...                # если уже создан ассистент
+AZURE_OPENAI_ASSISTANT_MODEL=...# требуется для assistant_edit.py
+```
+
+### 3) Индексы и модель
+
+Backend ожидает:
+
+```
+artifacts/models/finetuned_mpnet/
+artifacts/indexes/finetuned/{ru,kz}.faiss
+artifacts/indexes/finetuned/{ru,kz}_meta.jsonl
+```
+
+Если их нет:
+
+```bash
+python data_parser/adilet_zan_parser.py
+python src/train_biencoder.py
+python src/build_index.py
+```
+
+### 4) Создание ассистента
+
+```bash
+python site/backend/assistant/assistant_create.py
+```
+
+### 5) Запуск веб‑приложения
+
+```bash
+uvicorn app:app --app-dir site/backend --host 0.0.0.0 --port 8000
+```
+
+Открыть в браузере: `http://localhost:8000`.
+
+## Запуск через Docker
+
+```bash
+docker compose up --build
+```
+
+`docker-compose.yml` берет переменные из `site/backend/.env` и прокидывает порт `8000`.
+
+## CLI‑демо (без веб‑UI)
+
+- Локальный retrieval без ассистента:
+  ```bash
+  python src/demo_cli.py
+  ```
+- Чат через ассистента (CLI):
+  ```bash
+  python site/backend/assistant/demo_assistant.py
+  ```
+
+## Оценка качества
+
+```bash
+python src/validate.py
+python src/evaluate.py
+python src/plot_eval.py
+```
+
+Результаты: `artifacts/reports/` и `artifacts/reports/figures/`.
+
+## Типичные ошибки
+
+- **Assistant id not found** → запустить `assistant_create.py` или задать `ASSISTANT_ID`.
+- **Index file not found** → собрать индексы через `src/build_index.py`.
+- **Fine‑tuned model directory not found** → обучить `src/train_biencoder.py` либо собрать индексы на базовой модели.
+- **Azure credentials missing** → проверить `.env` или переменные окружения.
+
+## Ограничения
+
+- Ассистент не заменяет юридическую консультацию; ответы ограничены **подключенным корпусом**.
+- Качество ответа зависит от релевантности retrieval‑результатов и качества корпуса.
+
+## Как заменить корпус на другой
+
+1. Подготовить новый JSONL корпус в формате, совместимом с `src/data_io.py` (id/text/метаданные).
+2. Обновить парсер/ETL (или загрузчик) для новых источников.
+3. Переобучить bi‑encoder (`src/train_biencoder.py`) на новых парах «запрос → норма».
+4. Пересобрать индексы (`src/build_index.py`) и перезапустить backend.

artifacts/indexes/built_indexes.json

@@ -0,0 +1,17 @@
+[
+  {
+    "alias": "mpnet_base",
+    "dir": "artifacts\\indexes\\mpnet_base",
+    "model": "paraphrase-multilingual-mpnet-base-v2"
+  },
+  {
+    "alias": "labse",
+    "dir": "artifacts\\indexes\\labse",
+    "model": "sentence-transformers/LaBSE"
+  },
+  {
+    "alias": "finetuned",
+    "dir": "artifacts\\indexes\\finetuned",
+    "model": "artifacts\\models\\finetuned_mpnet"
+  }
+]

artifacts/indexes/finetuned/index_info.json

@@ -0,0 +1,9 @@
+{
+  "model": "artifacts\\models\\finetuned_mpnet",
+  "ru_count": 477,
+  "kz_count": 477,
+  "ru_index": "artifacts\\indexes\\finetuned\\ru.faiss",
+  "kz_index": "artifacts\\indexes\\finetuned\\kz.faiss",
+  "ru_meta": "artifacts\\indexes\\finetuned\\ru_meta.jsonl",
+  "kz_meta": "artifacts\\indexes\\finetuned\\kz_meta.jsonl"
+}

artifacts/indexes/finetuned/kz.faiss

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:07595bb4b692868ff05892a3bfdafff84177e8eb5a67294f839e04a6113ad7a1
+size 1465389

artifacts/indexes/finetuned/ru.faiss

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:40298ee1871f677c03db354f646e211bba793381931ddaf649e4a9ddcecf29d9
+size 1465389

artifacts/indexes/labse/index_info.json

@@ -0,0 +1,9 @@
+{
+  "model": "sentence-transformers/LaBSE",
+  "ru_count": 477,
+  "kz_count": 477,
+  "ru_index": "artifacts\\indexes\\labse\\ru.faiss",
+  "kz_index": "artifacts\\indexes\\labse\\kz.faiss",
+  "ru_meta": "artifacts\\indexes\\labse\\ru_meta.jsonl",
+  "kz_meta": "artifacts\\indexes\\labse\\kz_meta.jsonl"
+}

artifacts/indexes/labse/kz.faiss

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:9b0a43d2348b26967d3c5e94305e3cd8ea84e6c9aefdaa30c28260c5c92b7358
+size 1465389

artifacts/indexes/labse/ru.faiss

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:994a58d5d39704134a728ebd671355924af27abf94e79ce8052000afc5b45185
+size 1465389

artifacts/indexes/mpnet_base/index_info.json

@@ -0,0 +1,9 @@
+{
+  "model": "paraphrase-multilingual-mpnet-base-v2",
+  "ru_count": 477,
+  "kz_count": 477,
+  "ru_index": "artifacts\\indexes\\mpnet_base\\ru.faiss",
+  "kz_index": "artifacts\\indexes\\mpnet_base\\kz.faiss",
+  "ru_meta": "artifacts\\indexes\\mpnet_base\\ru_meta.jsonl",
+  "kz_meta": "artifacts\\indexes\\mpnet_base\\kz_meta.jsonl"
+}

artifacts/indexes/mpnet_base/kz.faiss

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6366f23f678651e6efb9c3d8a0f17af7af4909426d53992bc21602d6f6e4149b
+size 1465389

artifacts/indexes/mpnet_base/ru.faiss

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a4cb2d5749aa8a45a82a769b1bc583330d62cb63127d9aa51ded579d8cd7913e
+size 1465389

artifacts/models/finetuned_mpnet/1_Pooling/config.json

@@ -0,0 +1,10 @@
+{
+    "word_embedding_dimension": 768,
+    "pooling_mode_cls_token": false,
+    "pooling_mode_mean_tokens": true,
+    "pooling_mode_max_tokens": false,
+    "pooling_mode_mean_sqrt_len_tokens": false,
+    "pooling_mode_weightedmean_tokens": false,
+    "pooling_mode_lasttoken": false,
+    "include_prompt": true
+}

artifacts/models/finetuned_mpnet/README.md

@@ -0,0 +1,491 @@
+---
+tags:
+- sentence-transformers
+- sentence-similarity
+- feature-extraction
+- dense
+- generated_from_trainer
+- dataset_size:3786
+- loss:MultipleNegativesRankingLoss
+base_model: sentence-transformers/paraphrase-multilingual-mpnet-base-v2
+widget:
+- source_sentence: 'Статья 23: о чём 2 пункт?'
+  sentences:
+  - 2. Заңда көзделген реттерде ғана және тек қана соттың санкциясымен тұтқындауға
+    және қамауда ұстауға болады, тұтқындалған адамға шағымдану құқығы беріледі. Соттың
+    санкциясынсыз адамды жетпіс екі сағаттан аспайтын мерзімге ұстауға болады.
+  - 2. Председатели и судьи Конституционного Суда, Верховного Суда и иных судов, председатели
+    и члены Центральной избирательной комиссии, Высшей аудиторской палаты Республики,
+    военнослужащие, работники органов национальной безопасности, правоохранительных
+    органов не должны состоять в политических партиях, профессиональных союзах, выступать
+    в поддержку какой-либо политической партии.
+  - 4. Должность судьи Конституционного Суда несовместима с депутатским мандатом,
+    занятием иных оплачиваемых должностей, кроме преподавательской, научной или иной
+    творческой деятельности, осуществлением предпринимательской деятельности, вхождением
+    в состав руководящего органа или наблюдательного совета коммерческой организации.
+- source_sentence: Можно ли лишать гражданства по Конституции РК?
+  sentences:
+  - '2. К ведению местных исполнительных органов относится:'
+  - 6) сот құрылысы мен сотта іс жүргізу мәселелеріне;
+  - 2. Собственность обязывает, пользование ею должно одновременно служить общественному
+    благу. Субъекты и объекты собственности, объем и пределы осуществления собственниками
+    своих прав, гарантии их защиты определяются законом.
+- source_sentence: конституцияда туралы қысқаша түсіндір.
+  sentences:
+  - 4. Организация и деятельность Парламента, правовое положение его депутатов определяются
+    конституционным законом.
+  - 3. На период осуществления своих полномочий Президент Республики Казахстан не
+    должен состоять в политической партии.
+  - 4. Конституциялық заңдар Конституцияда көзделген мәселелер бойынша әр Палата депутаттарының
+    жалпы санының кемінде үштен екісінің көпшілік даусымен қабылданады.
+- source_sentence: Конституциядан субъектілері туралы тармақты тауып берші.
+  sentences:
+  - 2. Меншік міндет жүктейді, оны пайдалану сонымен қатар қоғам игілігіне де қызмет
+    етуге тиіс. Меншік субъектілері мен объектілері, меншік иелерінің өз құқықтарын
+    жүзеге асыру көлемі мен шектері, оларды қорғау кепілдіктері заңмен белгіленеді.
+  - '2. Основополагающими принципами деятельности Республики являются: общественное
+    согласие и политическая стабильность, экономическое развитие на благо всего народа,
+    казахстанский патриотизм, решение наиболее важных вопросов государственной жизни
+    демократическими методами, включая голосование на республиканском референдуме
+    или в Парламенте.'
+  - 2) Үкімет пен Жоғары аудиторлық палатаның республикалық бюджеттің атқарылуы туралы
+    есептерін бекітеді. Үкіметтің республикалық бюджеттің атқарылуы туралы есебін
+    Парламенттің бекітпеуі Парламенттің Үкіметке сенімсіздік білдіргенін көрсетеді;
+- source_sentence: Разрешается ли получать информацию по Конституции?
+  sentences:
+  - 2. Ешкімді азаптауға, оған зорлық-зомбылық жасауға, басқадай қатыгездік немесе
+    адамдық қадір-қасиетін қорлайтындай жәбір көрсетуге не жазалауға болмайды.
+  - Граждане Республики Казахстан обязаны сохранять природу и бережно относиться к
+    природным богатствам.
+  - 3. Генеральный Прокурор Республики в течение срока своих полномочий не может быть
+    арестован, подвергнут приводу, мерам административного взыскания, налагаемым в
+    судебном порядке, привлечен к уголовной ответственности без согласия Сената, кроме
+    случаев задержания на месте преступления или совершения тяжких преступлений. Срок
+    полномочий Генерального Прокурора пять лет.
+pipeline_tag: sentence-similarity
+library_name: sentence-transformers
+metrics:
+- cosine_accuracy@1
+- cosine_accuracy@3
+- cosine_accuracy@5
+- cosine_accuracy@10
+- cosine_precision@1
+- cosine_precision@3
+- cosine_precision@5
+- cosine_precision@10
+- cosine_recall@1
+- cosine_recall@3
+- cosine_recall@5
+- cosine_recall@10
+- cosine_ndcg@10
+- cosine_mrr@10
+- cosine_map@100
+model-index:
+- name: SentenceTransformer based on sentence-transformers/paraphrase-multilingual-mpnet-base-v2
+  results:
+  - task:
+      type: information-retrieval
+      name: Information Retrieval
+    dataset:
+      name: overall
+      type: overall
+    metrics:
+    - type: cosine_accuracy@1
+      value: 0.08726752503576538
+      name: Cosine Accuracy@1
+    - type: cosine_accuracy@3
+      value: 0.1459227467811159
+      name: Cosine Accuracy@3
+    - type: cosine_accuracy@5
+      value: 0.20028612303290416
+      name: Cosine Accuracy@5
+    - type: cosine_accuracy@10
+      value: 0.2761087267525036
+      name: Cosine Accuracy@10
+    - type: cosine_precision@1
+      value: 0.08726752503576538
+      name: Cosine Precision@1
+    - type: cosine_precision@3
+      value: 0.04864091559370529
+      name: Cosine Precision@3
+    - type: cosine_precision@5
+      value: 0.04005722460658083
+      name: Cosine Precision@5
+    - type: cosine_precision@10
+      value: 0.027610872675250364
+      name: Cosine Precision@10
+    - type: cosine_recall@1
+      value: 0.08726752503576538
+      name: Cosine Recall@1
+    - type: cosine_recall@3
+      value: 0.1459227467811159
+      name: Cosine Recall@3
+    - type: cosine_recall@5
+      value: 0.20028612303290416
+      name: Cosine Recall@5
+    - type: cosine_recall@10
+      value: 0.2761087267525036
+      name: Cosine Recall@10
+    - type: cosine_ndcg@10
+      value: 0.16702919619498105
+      name: Cosine Ndcg@10
+    - type: cosine_mrr@10
+      value: 0.13391579807888812
+      name: Cosine Mrr@10
+    - type: cosine_map@100
+      value: 0.14754280906508177
+      name: Cosine Map@100
+---
+
+# SentenceTransformer based on sentence-transformers/paraphrase-multilingual-mpnet-base-v2
+
+This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [sentence-transformers/paraphrase-multilingual-mpnet-base-v2](https://huggingface.co/sentence-transformers/paraphrase-multilingual-mpnet-base-v2). It maps sentences & paragraphs to a 768-dimensional dense vector space and can be used for semantic textual similarity, semantic search, paraphrase mining, text classification, clustering, and more.
+
+## Model Details
+
+### Model Description
+- **Model Type:** Sentence Transformer
+- **Base model:** [sentence-transformers/paraphrase-multilingual-mpnet-base-v2](https://huggingface.co/sentence-transformers/paraphrase-multilingual-mpnet-base-v2) <!-- at revision 4328cf26390c98c5e3c738b4460a05b95f4911f5 -->
+- **Maximum Sequence Length:** 128 tokens
+- **Output Dimensionality:** 768 dimensions
+- **Similarity Function:** Cosine Similarity
+<!-- - **Training Dataset:** Unknown -->
+<!-- - **Language:** Unknown -->
+<!-- - **License:** Unknown -->
+
+### Model Sources
+
+- **Documentation:** [Sentence Transformers Documentation](https://sbert.net)
+- **Repository:** [Sentence Transformers on GitHub](https://github.com/huggingface/sentence-transformers)
+- **Hugging Face:** [Sentence Transformers on Hugging Face](https://huggingface.co/models?library=sentence-transformers)
+
+### Full Model Architecture
+
+```
+SentenceTransformer(
+  (0): Transformer({'max_seq_length': 128, 'do_lower_case': False, 'architecture': 'XLMRobertaModel'})
+  (1): Pooling({'word_embedding_dimension': 768, 'pooling_mode_cls_token': False, 'pooling_mode_mean_tokens': True, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False, 'pooling_mode_weightedmean_tokens': False, 'pooling_mode_lasttoken': False, 'include_prompt': True})
+)
+```
+
+## Usage
+
+### Direct Usage (Sentence Transformers)
+
+First install the Sentence Transformers library:
+
+```bash
+pip install -U sentence-transformers
+```
+
+Then you can load this model and run inference.
+```python
+from sentence_transformers import SentenceTransformer
+
+# Download from the 🤗 Hub
+model = SentenceTransformer("sentence_transformers_model_id")
+# Run inference
+sentences = [
+    'Разрешается ли получать информацию по Конституции?',
+    'Граждане Республики Казахстан обязаны сохранять природу и бережно относиться к природным богатствам.',
+    '2. Ешкімді азаптауға, оған зорлық-зомбылық жасауға, басқадай қатыгездік немесе адамдық қадір-қасиетін қорлайтындай жәбір көрсетуге не жазалауға болмайды.',
+]
+embeddings = model.encode(sentences)
+print(embeddings.shape)
+# [3, 768]
+
+# Get the similarity scores for the embeddings
+similarities = model.similarity(embeddings, embeddings)
+print(similarities)
+# tensor([[1.0000, 0.3876, 0.0974],
+#         [0.3876, 1.0000, 0.2255],
+#         [0.0974, 0.2255, 1.0000]])
+```
+
+<!--
+### Direct Usage (Transformers)
+
+<details><summary>Click to see the direct usage in Transformers</summary>
+
+</details>
+-->
+
+<!--
+### Downstream Usage (Sentence Transformers)
+
+You can finetune this model on your own dataset.
+
+<details><summary>Click to expand</summary>
+
+</details>
+-->
+
+<!--
+### Out-of-Scope Use
+
+*List how the model may foreseeably be misused and address what users ought not to do with the model.*
+-->
+
+## Evaluation
+
+### Metrics
+
+#### Information Retrieval
+
+* Dataset: `overall`
+* Evaluated with [<code>InformationRetrievalEvaluator</code>](https://sbert.net/docs/package_reference/sentence_transformer/evaluation.html#sentence_transformers.evaluation.InformationRetrievalEvaluator)
+
+| Metric              | Value     |
+|:--------------------|:----------|
+| cosine_accuracy@1   | 0.0873    |
+| cosine_accuracy@3   | 0.1459    |
+| cosine_accuracy@5   | 0.2003    |
+| cosine_accuracy@10  | 0.2761    |
+| cosine_precision@1  | 0.0873    |
+| cosine_precision@3  | 0.0486    |
+| cosine_precision@5  | 0.0401    |
+| cosine_precision@10 | 0.0276    |
+| cosine_recall@1     | 0.0873    |
+| cosine_recall@3     | 0.1459    |
+| cosine_recall@5     | 0.2003    |
+| cosine_recall@10    | 0.2761    |
+| **cosine_ndcg@10**  | **0.167** |
+| cosine_mrr@10       | 0.1339    |
+| cosine_map@100      | 0.1475    |
+
+<!--
+## Bias, Risks and Limitations
+
+*What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
+-->
+
+<!--
+### Recommendations
+
+*What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
+-->
+
+## Training Details
+
+### Training Dataset
+
+#### Unnamed Dataset
+
+* Size: 3,786 training samples
+* Columns: <code>sentence_0</code> and <code>sentence_1</code>
+* Approximate statistics based on the first 1000 samples:
+  |         | sentence_0                                                                        | sentence_1                                                                         |
+  |:--------|:----------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------|
+  | type    | string                                                                            | string                                                                             |
+  | details | <ul><li>min: 8 tokens</li><li>mean: 12.16 tokens</li><li>max: 22 tokens</li></ul> | <ul><li>min: 6 tokens</li><li>mean: 39.79 tokens</li><li>max: 128 tokens</li></ul> |
+* Samples:
+  | sentence_0                                                       | sentence_1                                                                                                                                                                                 |
+  |:-----------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+  | <code>10-баптың 3-тармағы нені білдіреді?</code>                 | <code>3. Республика азаматының басқа мемлекеттің азаматтығында болуы танылмайды.</code>                                                                                                    |
+  | <code>мыналар бойынша құқықтар мен міндеттер қандай?</code>      | <code>1. Мәжілістің ерекше қарауына мыналар жатады:</code>                                                                                                                                 |
+  | <code>Разъясни, что значит исполнительными в Конституции.</code> | <code>Местное государственное управление осуществляется местными представительными и исполнительными органами, которые ответственны за состояние дел на соответствующей территории.</code> |
+* Loss: [<code>MultipleNegativesRankingLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#multiplenegativesrankingloss) with these parameters:
+  ```json
+  {
+      "scale": 20.0,
+      "similarity_fct": "cos_sim",
+      "gather_across_devices": false
+  }
+  ```
+
+### Training Hyperparameters
+#### Non-Default Hyperparameters
+
+- `eval_strategy`: steps
+- `per_device_train_batch_size`: 32
+- `per_device_eval_batch_size`: 32
+- `num_train_epochs`: 2
+- `multi_dataset_batch_sampler`: round_robin
+
+#### All Hyperparameters
+<details><summary>Click to expand</summary>
+
+- `overwrite_output_dir`: False
+- `do_predict`: False
+- `eval_strategy`: steps
+- `prediction_loss_only`: True
+- `per_device_train_batch_size`: 32
+- `per_device_eval_batch_size`: 32
+- `per_gpu_train_batch_size`: None
+- `per_gpu_eval_batch_size`: None
+- `gradient_accumulation_steps`: 1
+- `eval_accumulation_steps`: None
+- `torch_empty_cache_steps`: None
+- `learning_rate`: 5e-05
+- `weight_decay`: 0.0
+- `adam_beta1`: 0.9
+- `adam_beta2`: 0.999
+- `adam_epsilon`: 1e-08
+- `max_grad_norm`: 1
+- `num_train_epochs`: 2
+- `max_steps`: -1
+- `lr_scheduler_type`: linear
+- `lr_scheduler_kwargs`: None
+- `warmup_ratio`: 0.0
+- `warmup_steps`: 0
+- `log_level`: passive
+- `log_level_replica`: warning
+- `log_on_each_node`: True
+- `logging_nan_inf_filter`: True
+- `save_safetensors`: True
+- `save_on_each_node`: False
+- `save_only_model`: False
+- `restore_callback_states_from_checkpoint`: False
+- `no_cuda`: False
+- `use_cpu`: False
+- `use_mps_device`: False
+- `seed`: 42
+- `data_seed`: None
+- `jit_mode_eval`: False
+- `bf16`: False
+- `fp16`: False
+- `fp16_opt_level`: O1
+- `half_precision_backend`: auto
+- `bf16_full_eval`: False
+- `fp16_full_eval`: False
+- `tf32`: None
+- `local_rank`: 0
+- `ddp_backend`: None
+- `tpu_num_cores`: None
+- `tpu_metrics_debug`: False
+- `debug`: []
+- `dataloader_drop_last`: False
+- `dataloader_num_workers`: 0
+- `dataloader_prefetch_factor`: None
+- `past_index`: -1
+- `disable_tqdm`: False
+- `remove_unused_columns`: True
+- `label_names`: None
+- `load_best_model_at_end`: False
+- `ignore_data_skip`: False
+- `fsdp`: []
+- `fsdp_min_num_params`: 0
+- `fsdp_config`: {'min_num_params': 0, 'xla': False, 'xla_fsdp_v2': False, 'xla_fsdp_grad_ckpt': False}
+- `fsdp_transformer_layer_cls_to_wrap`: None
+- `accelerator_config`: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': None}
+- `parallelism_config`: None
+- `deepspeed`: None
+- `label_smoothing_factor`: 0.0
+- `optim`: adamw_torch
+- `optim_args`: None
+- `adafactor`: False
+- `group_by_length`: False
+- `length_column_name`: length
+- `project`: huggingface
+- `trackio_space_id`: trackio
+- `ddp_find_unused_parameters`: None
+- `ddp_bucket_cap_mb`: None
+- `ddp_broadcast_buffers`: False
+- `dataloader_pin_memory`: True
+- `dataloader_persistent_workers`: False
+- `skip_memory_metrics`: True
+- `use_legacy_prediction_loop`: False
+- `push_to_hub`: False
+- `resume_from_checkpoint`: None
+- `hub_model_id`: None
+- `hub_strategy`: every_save
+- `hub_private_repo`: None
+- `hub_always_push`: False
+- `hub_revision`: None
+- `gradient_checkpointing`: False
+- `gradient_checkpointing_kwargs`: None
+- `include_inputs_for_metrics`: False
+- `include_for_metrics`: []
+- `eval_do_concat_batches`: True
+- `fp16_backend`: auto
+- `push_to_hub_model_id`: None
+- `push_to_hub_organization`: None
+- `mp_parameters`: 
+- `auto_find_batch_size`: False
+- `full_determinism`: False
+- `torchdynamo`: None
+- `ray_scope`: last
+- `ddp_timeout`: 1800
+- `torch_compile`: False
+- `torch_compile_backend`: None
+- `torch_compile_mode`: None
+- `include_tokens_per_second`: False
+- `include_num_input_tokens_seen`: no
+- `neftune_noise_alpha`: None
+- `optim_target_modules`: None
+- `batch_eval_metrics`: False
+- `eval_on_start`: False
+- `use_liger_kernel`: False
+- `liger_kernel_config`: None
+- `eval_use_gather_object`: False
+- `average_tokens_across_devices`: True
+- `prompts`: None
+- `batch_sampler`: batch_sampler
+- `multi_dataset_batch_sampler`: round_robin
+- `router_mapping`: {}
+- `learning_rate_mapping`: {}
+
+</details>
+
+### Training Logs
+| Epoch | Step | overall_cosine_ndcg@10 |
+|:-----:|:----:|:----------------------:|
+| 1.0   | 119  | 0.1502                 |
+| 2.0   | 238  | 0.1670                 |
+
+
+### Framework Versions
+- Python: 3.11.0
+- Sentence Transformers: 5.2.0
+- Transformers: 4.57.5
+- PyTorch: 2.5.1+cu121
+- Accelerate: 1.12.0
+- Datasets: 4.4.2
+- Tokenizers: 0.22.2
+
+## Citation
+
+### BibTeX
+
+#### Sentence Transformers
+```bibtex
+@inproceedings{reimers-2019-sentence-bert,
+    title = "Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks",
+    author = "Reimers, Nils and Gurevych, Iryna",
+    booktitle = "Proceedings of the 2019 Conference on Empirical Methods in Natural Language Processing",
+    month = "11",
+    year = "2019",
+    publisher = "Association for Computational Linguistics",
+    url = "https://arxiv.org/abs/1908.10084",
+}
+```
+
+#### MultipleNegativesRankingLoss
+```bibtex
+@misc{henderson2017efficient,
+    title={Efficient Natural Language Response Suggestion for Smart Reply},
+    author={Matthew Henderson and Rami Al-Rfou and Brian Strope and Yun-hsuan Sung and Laszlo Lukacs and Ruiqi Guo and Sanjiv Kumar and Balint Miklos and Ray Kurzweil},
+    year={2017},
+    eprint={1705.00652},
+    archivePrefix={arXiv},
+    primaryClass={cs.CL}
+}
+```
+
+<!--
+## Glossary
+
+*Clearly define terms in order to be accessible across audiences.*
+-->
+
+<!--
+## Model Card Authors
+
+*Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
+-->
+
+<!--
+## Model Card Contact
+
+*Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
+-->

artifacts/models/finetuned_mpnet/config.json

@@ -0,0 +1,28 @@
+{
+  "architectures": [
+    "XLMRobertaModel"
+  ],
+  "attention_probs_dropout_prob": 0.1,
+  "bos_token_id": 0,
+  "classifier_dropout": null,
+  "dtype": "float32",
+  "eos_token_id": 2,
+  "gradient_checkpointing": false,
+  "hidden_act": "gelu",
+  "hidden_dropout_prob": 0.1,
+  "hidden_size": 768,
+  "initializer_range": 0.02,
+  "intermediate_size": 3072,
+  "layer_norm_eps": 1e-05,
+  "max_position_embeddings": 514,
+  "model_type": "xlm-roberta",
+  "num_attention_heads": 12,
+  "num_hidden_layers": 12,
+  "output_past": true,
+  "pad_token_id": 1,
+  "position_embedding_type": "absolute",
+  "transformers_version": "4.57.5",
+  "type_vocab_size": 1,
+  "use_cache": true,
+  "vocab_size": 250002
+}

artifacts/models/finetuned_mpnet/config_sentence_transformers.json

@@ -0,0 +1,14 @@
+{
+  "__version__": {
+    "sentence_transformers": "5.2.0",
+    "transformers": "4.57.5",
+    "pytorch": "2.5.1+cu121"
+  },
+  "model_type": "SentenceTransformer",
+  "prompts": {
+    "query": "",
+    "document": ""
+  },
+  "default_prompt_name": null,
+  "similarity_fn_name": "cosine"
+}

artifacts/models/finetuned_mpnet/eval/Information-Retrieval_evaluation_overall_results.csv

@@ -0,0 +1,3 @@
+epoch,steps,cosine-Accuracy@1,cosine-Accuracy@3,cosine-Accuracy@5,cosine-Accuracy@10,cosine-Precision@1,cosine-Recall@1,cosine-Precision@3,cosine-Recall@3,cosine-Precision@5,cosine-Recall@5,cosine-Precision@10,cosine-Recall@10,cosine-MRR@10,cosine-NDCG@10,cosine-MAP@100
+1.0,119,0.0815450643776824,0.13447782546494993,0.1688125894134478,0.2474964234620887,0.0815450643776824,0.0815450643776824,0.04482594182164997,0.13447782546494993,0.03376251788268956,0.1688125894134478,0.024749642346208876,0.2474964234620887,0.12093750709630546,0.1502270526236107,0.13292717270259066
+2.0,238,0.08726752503576538,0.1459227467811159,0.20028612303290416,0.2761087267525036,0.08726752503576538,0.08726752503576538,0.04864091559370529,0.1459227467811159,0.04005722460658083,0.20028612303290416,0.027610872675250364,0.2761087267525036,0.13391579807888812,0.16702919619498105,0.14754280906508177

artifacts/models/finetuned_mpnet/model.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:e532d918503434313ea6e134688501f890213461b59f2578b59bb0e78e6ef440
+size 1112197096

artifacts/models/finetuned_mpnet/modules.json

@@ -0,0 +1,14 @@
+[
+  {
+    "idx": 0,
+    "name": "0",
+    "path": "",
+    "type": "sentence_transformers.models.Transformer"
+  },
+  {
+    "idx": 1,
+    "name": "1",
+    "path": "1_Pooling",
+    "type": "sentence_transformers.models.Pooling"
+  }
+]

artifacts/models/finetuned_mpnet/sentence_bert_config.json

@@ -0,0 +1,4 @@
+{
+    "max_seq_length": 128,
+    "do_lower_case": false
+}

artifacts/models/finetuned_mpnet/special_tokens_map.json

@@ -0,0 +1,51 @@
+{
+  "bos_token": {
+    "content": "<s>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "cls_token": {
+    "content": "<s>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "eos_token": {
+    "content": "</s>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "mask_token": {
+    "content": "<mask>",
+    "lstrip": true,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "pad_token": {
+    "content": "<pad>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "sep_token": {
+    "content": "</s>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "unk_token": {
+    "content": "<unk>",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  }
+}

artifacts/models/finetuned_mpnet/tokenizer.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:cad551d5600a84242d0973327029452a1e3672ba6313c2a3c3d69c4310e12719
+size 17082987

artifacts/models/finetuned_mpnet/tokenizer_config.json

@@ -0,0 +1,62 @@
+{
+  "added_tokens_decoder": {
+    "0": {
+      "content": "<s>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "1": {
+      "content": "<pad>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "2": {
+      "content": "</s>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "3": {
+      "content": "<unk>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "250001": {
+      "content": "<mask>",
+      "lstrip": true,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    }
+  },
+  "bos_token": "<s>",
+  "clean_up_tokenization_spaces": false,
+  "cls_token": "<s>",
+  "eos_token": "</s>",
+  "extra_special_tokens": {},
+  "mask_token": "<mask>",
+  "max_length": 128,
+  "model_max_length": 128,
+  "pad_to_multiple_of": null,
+  "pad_token": "<pad>",
+  "pad_token_type_id": 0,
+  "padding_side": "right",
+  "sep_token": "</s>",
+  "stride": 0,
+  "tokenizer_class": "XLMRobertaTokenizer",
+  "truncation_side": "right",
+  "truncation_strategy": "longest_first",
+  "unk_token": "<unk>"
+}

artifacts/reports/data_validation.json

@@ -0,0 +1,12 @@
+{
+  "clauses_ru": 477,
+  "clauses_kz": 477,
+  "train_pairs": 3786,
+  "test_pairs": 699,
+  "leakage_ids_count": 0,
+  "missing_train_positive_ids_count": 0,
+  "missing_test_positive_ids_count": 0,
+  "leakage_sample": [],
+  "missing_train_sample": [],
+  "missing_test_sample": []
+}

artifacts/reports/eval_finetuned.json

@@ -0,0 +1,35 @@
+{
+  "model": "artifacts\\models\\finetuned_mpnet",
+  "index_alias": "finetuned",
+  "test_path": "data/legal_assistant_test.jsonl",
+  "top_k": 10,
+  "by_lang": {
+    "ru": {
+      "count": 350,
+      "recall@1": 0.10571428571428572,
+      "recall@3": 0.22285714285714286,
+      "recall@5": 0.26285714285714284,
+      "recall@10": 0.37714285714285717,
+      "mrr@10": 0.18037074829931973,
+      "ndcg@10": 0.22650353102998314
+    },
+    "kz": {
+      "count": 349,
+      "recall@1": 0.09455587392550144,
+      "recall@3": 0.17478510028653296,
+      "recall@5": 0.24068767908309455,
+      "recall@10": 0.332378223495702,
+      "mrr@10": 0.15567380724973848,
+      "ndcg@10": 0.197008647971075
+    }
+  },
+  "overall": {
+    "count": 699,
+    "recall@1": 0.10014306151645208,
+    "recall@3": 0.1988555078683834,
+    "recall@5": 0.25178826895565093,
+    "recall@10": 0.3547925608011445,
+    "mrr@10": 0.16803994368372052,
+    "ndcg@10": 0.211777187414019
+  }
+}

artifacts/reports/eval_labse.json

@@ -0,0 +1,35 @@
+{
+  "model": "sentence-transformers/LaBSE",
+  "index_alias": "labse",
+  "test_path": "data/legal_assistant_test.jsonl",
+  "top_k": 10,
+  "by_lang": {
+    "ru": {
+      "count": 350,
+      "recall@1": 0.02,
+      "recall@3": 0.037142857142857144,
+      "recall@5": 0.04857142857142857,
+      "recall@10": 0.08,
+      "mrr@10": 0.03408956916099773,
+      "ndcg@10": 0.04460771269739186
+    },
+    "kz": {
+      "count": 349,
+      "recall@1": 0.02005730659025788,
+      "recall@3": 0.04011461318051576,
+      "recall@5": 0.07163323782234957,
+      "recall@10": 0.10888252148997135,
+      "mrr@10": 0.04037272024378041,
+      "ndcg@10": 0.056200182864673286
+    }
+  },
+  "overall": {
+    "count": 699,
+    "recall@1": 0.020028612303290415,
+    "recall@3": 0.03862660944206009,
+    "recall@5": 0.060085836909871244,
+    "recall@10": 0.0944206008583691,
+    "mrr@10": 0.037226650316779075,
+    "ndcg@10": 0.050395655599224785
+  }
+}

artifacts/reports/eval_mpnet_base.json

@@ -0,0 +1,35 @@
+{
+  "model": "paraphrase-multilingual-mpnet-base-v2",
+  "index_alias": "mpnet_base",
+  "test_path": "data/legal_assistant_test.jsonl",
+  "top_k": 10,
+  "by_lang": {
+    "ru": {
+      "count": 350,
+      "recall@1": 0.02,
+      "recall@3": 0.045714285714285714,
+      "recall@5": 0.06285714285714286,
+      "recall@10": 0.07428571428571429,
+      "mrr@10": 0.036646258503401356,
+      "ndcg@10": 0.04574054788125284
+    },
+    "kz": {
+      "count": 349,
+      "recall@1": 0.025787965616045846,
+      "recall@3": 0.034383954154727794,
+      "recall@5": 0.05730659025787966,
+      "recall@10": 0.09455587392550144,
+      "mrr@10": 0.03985309501068813,
+      "ndcg@10": 0.05243901062215754
+    }
+  },
+  "overall": {
+    "count": 699,
+    "recall@1": 0.022889842632331903,
+    "recall@3": 0.04005722460658083,
+    "recall@5": 0.060085836909871244,
+    "recall@10": 0.0844062947067239,
+    "mrr@10": 0.038247382882576016,
+    "ndcg@10": 0.049084987790517134
+  }
+}

artifacts/reports/figures_summary.json

@@ -0,0 +1,21 @@
+{
+  "loaded_reports": [
+    "eval_finetuned.json",
+    "eval_labse.json",
+    "eval_mpnet_base.json"
+  ],
+  "figures": [
+    "rank_metrics_kz.png",
+    "rank_metrics_overall.png",
+    "rank_metrics_ru.png",
+    "recall_curve_kz.png",
+    "recall_curve_overall.png",
+    "recall_curve_ru.png",
+    "recall_kz.png",
+    "recall_overall.png",
+    "recall_ru.png",
+    "relative_improvement_kz.png",
+    "relative_improvement_overall.png",
+    "relative_improvement_ru.png"
+  ]
+}

check_base_model.py

@@ -0,0 +1,6 @@
+from sentence_transformers import SentenceTransformer
+
+m = SentenceTransformer("paraphrase-multilingual-mpnet-base-v2")
+print("model_type:", m[0].auto_model.config.model_type)
+print("class:", m[0].auto_model.__class__.__name__)
+print("name_or_path:", m[0].auto_model.name_or_path)

check_device.py

@@ -0,0 +1,25 @@
+import torch
+from sentence_transformers import SentenceTransformer
+
+def main():
+    cuda_available = torch.cuda.is_available()
+    print("torch.cuda.is_available:", cuda_available)
+
+    if cuda_available:
+        print("cuda device count:", torch.cuda.device_count())
+        for i in range(torch.cuda.device_count()):
+            print(f"cuda:{i} name:", torch.cuda.get_device_name(i))
+        print("torch version:", torch.__version__)
+        print("cuda version:", torch.version.cuda)
+        device = "cuda"
+    else:
+        device = "cpu"
+
+    model = SentenceTransformer("paraphrase-multilingual-mpnet-base-v2", device=device)
+    print("sentence-transformers device:", model.device)
+
+    x = model.encode(["тест"], convert_to_numpy=True)
+    print("encode ok, shape:", x.shape)
+
+if __name__ == "__main__":
+    main()