node-llama-cpp

Appearance

Type Alias: LastBuildOptions ​

ts
type LastBuildOptions = {
  logLevel?: LlamaLogLevel;
  logger?: (level: LlamaLogLevel, message: string) => void;
  usePrebuiltBinaries?: boolean;
  progressLogs?: boolean;
  skipDownload?: boolean;
  maxThreads?: number;
  vramPadding?: number | (totalVram: number) => number;
  ramPadding?: number | (totalRam: number) => number;
  debug?: boolean;
  dryRun?: boolean;
};

Defined in: bindings/getLlama.ts:177

Properties ​

logLevel? ​

ts
optional logLevel: LlamaLogLevel;

Defined in: bindings/getLlama.ts:182

Set the minimum log level for llama.cpp. Defaults to "warn".

logger()? ​

ts
optional logger: (level: LlamaLogLevel, message: string) => void;

Defined in: bindings/getLlama.ts:187

Set a custom logger for llama.cpp logs.

Parameters ​

ParameterType
levelLlamaLogLevel
messagestring

Returns ​

void

usePrebuiltBinaries? ​

ts
optional usePrebuiltBinaries: boolean;

Defined in: bindings/getLlama.ts:193

If a local build is not found, use prebuilt binaries. Enabled by default.

progressLogs? ​

ts
optional progressLogs: boolean;

Defined in: bindings/getLlama.ts:200

If a local build is not found, and prebuilt binaries are not found, when building from source, print binary compilation progress logs. Enabled by default.

skipDownload? ​

ts
optional skipDownload: boolean;

Defined in: bindings/getLlama.ts:207

If a local build is not found, and prebuilt binaries are not found, don't download llama.cpp source if it's not found. When set to true, and llama.cpp source is needed but is not found, a NoBinaryFoundError error will be thrown. Disabled by default.

maxThreads? ​

ts
optional maxThreads: number;

Defined in: bindings/getLlama.ts:218

The maximum number of threads to use for the Llama instance.

Set to 0 to have no thread limit.

When not using a GPU, defaults to the number of CPU cores that are useful for math (.cpuMathCores), or 4, whichever is higher.

When using a GPU, there's no limit by default.

vramPadding? ​

ts
optional vramPadding: number | (totalVram: number) => number;

Defined in: bindings/getLlama.ts:228

Pad the available VRAM for the memory size calculations, as these calculations are not always accurate. Recommended to ensure stability. This only affects the calculations of "auto" in function options and is not reflected in the getVramState function.

Defaults to 6% of the total VRAM or 1GB, whichever is lower. Set to 0 to disable.

ramPadding? ​

ts
optional ramPadding: number | (totalRam: number) => number;

Defined in: bindings/getLlama.ts:239

Pad the available RAM for the memory size calculations, as these calculations are not always accurate. Recommended to ensure stability.

Defaults to 25% of the total RAM or 6GB (1GB on Linux), whichever is lower. Set to 0 to disable.

Since the OS also needs RAM to function, the default value can get up to 6GB on Windows and macOS, and 1GB on Linux.

debug? ​

ts
optional debug: boolean;

Defined in: bindings/getLlama.ts:249

Enable debug mode to find issues with llama.cpp. Makes logs print directly to the console from llama.cpp and not through the provided logger.

Defaults to false.

The default can be set using the NODE_LLAMA_CPP_DEBUG environment variable.

dryRun? ​

ts
optional dryRun: boolean;

Defined in: bindings/getLlama.ts:264

Loads existing binaries without loading the llama.cpp backend, and then disposes the returned Llama instance right away before returning it.

Useful for performing a fast and efficient test to check whether the given configuration can be loaded. Can be used for determining which GPU types the current machine supports before actually using them.

Enabling this option implies that build: "never" and skipDownload: true.

The returned Llama instance will be disposed and cannot be used.

Defaults to false.