@anvia/transformers 1.1.4 → 1.1.5

package/README.md

@@ -1,79 +1,60 @@
 # @anvia/transformers
 
-Local Transformers.js embedding model adapter for Anvia.
+Generate text embeddings locally with Transformers.js. Build semantic search and retrieval
+workflows without sending document text to a hosted embedding service.
 
-## Installation
+## Install
 
 ```sh
-pnpm add @anvia/transformers @anvia/core @huggingface/transformers
+pnpm add @anvia/transformers @anvia/core
 ```
 
-## Usage
+## Quickstart
+
+The first load may download model files. Subsequent loads can reuse the local cache.
 
 ```ts
 import { embedDocuments } from "@anvia/core/embeddings";
 import { InMemoryVectorStore, retrieveDocuments } from "@anvia/core/vector-store";
 import { loadTransformersEmbeddingModel } from "@anvia/transformers";
 
-const model = await loadTransformersEmbeddingModel({ modelId: "Xenova/all-MiniLM-L6-v2" });
-const { documents } = await embedDocuments({
-  model,
-  documents: [{ id: "password-reset", text: "Reset links expire after 30 minutes." }],
-  id: (document) => document.id,
-  content: (document) => document.text,
-});
-
-const store = InMemoryVectorStore.fromDocuments({ documents });
-const results = await retrieveDocuments({
-  store,
-  model,
-  query: "How long does a reset link last?",
-  topK: 3,
-});
-```
-
-Loading is eager and may download model files. Reuse the returned handle and close it at application
-shutdown. The handle supports `await using` and waits for active inference before disposing its
-owned Transformers pipeline.
-
-```ts
 const model = await loadTransformersEmbeddingModel({
   modelId: "Xenova/all-MiniLM-L6-v2",
-  pooling: "mean",
-  normalize: true,
-  maxBatchSize: 16,
 });
-```
 
-```ts
-await using model = await loadTransformersEmbeddingModel({
-  modelId: "Xenova/all-MiniLM-L6-v2",
-  device: "cpu",
-  dtype: "q8",
-  cacheDir: "./models",
-});
+try {
+  const { documents } = await embedDocuments({
+    model,
+    documents: [{ id: "password-reset", text: "Reset links expire after 30 minutes." }],
+    id: (document) => document.id,
+    content: (document) => document.text,
+  });
+  const store = InMemoryVectorStore.fromDocuments({ documents });
+
+  const results = await retrieveDocuments({
+    store,
+    model,
+    query: "How long does a reset link last?",
+    topK: 3,
+  });
+  console.log(results);
+} finally {
+  await model.close();
+}
 ```
 
-Adapt an existing pipeline when the application owns its lifecycle:
+## What it supports
 
-```ts
-import { adaptTransformersEmbeddingModel } from "@anvia/transformers";
+- Configurable pooling, normalization, batching, device, and dtype.
+- Model caching and local-files-only loading.
+- Existing Transformers pipelines through `adaptTransformersEmbeddingModel()`.
+- Explicit cleanup with `close()` or `await using` for loaded models.
 
-const model = adaptTransformersEmbeddingModel({
-  runtime: existingPipeline,
-  modelId: "custom-model",
-  pooling: "mean",
-  normalize: true,
-});
-```
-
-Adapted handles never dispose the caller-owned runtime. Embedding helpers use object arguments,
-return named results, and accept `retries` and `abortSignal`.
+Reuse the model across requests. Adapted pipelines remain caller-owned; loaded models wait
+for active inference before disposing their runtime.
 
-## Development
+## Learn more
 
-```sh
-pnpm --filter @anvia/transformers typecheck
-pnpm --filter @anvia/transformers test
-pnpm --filter @anvia/transformers build
-```
+- [Usage guide](https://github.com/anvia-hq/anvia/blob/main/docs/packages/embedding-transformers.md)
+- [Anvia overview](https://github.com/anvia-hq/anvia/blob/main/README.md)
+- [Contributing](https://github.com/anvia-hq/anvia/blob/main/CONTRIBUTING.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anvia/transformers",
-  "version": "1.1.4",
+  "version": "1.1.5",
   "description": "Transformers.js embedding model adapter for Anvia.",
   "author": "anvia",
   "license": "MIT",
@@ -32,10 +32,10 @@
     "tsup": "^8.5.0",
     "typescript": "^5.9.3",
     "vitest": "^4.1.11",
-    "@anvia/core": "1.5.0"
+    "@anvia/core": "1.6.1"
   },
   "peerDependencies": {
-    "@anvia/core": "^1.5.0"
+    "@anvia/core": "^1.6.1"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm --dts --sourcemap --clean",