Class: TransformersJsGenerationAdapter
Defined in: src/batteries/generation/transformers_js/adapter.ts:123
Media generation adapter for transformers.js's Janus (MultiModalityCausalLM) text→image model family.
Remarks
Reusable: construct once, call TransformersJsGenerationAdapter.generate as many times as needed. The model + processor are resolved lazily on first use (or via preload) and cached with single-flight semantics so concurrent calls share one load. edit always throws — see the module remarks.
Constructors
Constructor
new TransformersJsGenerationAdapter(options: unknown): TransformersJsGenerationAdapter;Defined in: src/batteries/generation/transformers_js/adapter.ts:146
Parameters
| Parameter | Type | Description |
|---|---|---|
options | unknown | Constructor options. Validated eagerly. |
Returns
TransformersJsGenerationAdapter
Throws
@nhtio/adk/batteries!E_INVALID_TRANSFORMERS_JS_GENERATION_OPTIONS when invalid.
Methods
edit()
edit(
_image: unknown,
_prompt: string,
_opts?: EditOptions): Promise<GeneratedMediaOutput[]>;Defined in: src/batteries/generation/transformers_js/adapter.ts:326
Unsupported. Janus's only generation entry point (generate_images) is text-conditioned; there is no image-conditioned edit/inpaint surface in the installed @huggingface/transformers API.
Parameters
| Parameter | Type |
|---|---|
_image | unknown |
_prompt | string |
_opts? | EditOptions |
Returns
Promise<GeneratedMediaOutput[]>
Throws
@nhtio/adk/batteries!E_TRANSFORMERS_JS_GENERATION_UNSUPPORTED_OPERATION always.
generate()
generate(prompt: string, opts?: TransformersJsGenerateOptions): Promise<GeneratedMediaOutput[]>;Defined in: src/batteries/generation/transformers_js/adapter.ts:241
Generates image(s) from a text prompt via Janus's generate_images.
Parameters
| Parameter | Type | Description |
|---|---|---|
prompt | string | The text prompt describing the desired image. |
opts? | TransformersJsGenerateOptions | Per-call knob overrides — see TransformersJsGenerateOptions. |
Returns
Promise<GeneratedMediaOutput[]>
The generated image(s), each PNG-encoded.
Throws
@nhtio/adk/batteries!E_TRANSFORMERS_JS_GENERATION_ENGINE_ERROR when the call fails or returns no usable images.
isAvailable()
isAvailable(): boolean;Defined in: src/batteries/generation/transformers_js/adapter.ts:153
Instance availability probe (honours an injected isAvailable).
Returns
boolean
preload()
preload(): Promise<void>;Defined in: src/batteries/generation/transformers_js/adapter.ts:158
Eagerly loads (and caches) the model + processor so the first generate call is fast. Idempotent.
Returns
Promise<void>
reset()
reset(): void;Defined in: src/batteries/generation/transformers_js/adapter.ts:163
Drops the cached model/processor and in-flight load so the next call reloads.
Returns
void
isAvailable()
static isAvailable(): boolean;Defined in: src/batteries/generation/transformers_js/adapter.ts:138
Whether this battery is available. transformers.js is environment-neutral (Node + browser), so this is true whenever the runtime can import the peer — there is no WebGPU requirement.
Returns
boolean