Class: Llama

Properties

onDispose

readonly onDispose: EventRelay<void>;

Defined in

bindings/Llama.ts:61

Accessors

disposed

get disposed(): boolean

Returns

boolean

Defined in

bindings/Llama.ts:138

---

classes

get classes(): LlamaClasses

Returns

LlamaClasses

Defined in

bindings/Llama.ts:142

---

gpu

get gpu(): LlamaGpuType

Returns

LlamaGpuType

Defined in

bindings/Llama.ts:149

---

supportsGpuOffloading

get supportsGpuOffloading(): boolean

Returns

boolean

Defined in

bindings/Llama.ts:153

---

supportsMmap

get supportsMmap(): boolean

Returns

boolean

Defined in

bindings/Llama.ts:157

---

supportsMlock

get supportsMlock(): boolean

Returns

boolean

Defined in

bindings/Llama.ts:161

---

cpuMathCores

get cpuMathCores(): number

The number of CPU cores that are useful for math

Returns

number

Defined in

bindings/Llama.ts:166

---

maxThreads

get maxThreads(): number

The maximum number of threads that can be used by the Llama instance.

If set to 0, the Llama instance will have no limit on the number of threads.

See the maxThreads option of getLlama for more information.

set maxThreads(value: number): void

Parameters

Parameter	Type
value	number

Returns

number

Defined in

bindings/Llama.ts:177

---

logLevel

get logLevel(): LlamaLogLevel

set logLevel(value: LlamaLogLevel): void

Parameters

Parameter	Type
value	LlamaLogLevel

Returns

LlamaLogLevel

Defined in

bindings/Llama.ts:185

---

logger

get logger(): (level: LlamaLogLevel, message: string) => void

set logger(value: (level: LlamaLogLevel, message: string) => void): void

Parameters

Parameter	Type
value	(level: LlamaLogLevel, message: string) => void

Returns

Function

Parameters

Parameter	Type
level	LlamaLogLevel
message	string

Returns

void

Defined in

bindings/Llama.ts:199

---

buildType

get buildType(): "localBuild" | "prebuilt"

Returns

"localBuild" | "prebuilt"

Defined in

bindings/Llama.ts:210

---

cmakeOptions

get cmakeOptions(): Readonly<Record<string, string>>

Returns

Readonly<Record<string, string>>

Defined in

bindings/Llama.ts:214

---

llamaCppRelease

get llamaCppRelease(): {
  repo: string;
  release: string;
}

Returns

{
  repo: string;
  release: string;
}

repo

readonly repo: string;

release

readonly release: string;

Defined in

bindings/Llama.ts:218

---

systemInfo

get systemInfo(): string

Returns

string

Defined in

bindings/Llama.ts:222

---

vramPaddingSize

get vramPaddingSize(): number

VRAM padding used for memory size calculations, as these calculations are not always accurate. This is set by default to ensure stability, but can be configured when you call getLlama.

See vramPadding on getLlama for more information.

Returns

number

Defined in

bindings/Llama.ts:234

Methods

dispose()

dispose(): Promise<void>

Returns

Promise<void>

Defined in

bindings/Llama.ts:123

---

getVramState()

getVramState(): Promise<{
  total: number;
  used: number;
  free: number;
 }>

Returns

Promise<{ total: number; used: number; free: number; }>

total

total: number;

used

used: number;

free

free: number;

Defined in

bindings/Llama.ts:238

---

getGpuDeviceNames()

getGpuDeviceNames(): Promise<string[]>

Returns

Promise<string[]>

Defined in

bindings/Llama.ts:250

---

loadModel()

loadModel(options: LlamaModelOptions): Promise<LlamaModel>

Parameters

Parameter	Type
options	LlamaModelOptions

Returns

Promise<LlamaModel>

Defined in

bindings/Llama.ts:258

---

createGrammarForJsonSchema()

createGrammarForJsonSchema<T>(schema: T): Promise<LlamaJsonSchemaGrammar<T>>

Type Parameters

Type Parameter
T extends Readonly<GbnfJsonSchema>

Parameters

Parameter	Type
schema	T

Returns

Promise<LlamaJsonSchemaGrammar<T>>

Defined in

bindings/Llama.ts:273

---

getGrammarFor()

getGrammarFor(type: 
  | "json"
  | "json_arr"
  | "list"
  | "c"
  | "arithmetic"
  | "japanese"
  | "chess"): Promise<LlamaGrammar>

Parameters

Parameter	Type
type	| "json" | "json_arr" | "list" | "c" | "arithmetic" | "japanese" | "chess"

Returns

Promise<LlamaGrammar>

Defined in

bindings/Llama.ts:277

---

createGrammar()

createGrammar(options: LlamaGrammarOptions): Promise<LlamaGrammar>

Parameters

Parameter	Type
options	LlamaGrammarOptions

Returns

Promise<LlamaGrammar>

Defined in

bindings/Llama.ts:281

---

defaultConsoleLogger()

static defaultConsoleLogger(level: LlamaLogLevel, message: string): void

Parameters

Parameter	Type
level	LlamaLogLevel
message	string

Returns

void

Defined in

bindings/Llama.ts:439