libchai 0.3.5 → 0.3.6

package/README.md

@@ -13,27 +13,81 @@
 - `assets/distribution.txt`：用指分布文件示例，每个按键一行，每行的内容为以制表符分隔的按键、目标频率、低频率惩罚系数、高频率惩罚系数；
 - `assets/equivalence.txt`：双键速度当量文件示例，每个按键组合一行，每行的内容为以制表符分隔的按键组合和当量；
 
-命令行程序基本的用法为：
+`chai` 支持三个不同的命令：`encode`、`optimize` 和 `server`，各个命令的详细介绍如下：
+
+### 编码并计算指标
+
+`encode` 命令使用方案文件和拆分表计算出字词编码并统计各类评测指标。例如，您可以运行
 
 ```bash
-./chai [命令] [方案文件] -e [词信息文件]
+./chai encode examples/米十五笔.yaml -e examples/米十五笔.txt
 ```
 
-`chai` 支持三个不同的命令：`encode`、`optimize` 和 `server`：
+完整介绍如下：
+
+```bash
+> ./chai encode -h
+使用方案文件和拆分表计算出字词编码并统计各类指标
+
+Usage: chai encode [OPTIONS] [CONFIG]
+
+Arguments:
+  [CONFIG]  方案文件，默认为 config.yaml
 
-- `encode`：使用方案文件和拆分表计算出字词编码并统计各类评测指标
-- `optimize`：基于拆分表和方案文件中的配置优化元素布局
-- `server`：启动 Web 服务
+Options:
+  -e, --encodables <FILE>        频率序列表，默认为 elements.txt
+  -k, --key-distribution <FILE>  单键用指分布表，默认为 assets 目录下的 distribution.txt
+  -p, --pair-equivalence <FILE>  双键速度当量表，默认为 assets 目录下的 equivalence.txt
+```
+
+### 优化
 
-例如，您可以运行
+`optimize` 命令基于拆分表和方案文件中的配置优化元素布局。例如，您可以运行
 
 ```bash
-./chai encode examples/米十五笔.yaml -e examples/米十五笔.txt
 ./chai optimize examples/米十五笔.yaml -e examples/米十五笔.txt -t 4
+```
+
+完整介绍如下：
+
+```bash
+> ./chai optimize -h
+基于配置文件优化决策
+
+Usage: chai optimize [OPTIONS] [CONFIG]
+
+Arguments:
+  [CONFIG]  方案文件，默认为 config.yaml
+
+Options:
+  -e, --encodables <FILE>          频率序列表，默认为 elements.txt
+  -k, --key-distribution <FILE>    单键用指分布表，默认为 assets 目录下的 distribution.txt
+  -p, --pair-equivalence <FILE>    双键速度当量表，默认为 assets 目录下的 equivalence.txt
+  -t, --threads <THREADS>          优化时使用的线程数 [default: 1]
+  -r, --resume-from <RESUME_FROM>  是否要从某个输出目录恢复 如果指定了这个参数，程序会在该目录寻找 checkpoint-*.yaml 来恢复优化进度
+```
+
+在优化过程中，您可以随时停止优化并关闭终端，断点数据会保存在相应的文件夹中。若希望下一次计算从此前的某个断点继续，则需要加上 `-r` 参数。例如，上一次计算的结果在 `output-02-20+20_26_36` 中，则可以加上 `-r output-02-20+20_26_36`。值得注意的是，使用的线程数量需要和此前一致，否则无法将所有断点文件均继续计算。
+
+### 启动服务器
+
+`server` 命令​启动 Web 服务。例如，您可以运行
+
+```bash
 ./chai server -p 12345
 ```
 
-完整的使用说明可用 `./chai --help` 查看。
+完整介绍如下：
+
+```bash
+> ./chai server -h
+启动 HTTP API 服务器
+
+Usage: chai server [OPTIONS]
+
+Options:
+  -p, --port <PORT>  服务器端口号 [default: 3200]
+```
 
 ## 使用 `libchai`
 

package/chai.d.ts

@@ -13,7 +13,7 @@ export class Web {
   encode_evaluate(前端目标函数配置: any): any;
   static new(回调: Function): Web;
   sync(前端参数: any): void;
-  optimize(): void;
+  optimize(): any;
 }
 
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;

package/chai.js

@@ -284,15 +284,20 @@ export class Web {
             wasm.__wbindgen_add_to_stack_pointer(16);
         }
     }
+    /**
+     * @returns {any}
+     */
     optimize() {
         try {
             const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
             wasm.web_optimize(retptr, this.__wbg_ptr);
             var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
             var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
-            if (r1) {
-                throw takeObject(r0);
+            var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
+            if (r2) {
+                throw takeObject(r1);
             }
+            return takeObject(r0);
         } finally {
             wasm.__wbindgen_add_to_stack_pointer(16);
         }
@@ -379,9 +384,29 @@ function __wbg_get_imports() {
         const ret = String.fromCodePoint(arg0 >>> 0);
         return addHeapObject(ret);
     }, arguments) };
+    imports.wbg.__wbg_getDate_ef336e14594b35ce = function(arg0) {
+        const ret = getObject(arg0).getDate();
+        return ret;
+    };
+    imports.wbg.__wbg_getHours_70451b8de3ce8638 = function(arg0) {
+        const ret = getObject(arg0).getHours();
+        return ret;
+    };
+    imports.wbg.__wbg_getMinutes_e793d718371e18f7 = function(arg0) {
+        const ret = getObject(arg0).getMinutes();
+        return ret;
+    };
+    imports.wbg.__wbg_getMonth_d37edcd23642c97d = function(arg0) {
+        const ret = getObject(arg0).getMonth();
+        return ret;
+    };
     imports.wbg.__wbg_getRandomValues_3c9c0d586e575a16 = function() { return handleError(function (arg0, arg1) {
         globalThis.crypto.getRandomValues(getArrayU8FromWasm0(arg0, arg1));
     }, arguments) };
+    imports.wbg.__wbg_getSeconds_755197b634cca692 = function(arg0) {
+        const ret = getObject(arg0).getSeconds();
+        return ret;
+    };
     imports.wbg.__wbg_get_67b2ba62fc30de12 = function() { return handleError(function (arg0, arg1) {
         const ret = Reflect.get(getObject(arg0), getObject(arg1));
         return addHeapObject(ret);
@@ -448,6 +473,10 @@ function __wbg_get_imports() {
         const ret = getObject(arg0).length;
         return ret;
     };
+    imports.wbg.__wbg_new0_f788a2397c7ca929 = function() {
+        const ret = new Date();
+        return addHeapObject(ret);
+    };
     imports.wbg.__wbg_new_405e22f390576ce2 = function() {
         const ret = new Object();
         return addHeapObject(ret);

package/package.json

@@ -5,7 +5,7 @@
     "Songchen Tan <i@tansongchen.com>"
   ],
   "description": "汉字编码优化算法",
-  "version": "0.3.5",
+  "version": "0.3.6",
   "license": "GPL-3.0",
   "repository": {
     "type": "git",