@jarkkojs/readseek 0.7.2 → 0.7.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +31 -5
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -31,7 +31,7 @@ Source builds require CMake, Clang/libclang, and a C++ compiler because image
31
31
  inference uses `llama-cpp-2`.
32
32
 
33
33
  GPU acceleration can be enabled at build time with the `metal`, `opencl`, `rocm`,
34
- or `vulkan` Cargo feature.
34
+ or `vulkan` Cargo feature. CPU builds can enable `openmp` for OpenMP parallelism.
35
35
 
36
36
  ## Plugins
37
37
 
@@ -102,6 +102,31 @@ readseek read photo.jpg --image ocr # extracted text
102
102
  readseek read photo.jpg --image all # caption, objects, and OCR in one pass
103
103
  ```
104
104
 
105
+ Inference defaults to the `balanced` profile. `fast` uses fewer visual tokens for
106
+ lower latency, while `accurate` retains more visual detail for dense OCR and small
107
+ objects:
108
+
109
+ ```sh
110
+ readseek read photo.jpg --image caption --vision-profile fast
111
+ readseek read scan.png --image ocr --vision-profile accurate
112
+ ```
113
+
114
+ Use `--vision-diagnostics` to emit cache status, backend devices, token counts,
115
+ per-stage timings, throughput, and peak RSS as JSON on stderr. For repeatable warm
116
+ measurements, `--vision-benchmark N` runs one warmup followed by `N` measured
117
+ iterations (currently image files only):
118
+
119
+ ```sh
120
+ readseek read fixture.png --image all --vision-benchmark 5 \
121
+ >result.json 2>benchmark.json
122
+ ```
123
+
124
+ CPU tuning overrides are available through `READSEEK_VISION_THREADS`,
125
+ `READSEEK_VISION_BATCH`, and `READSEEK_VISION_UBATCH`. Values must be positive,
126
+ and the micro-batch cannot exceed the logical batch. Compare overrides on a fixed
127
+ representative image corpus; larger batches can improve prefill while increasing
128
+ peak memory.
129
+
105
130
  PDF reads return page-tagged Markdown and page-associated embedded images. Use
106
131
  `--page` to select one page; the same image mode applies to each embedded image.
107
132
  After initializing `.readseek/`, `view` creates or reuses a persistent structural
@@ -109,9 +134,10 @@ PDF index and returns an overview that can be narrowed by page, node, kind, or
109
134
  depth. Line/hash suffixes, `--end`, `--limit`, and `--language` do not apply to
110
135
  visual files.
111
136
 
112
- The Qwen3-VL GGUF model and multimodal projector download lazily into the user
113
- cache and run through `llama-cpp-2` on the CPU. Captioning can take substantial
114
- time.
137
+ The Qwen3-VL GGUF language model and Q8_0 multimodal projector download lazily
138
+ into the user cache, are checksum-verified once, and then use a metadata-bound
139
+ verification marker on later starts. Inference uses the backends enabled in the
140
+ build; CPU-only captioning can still take substantial time.
115
141
 
116
142
  ## Cache
117
143
 
@@ -120,7 +146,7 @@ time.
120
146
  discover `.readseek/` by walking up from the target path, or use the directory
121
147
  passed by `--readseek-dir`. `view` creates PDF structure indexes and extracted
122
148
  assets under `.readseek/documents/` on demand. Image analysis caches results
123
- under the `.readseek/` found from the current working directory.
149
+ under the `.readseek/` found from the current working directory. Cache entries are profile-specific.
124
150
 
125
151
  ## Documentation
126
152
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jarkkojs/readseek",
3
- "version": "0.7.2",
3
+ "version": "0.7.3",
4
4
  "description": "A structural read command",
5
5
  "license": "Apache-2.0 AND LGPL-2.1-or-later",
6
6
  "homepage": "https://github.com/jarkkojs/readseek#readme",
@@ -21,10 +21,10 @@
21
21
  "LICENSE-LGPL-2.1"
22
22
  ],
23
23
  "optionalDependencies": {
24
- "@jarkkojs/readseek-darwin-arm64": "0.7.2",
25
- "@jarkkojs/readseek-linux-arm64": "0.7.2",
26
- "@jarkkojs/readseek-linux-x64": "0.7.2",
27
- "@jarkkojs/readseek-win32-x64": "0.7.2"
24
+ "@jarkkojs/readseek-darwin-arm64": "0.7.3",
25
+ "@jarkkojs/readseek-linux-arm64": "0.7.3",
26
+ "@jarkkojs/readseek-linux-x64": "0.7.3",
27
+ "@jarkkojs/readseek-win32-x64": "0.7.3"
28
28
  },
29
29
  "publishConfig": {
30
30
  "access": "public"