fr-spell 1.0.2 → 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,63 +122,8 @@ npm run help
 
 该命令会输出参数速查说明，覆盖 `lemma`、`nounDerive`、`adjeDerive`、`verbDerive`、`derive` 及 person/mode/tense 可用值。
 
-## 构建浏览器 Bundle
-
-```bash
-npm run build
-```
-
-构建产物：
-
-- `dist/frspell.browser.js`（单个 JS 文件，挂载 `window.FrSpell`）
-- `dist/models/community/*.onnx|*.json`（模型与词表等必需资源）
-
-构建完成后，将整个 `dist` 文件夹复制到前端项目中，然后使用：
-
-```html
-<script src="./dist/frspell.browser.js"></script>
-<script>
-	(async () => {
-		const predictor = await window.FrSpell({
-			modelBasePath: './dist/models/community'
-		});
-		const result = await predictor.lemma('mangeons');
-		console.log(result);
-	})();
-</script>
-```
-
-## 运行基准测试
-
-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
-```
-
 结果：
 
 - 由变位预测词元：97/100，准确率 97.00%，平均 22.21 ms

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,63 +122,8 @@ 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.
 
-## Construire le bundle navigateur
-
-```bash
-npm run build
-```
-
-Sortie de build :
-
-- `dist/frspell.browser.js` (fichier JS unique, expose `window.FrSpell`)
-- `dist/models/community/*.onnx|*.json` (ressources modèle et vocabulaire requises)
-
-Après le build, copiez tout le dossier `dist` dans votre projet frontend, puis utilisez :
-
-```html
-<script src="./dist/frspell.browser.js"></script>
-<script>
-	(async () => {
-		const predictor = await window.FrSpell({
-			modelBasePath: './dist/models/community'
-		});
-		const result = await predictor.lemma('mangeons');
-		console.log(result);
-	})();
-</script>
-```
-
-## 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 : 97/100, précision 97.00 %, moyenne 22.21 ms

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,63 +122,8 @@ npm run help
 
 This prints a quick parameter reference for `lemma`, `nounDerive`, `adjeDerive`, `verbDerive`, and `derive`, including allowed person/mode/tense values.
 
-## Build Browser Bundle
-
-```bash
-npm run build
-```
-
-Build output:
-
-- `dist/frspell.browser.js` (single JS bundle, attach `window.FrSpell`)
-- `dist/models/community/*.onnx|*.json` (required model and vocab assets)
-
-After build, copy the whole `dist` folder into your frontend project, then use:
-
-```html
-<script src="./dist/frspell.browser.js"></script>
-<script>
-	(async () => {
-		const predictor = await window.FrSpell({
-			modelBasePath: './dist/models/community'
-		});
-		const result = await predictor.lemma('mangeons');
-		console.log(result);
-	})();
-</script>
-```
-
-## 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: 97/100, accuracy 97.00%, average 22.21 ms

package/package.json

@@ -1,22 +1,26 @@
 {
   "name": "fr-spell",
-  "description": "A NPM Library To Convert Derivative Forms Of Noun, Verb or Adjective In French To Lemmas Or Vice Versa.",
-  "version": "1.0.2",
+  "version": "1.0.3",
+  "description": "Lightweight French lemmatization and conjugation. Convert between nouns, verbs, and adjectives using fast, quantized INT8 ONNX models under 2MB.",
   "type": "module",
-  "main": "./src/frspell.js",
+  "main": "./index.js",
   "exports": {
-    ".": "./src/frspell.js"
+    ".": "./index.js",
+    "./browser": "./frspell.browser.js"
   },
+  "files": [
+    "index.js",
+    "frspell.browser.js",
+    "module",
+    "models",
+    "scripts/help.js",
+    "README.md",
+    "README.cn.md",
+    "README.fr.md",
+    "LICENSE"
+  ],
   "scripts": {
-    "help": "node scripts/help.js",
-    "build": "node scripts/build.js",
-    "test": "node test/test.js",
-    "benchmark:prepare": "node benchmark/generate-checklists.js",
-    "benchmark": "node benchmark/run-benchmark.js",
-    "benchmark:lemma": "node benchmark/run-benchmark.js lemma",
-    "benchmark:noun": "node benchmark/run-benchmark.js noun",
-    "benchmark:verb": "node benchmark/run-benchmark.js verb",
-    "benchmark:adje": "node benchmark/run-benchmark.js adje"
+    "help": "node scripts/help.js"
   },
   "repository": {
     "type": "git",
@@ -48,8 +52,5 @@
   "dependencies": {
     "onnxruntime-node": "^1.24.3",
     "onnxruntime-web": "^1.24.3"
-  },
-  "devDependencies": {
-    "esbuild": "^0.25.10"
   }
 }