Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/embeddings/transformers-js.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import type { DeviceType } from '@huggingface/transformers'
import type { EmbeddingConfig, EmbeddingProvider, ResolvedEmbedding } from '../types'
import { rm } from 'node:fs/promises'
import { env, pipeline } from '@huggingface/transformers'
Expand All @@ -17,6 +18,8 @@ export interface TransformersEmbeddingOptions {
model?: string
/** Embedding dimensions (auto-detected for known models) */
dimensions?: number
/** Device used to run the model. Omit it to use transformers.js defaults. */
device?: DeviceType
/** Called with model download progress (initiate β†’ download β†’ progress β†’ done β†’ ready) */
onProgress?: (info: TransformersProgressInfo) => void
}
Expand Down Expand Up @@ -65,6 +68,8 @@ export function transformersJs(options: TransformersEmbeddingOptions = {}): Embe
const pipelineOpts: Record<string, unknown> = { dtype: 'fp32' }
if (options.onProgress)
pipelineOpts.progress_callback = options.onProgress
if (options.device)
pipelineOpts.device = options.device

const extractor = await pipeline('feature-extraction', model, pipelineOpts)
.catch(async (err) => {
Expand Down
34 changes: 34 additions & 0 deletions test/transformers-js.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import { pipeline } from '@huggingface/transformers'
import { beforeEach, describe, expect, it, vi } from 'vitest'
import { transformersJs } from '../src/embeddings/transformers-js'

vi.mock('@huggingface/transformers', () => ({
env: {},
pipeline: vi.fn(async () => vi.fn()),
}))

describe('transformersJs', () => {
beforeEach(() => {
vi.mocked(pipeline).mockClear()
})

it('runs the model on the selected device', async () => {
await transformersJs({ model: 'bge-small-en-v1.5', device: 'webgpu' }).resolve()

expect(pipeline).toHaveBeenCalledWith(
'feature-extraction',
'Xenova/bge-small-en-v1.5',
expect.objectContaining({ device: 'webgpu' }),
)
})

it('leaves device selection to transformers.js when omitted', async () => {
await transformersJs({ model: 'bge-small-en-v1.5' }).resolve()

expect(pipeline).toHaveBeenCalledWith(
'feature-extraction',
'Xenova/bge-small-en-v1.5',
expect.not.objectContaining({ device: expect.anything() }),
)
})
})
Loading