fr-spell 1.0.1 → 1.0.3

package/README.cn.md

@@ -45,6 +45,23 @@ console.log(verb);
 { lemma: 'manger', wordType: 'VERB', person: 'FST_PL', mode: 'INDI', tense: 'PRES', output: 'mangeons', confidence: 0.9999864523, timeMs: 4.79 }
 ```
 
+## 浏览器用法
+
+直接使用本包内的浏览器 Bundle 与模型资源：
+
+```html
+<script src="./frspell.browser.js"></script>
+<script>
+	(async () => {
+		const predictor = await window.FrSpell({
+			modelBasePath: './models/community'
+		});
+		const result = await predictor.lemma('mangeons');
+		console.log(result);
+	})();
+</script>
+```
+
 ## 预测参数说明
 
 词元预测（lemma）：
@@ -97,14 +114,6 @@ console.log(verb);
 - 参考定义文件中还有更多时态名称，但本包实现目前只支持 `PRES`、`IMPA`、`FUTU`、`PASS`。
 - 对于名词/形容词派生，用户输入时不需要 `mode` 与 `tense`。
 
-## 运行测试
-
-```bash
-npm test
-```
-
-该命令会执行 test/test.js，并输出示例预测结果。
-
 ## 查看帮助
 
 ```bash
@@ -113,53 +122,31 @@ npm run help
 
 该命令会输出参数速查说明，覆盖 `lemma`、`nounDerive`、`adjeDerive`、`verbDerive`、`derive` 及 person/mode/tense 可用值。
 
-## 运行基准测试
-
-1) 先生成检查清单 JSON（每类 100 条）：
-
-```bash
-npm run benchmark:prepare
-```
-
-2) 运行全部基准测试：
-
-```bash
-npm run benchmark
-```
-
-3) 可选：按单项运行：
-
-```bash
-npm run benchmark:lemma
-npm run benchmark:noun
-npm run benchmark:verb
-npm run benchmark:adje
-```
-
 ## 基准结果（最近一次本地运行）
 
-基准命令：
-
-```bash
-npm run benchmark
-```
-
 结果：
 
-- 由变位预测词元：99/100，准确率 99.00%，平均 16.46 ms
-- 名词派生：99/100，准确率 99.00%，平均 17.33 ms
-- 动词派生：100/100，准确率 100.00%，平均 17.12 ms
-- 形容词派生：100/100，准确率 100.00%，平均 17.34 ms
+- 由变位预测词元：97/100，准确率 97.00%，平均 22.21 ms
+- 名词派生：100/100，准确率 100.00%，平均 23.46 ms
+- 动词派生：100/100，准确率 100.00%，平均 23.18 ms
+- 形容词派生：100/100，准确率 100.00%，平均 23.49 ms
 
 ## 模型体积
 
-- 词元 ONNX 模型：models/small/lemma_type_model.int8.onnx = 0.96 MB
-- 派生 ONNX 模型：models/small/derive_form_model.int8.onnx = 0.91 MB
-- ONNX 总体积：约 1.87 MB
+- 当前默认（community）词元 ONNX 模型：models/community/lemma_type_model.int8.onnx = 1.48 MB
+- 当前默认（community）派生 ONNX 模型：models/community/derive_form_model.int8.onnx = 1.40 MB
+- 当前默认 ONNX 总体积：约 2.88 MB
+
+Mini 版本说明：
+
+- mini 词元 ONNX 模型目标大小：0.96 MB
+- mini 派生 ONNX 模型目标大小：0.91 MB
+- mini ONNX 总体积目标：约 1.87 MB
+- mini 模型版本将很快上线。
 
 ## 为什么它非常适合 Web 前端产品
 
 - 法语关键形态任务具有高准确率
-- 单次请求延迟低（本地基准平均约 16 到 17 ms）
-- ONNX 体积小（总计约 1.87 MB）
+- 单次请求延迟低（最新本地基准平均约 22 到 23 ms）
+- 当前默认 ONNX 体积紧凑（约 2.88 MB），更小的 mini 模型包（约 1.87 MB）即将上线
 - 非常适合为 Web 前端功能提供后端推理能力，例如实时写作辅助、语法提示与词元感知检索

package/README.fr.md

@@ -45,6 +45,23 @@ Exemple de sortie a l'execution :
 { lemma: 'manger', wordType: 'VERB', person: 'FST_PL', mode: 'INDI', tense: 'PRES', output: 'mangeons', confidence: 0.9999864523, timeMs: 4.79 }
 ```
 
+## Utilisation navigateur
+
+Utilisez directement le bundle navigateur et les ressources modele inclus dans ce package :
+
+```html
+<script src="./frspell.browser.js"></script>
+<script>
+	(async () => {
+		const predictor = await window.FrSpell({
+			modelBasePath: './models/community'
+		});
+		const result = await predictor.lemma('mangeons');
+		console.log(result);
+	})();
+</script>
+```
+
 ## Parametres de prediction
 
 Prediction de lemme :
@@ -97,14 +114,6 @@ Note :
 - Le fichier de definitions d'origine contient plus de noms de temps, mais ce package prend actuellement en charge uniquement `PRES`, `IMPA`, `FUTU`, `PASS`.
 - Pour les appels nom/adjectif, `mode` et `tense` ne sont pas requis dans l'entree utilisateur.
 
-## Exécuter les tests
-
-```bash
-npm test
-```
-
-Cette commande exécute test/test.js et affiche des exemples de prédiction.
-
 ## Afficher l'aide
 
 ```bash
@@ -113,53 +122,31 @@ npm run help
 
 Cette commande affiche un guide rapide des paramètres pour `lemma`, `nounDerive`, `adjeDerive`, `verbDerive` et `derive`, avec les valeurs autorisées de person/mode/tense.
 
-## Exécuter les benchmarks
-
-1) Générer les fichiers JSON de checklist (100 éléments chacun) :
-
-```bash
-npm run benchmark:prepare
-```
-
-2) Exécuter toutes les suites de benchmark :
-
-```bash
-npm run benchmark
-```
-
-3) Optionnel : exécuter une suite spécifique :
-
-```bash
-npm run benchmark:lemma
-npm run benchmark:noun
-npm run benchmark:verb
-npm run benchmark:adje
-```
-
 ## Résultats de benchmark (dernier run local)
 
-Commande de benchmark :
-
-```bash
-npm run benchmark
-```
-
 Résultats :
 
-- lemme depuis une conjugaison : 99/100, précision 99.00 %, moyenne 16.46 ms
-- dérivation nominale : 99/100, précision 99.00 %, moyenne 17.33 ms
-- dérivation verbale : 100/100, précision 100.00 %, moyenne 17.12 ms
-- dérivation adjectivale : 100/100, précision 100.00 %, moyenne 17.34 ms
+- lemme depuis une conjugaison : 97/100, précision 97.00 %, moyenne 22.21 ms
+- dérivation nominale : 100/100, précision 100.00 %, moyenne 23.46 ms
+- dérivation verbale : 100/100, précision 100.00 %, moyenne 23.18 ms
+- dérivation adjectivale : 100/100, précision 100.00 %, moyenne 23.49 ms
 
 ## Taille des modèles
 
-- modèle ONNX lemme : models/small/lemma_type_model.int8.onnx = 0.96 MB
-- modèle ONNX dérivation : models/small/derive_form_model.int8.onnx = 0.91 MB
-- taille totale ONNX : environ 1.87 MB
+- modèle ONNX lemme par défaut (community) : models/community/lemma_type_model.int8.onnx = 1.48 MB
+- modèle ONNX dérivation par défaut (community) : models/community/derive_form_model.int8.onnx = 1.40 MB
+- taille ONNX totale par défaut actuelle : environ 2.88 MB
+
+Note sur la version mini :
+
+- taille cible du modèle lemme mini : 0.96 MB
+- taille cible du modèle dérivation mini : 0.91 MB
+- taille ONNX totale cible de la version mini : environ 1.87 MB
+- le package de modèles mini sera publié prochainement.
 
 ## Pourquoi c'est idéal pour des produits web frontend
 
 - excellente précision sur les tâches clés de morphologie française
-- faible latence par requête (environ 16 à 17 ms en moyenne sur benchmark local)
-- empreinte ONNX très compacte (environ 1.87 MB au total)
+- faible latence par requête (environ 22 à 23 ms en moyenne sur le dernier benchmark local)
+- empreinte ONNX par défaut toujours compacte (environ 2.88 MB au total), avec un package mini plus léger (environ 1.87 MB) à venir
 - parfait pour alimenter des fonctionnalités frontend via une inférence backend : assistance à l'écriture en temps réel, suggestions grammaticales et recherche basée sur le lemme

package/README.md

@@ -45,6 +45,23 @@ Sample runtime output:
 { lemma: 'manger', wordType: 'VERB', person: 'FST_PL', mode: 'INDI', tense: 'PRES', output: 'mangeons', confidence: 0.9999864523, timeMs: 4.79 }
 ```
 
+## Browser Usage
+
+Use the browser bundle and model assets included in this package:
+
+```html
+<script src="./frspell.browser.js"></script>
+<script>
+	(async () => {
+		const predictor = await window.FrSpell({
+			modelBasePath: './models/community'
+		});
+		const result = await predictor.lemma('mangeons');
+		console.log(result);
+	})();
+</script>
+```
+
 ## Prediction Parameters
 
 Lemma prediction:
@@ -97,14 +114,6 @@ Note:
 - The original grammar definition file includes more tense names, but this package implementation currently supports only `PRES`, `IMPA`, `FUTU`, `PASS`.
 - For noun/adjective derive calls, `mode` and `tense` are not required in user input.
 
-## Run Test
-
-```bash
-npm test
-```
-
-This executes test/test.js and prints sample prediction outputs.
-
 ## Run Help
 
 ```bash
@@ -113,53 +122,31 @@ npm run help
 
 This prints a quick parameter reference for `lemma`, `nounDerive`, `adjeDerive`, `verbDerive`, and `derive`, including allowed person/mode/tense values.
 
-## Run Benchmark
-
-1) Prepare checklist JSON files (100 items each):
-
-```bash
-npm run benchmark:prepare
-```
-
-2) Run all benchmark suites:
-
-```bash
-npm run benchmark
-```
-
-3) Optional single-suite runs:
-
-```bash
-npm run benchmark:lemma
-npm run benchmark:noun
-npm run benchmark:verb
-npm run benchmark:adje
-```
-
 ## Benchmark Result (Latest Local Run)
 
-Benchmark command:
-
-```bash
-npm run benchmark
-```
-
 Results:
 
-- lemma from conjugation: 99/100, accuracy 99.00%, average 16.46 ms
-- noun derive: 99/100, accuracy 99.00%, average 17.33 ms
-- verb derive: 100/100, accuracy 100.00%, average 17.12 ms
-- adjective derive: 100/100, accuracy 100.00%, average 17.34 ms
+- lemma from conjugation: 97/100, accuracy 97.00%, average 22.21 ms
+- noun derive: 100/100, accuracy 100.00%, average 23.46 ms
+- verb derive: 100/100, accuracy 100.00%, average 23.18 ms
+- adjective derive: 100/100, accuracy 100.00%, average 23.49 ms
 
 ## Model Size
 
-- lemma ONNX model: models/small/lemma_type_model.int8.onnx = 0.96 MB
-- derive ONNX model: models/small/derive_form_model.int8.onnx = 0.91 MB
-- total ONNX model size: about 1.87 MB
+- current default (community) lemma ONNX model: models/community/lemma_type_model.int8.onnx = 1.48 MB
+- current default (community) derive ONNX model: models/community/derive_form_model.int8.onnx = 1.40 MB
+- current default total ONNX model size: about 2.88 MB
+
+Mini version note:
+
+- mini lemma ONNX model target: 0.96 MB
+- mini derive ONNX model target: 0.91 MB
+- mini total ONNX model target: about 1.87 MB
+- the mini model package is planned to be published soon.
 
 ## Why It Is Great For Web Frontend Products
 
 - high accuracy for key French morphology tasks
-- low per-request latency (about 16 to 17 ms average in local benchmark)
-- very small ONNX footprint (about 1.87 MB total)
+- low per-request latency (about 22 to 23 ms average in latest local benchmark)
+- current default ONNX footprint is compact (about 2.88 MB total), with a smaller mini model package (about 1.87 MB) coming soon
 - ideal for backend inference powering web frontend features such as live writing assistance, grammar hints, and lemma-aware search