Skip to Content
API Reference@ignitionai/storageSrcClassesClass: HuggingFaceProvider

ignition-monorepo


ignition-monorepo / storage/src / HuggingFaceProvider

Class: HuggingFaceProvider

Defined in: storage/src/providers/huggingface.ts:29 

Implements

Constructors

Constructor

new HuggingFaceProvider(config?): HuggingFaceProvider

Defined in: storage/src/providers/huggingface.ts:36 

Parameters

config?

Explicit config object. When omitted, reads HF_TOKEN and HF_REPO_ID from process.env and validates with Zod.

token

string = ...

repoId

string = ...

Returns

HuggingFaceProvider

Methods

save()

save(modelId, model, metadata?): Promise<string>

Defined in: storage/src/providers/huggingface.ts:42 

Serialize and persist a model. Returns the URI where it was stored.

Parameters

modelId

string

model

LayersModel

metadata?

Record<string, unknown>

Returns

Promise<string>

Implementation of

ModelStorageProvider.save


load()

load(modelId, maxRetries?, initialDelay?): Promise<LayersModel>

Defined in: storage/src/providers/huggingface.ts:90 

Load a previously saved model by its ID.

Parameters

modelId

string

maxRetries?

number = 3

initialDelay?

number = 2000

Returns

Promise<LayersModel>

Implementation of

ModelStorageProvider.load


list()

list(): Promise<ModelInfo[]>

Defined in: storage/src/providers/huggingface.ts:119 

List all models stored by this provider.

Returns

Promise<ModelInfo[]>

Implementation of

ModelStorageProvider.list


delete()

delete(modelId): Promise<void>

Defined in: storage/src/providers/huggingface.ts:149 

Delete a model and its associated files.

Parameters

modelId

string

Returns

Promise<void>

Implementation of

ModelStorageProvider.delete


exists()

exists(modelId): Promise<boolean>

Defined in: storage/src/providers/huggingface.ts:165 

Return true if a model with the given ID exists.

Parameters

modelId

string

Returns

Promise<boolean>

Implementation of

ModelStorageProvider.exists

Last updated on