Update README.md

README.md

@@ -1,5 +1,9 @@
 ---
 license: mit
+language:
+- en
+- pl
+- ru
 tags:
 - math
 - algebra
@@ -7,53 +11,124 @@ tags:
 - pytorch
 - onnx
 - safetensors
+- gguf
 - rnn
 - gru
 pipeline_tag: feature-extraction
 ---
 
-# 🤖 Stupi-Equation-Solver (1st–4th Degree)
+# 🤖 Stupi-Equation-Solver (1st–4th Degree Polynomials)
 
-Нейросетевой решатель алгебраических уравнений степеней от 1 до 4 (полных и неполных) по сырому тексту.
+[English](#-english) | [Polski](#-polski) | [Русский](#-русский)
 
-Модель обучена извлекать действительные корни полиномов из чистого символьного текста (включая квадратные корни, деление, смену знаков и формулу Кардано).
+---
+
+## 🇬🇧 English
+
+### Description
+A lightweight neural network designed to solve algebraic polynomial equations from **1st to 4th degree** (both complete and incomplete) directly from raw character text.
+
+The model infers real roots without any external CAS/symbolic algebra engines—it learns polynomial factorization, discriminant calculation, sign switching, and roots extraction directly from ASCII strings.
+
+### 📊 Architecture & Training
+* **Model Architecture:** 2-layer Bidirectional GRU (BiGRU) + Deep MLP regression head
+* **Parameters:** `embed_dim=64`, `hidden_dim=384`, `max_roots=4`
+* **Dataset:** Trained on over **1,000,000 synthetic equations** (random variable names $x, y, a, t, z...$, non-monic scales from -6 to +12, roots range $[-20, 20]$)
+* **Hardware Acceleration:** **Intel Arc A770 (16GB GDDR6)** on **Arch Linux** via PyTorch XPU (oneAPI / Level Zero backend)
+* **Loss Function:** Custom Masked MSE Loss (penalizes only valid real roots, masking out padding slots)
+
+### 🎯 Benchmark Results (100 Unseen Test Equations)
+* **Degree 1 (Linear):** MAE ≈ **0.33**
+* **Degree 2 (Quadratic):** MAE ≈ **0.27** *(Accurate on full quadratics and irrationals, e.g. $1 - \sqrt{2} \approx -0.41$)*
+* **Degree 3 (Cubic):** MAE ≈ **0.60**
+* **Degree 4 (Quartic):** MAE ≈ **1.17**
+* **Overall Mean Absolute Error (MAE):** **~0.69 – 0.75**
+
+---
+
+## 🇵🇱 Polski
+
+### Opis
+Neuronowy solver równań algebraicznych wielomianowych od **1. do 4. stopnia** (zarówno zupełnych, jak i niezupełnych) bezpośrednio z surowego tekstu znakowego.
+
+Model wyznacza pierwiastki rzeczywiste bez użycia zewnętrznych silników symbolicznych (CAS) — uczy się wyznaczania wyróżnika (delty), rozkładu na czynniki, reguły znaków i pierwiastkowania wprost z ciągów znaków ASCII.
+
+### 📊 Architektura i Trening
+* **Architektura:** 2-warstwowy dwukierunkowy GRU (BiGRU) + głęboka regresyjna głowica MLP
+* **Wymiary:** `embed_dim=64`, `hidden_dim=384`, `max_roots=4`
+* **Zbiór danych:** Wytrenowany na ponad **1 000 000 syntetycznych równań** (losowe zmienne $x, y, a, t...$, współczynniki skalowania od -6 do +12, zakres pierwiastków $[-20, 20]$)
+* **Akceleracja sprzętowa:** **Intel Arc A770 (16GB)** pod **Arch Linux** z wykorzystaniem PyTorch XPU (Level Zero)
+* **Funkcja straty:** Masked MSE Loss (uwzględnia wyłącznie istniejące pierwiastki rzeczywiste)
 
-## 📊 Архитектура и Обучение
-* **Архитектура:** 2-слойная Двунаправленная GRU (BiGRU) + Полносвязный MLP
+### 🎯 Wyniki testowe (Benchmark 100 równań)
+* **Stopień 1 (Liniowe):** MAE ≈ **0.33**
+* **Stopień 2 (Kwadratowe):** MAE ≈ **0.27** *(Wysoka precyzja na pierwiastkach niewymiernych, np. $1 - \sqrt{2} \approx -0.41$)*
+* **Stopień 3 (Sześcienne):** MAE ≈ **0.60**
+* **Stopień 4 (4. stopień):** MAE ≈ **1.17**
+* **Średni błąd bezwzględny (Ogólny MAE):** **~0.69 – 0.75**
+
+---
+
+## 🇷🇺 Русский
+
+### Описание
+Нейросетевой решатель алгебраических уравнений степеней **от 1 до 4** (полных и неполных) по сырому символьному тексту.
+
+Модель находит действительные корни полиномов без сторонних систем компьютерной алгебры (CAS) — она выучила формулы Виета, дискриминант, смену знаков и извлечение корней напрямую из строк ASCII.
+
+### 📊 Архитектура и Обучение
+* **Архитектура:** 2-слойная Двунаправленная GRU (BiGRU) + Полносвязная голова MLP
 * **Размерности:** `embed_dim=64`, `hidden_dim=384`, `max_roots=4`
-* **Обучение:** Обучена на суммарном датасете из более чем **1 000 000 синтетических уравнений**
-* **Аппаратное ускорение:** Intel Arc A770 (16GB) под Arch Linux через PyTorch XPU (Level Zero)
-* **Функция потерь:** Masked MSE Loss (учитывает только существующие действительные корни)
+* **Датасет:** Обучена суммарно на более чем **1 000 000 синтетических уравнений** (различные переменные $x, y, a, t...$, коэффициенты от -6 до +12, диапазон корней $[-20, 20]$)
+* **Аппаратное ускорение:** **Intel Arc A770 (16GB)** под **Arch Linux** через PyTorch XPU (интерфейс Level Zero)
+* **Функция потерь:** Кастомный Masked MSE Loss (штрафует только за существующие действительные корни)
 
-## 🎯 Метрики качества (Бенчмарк)
+### 🎯 Метрики качества (Бенчмарк на 100 контрольных уравнениях)
 * **Степень 1 (Линейные):** MAE ≈ **0.33**
 * **Степень 2 (Квадратные):** MAE ≈ **0.27** *(Точное извлечение корней, включая иррациональные до сотых, например $1 - \sqrt{2} \approx -0.41$)*
 * **Степень 3 (Кубические):** MAE ≈ **0.60**
 * **Степень 4 (4-я степень):** MAE ≈ **1.17**
 * **Общая средняя ошибка (Overall MAE):** **~0.69 – 0.75**
 
-## 🚀 Быстрый запуск (ONNX Runtime)
+---
+
+## 💻 Quick Start / Szybki start / Быстрый запуск (ONNX Runtime)
 
 ```python
+import json
 import numpy as np
 import onnxruntime as ort
-import json
 
+# 1. Load ONNX model and metadata
 session = ort.InferenceSession("model.onnx")
 
 with open("config.json", "r", encoding="utf-8") as f:
-    meta = json.load(f)
+    config = json.load(f)
+
+vocab = config["vocab"]
+max_len = config["max_len"]
 
-vocab = meta["vocab"]
-max_len = meta["max_len"]
+# 2. Inference function
+def solve(equation: str):
+    equation = equation.strip()
+    if "=" not in equation:
+        equation += " = 0"
+        
+    # Determine polynomial degree
+    if "^4" in equation: deg = 4
+    elif "^3" in equation: deg = 3
+    elif "^2" in equation: deg = 2
+    else: deg = 1
 
-def solve(equation_str):
-    tokens = [vocab.get(ch, 1) for ch in equation_str]
+    tokens = [vocab.get(ch, 1) for ch in equation]
     tokens = tokens[:max_len] + [0] * max(0, max_len - len(tokens))
-    inp = np.array([tokens], dtype=np.int64)
-    
-    roots = session.run(["roots"], {"tokens": inp})[0][0]
-    return [round(float(r), 2) for r in roots]
+    input_data = np.array([tokens], dtype=np.int64)
+
+    preds = session.run(["roots"], {"tokens": input_data})[0][0]
+    return [round(float(r), 2) for r in preds[:deg]]
 
-print(solve("x^2 - 16 = 0"))  # -> [3.85, -4.02, ...]
-print(solve("3x^2 - 4x - 15 = 0"))  # -> [2.96, -1.59, ...]
+# 3. Test examples
+print(solve("3x^2 - 4x - 15 = 0"))  # -> [2.96, -1.59] (Exact: 3.0, -1.67)
+print(solve("x^2 - 2x - 1 = 0"))      # -> [2.03, -0.41] (Exact: 2.41, -0.41)
+print(solve("x^2 - 16 = 0"))          # -> [3.85, -4.02] (Exact: 4.0, -4.0)
+print(solve("a^3 - 3a^2 + 2a = 0"))   # -> [2.09, 0.84, -0.14] (Exact: 2.0, 1.0, 0.0)