Class Model

Model class

One model can have multiple shards, each shard is a GGUF file.

Index

Constructors

constructor

new Model(
    modelManager: ModelManager,
    url: string,
    savedFiles?: CacheEntry[],
): Model
Parameters
- modelManager: ModelManager
- url: string
- OptionalsavedFiles: CacheEntry[]
Returns Model
- Defined in src/model-manager.ts:60

Properties

files

files: CacheEntry[]

List of all shards in the cache, sorted by original URL (ascending order)

size

size: number

Size in bytes (total size of all shards).

A value of -1 means the model is deleted from the cache. You must call ModelManager.downloadModel to re-download the model.

url

url: string

URL to the GGUF file (in case it contains multiple shards, the URL should point to the first shard)

This URL will be used to identify the model in the cache. There can't be 2 models with the same URL.

Methods

open

open(): Promise<Blob[]>
Open and get a list of all shards as Blobs

Returns Promise<Blob[]>
- Defined in src/model-manager.ts:96

refresh

refresh(options?: DownloadOptions): Promise<void>
In case the model is invalid, call this function to re-download the model
Parameters
- options: DownloadOptions = {}
Returns Promise<void>
- Defined in src/model-manager.ts:142

remove

remove(): Promise<void>
Remove the model from the cache

Returns Promise<void>
- Defined in src/model-manager.ts:181

validate

validate(): ModelValidationStatus
Validate the model files.

If the model is invalid, the model manager will not be able to use it. You must call refresh to re-download the model.

Cases that model is invalid:
- The model is deleted from the cache
- The model files are missing (or the download is interrupted)
Returns ModelValidationStatus
- Defined in src/model-manager.ts:124

Class Model

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Model

Properties

files

size

url

Methods

open

Returns Promise<Blob[]>

refresh

Parameters

Returns Promise<void>

remove

Returns Promise<void>

validate

Returns ModelValidationStatus

Settings

On This Page