node-llama-cpp 3.0.0-beta.14 → 3.0.0-beta.15

package/dist/gguf/fileReaders/GgufNetworkFetchFileReader.js

@@ -0,0 +1,63 @@
+import retry from "async-retry";
+import { withLock } from "lifecycle-utils";
+import { GgufReadOffset } from "../utils/GgufReadOffset.js";
+import { defaultExtraAllocationSize, ggufDefaultFetchRetryOptions } from "../consts.js";
+import { GgufFileReader } from "./GgufFileReader.js";
+export class GgufNetworkFetchFileReader extends GgufFileReader {
+    url;
+    retryOptions;
+    headers;
+    _signal;
+    constructor({ url, retryOptions = ggufDefaultFetchRetryOptions, headers, signal }) {
+        super();
+        this.url = url;
+        this.retryOptions = retryOptions;
+        this.headers = headers ?? {};
+        this._signal = signal;
+    }
+    async readByteRange(offset, length) {
+        const readOffset = GgufReadOffset.resolveReadOffset(offset);
+        const endOffset = readOffset.offset + length;
+        if (endOffset >= this._buffer.length)
+            await this._fetchToExpandBufferUpToOffset(endOffset);
+        const res = this._buffer.subarray(readOffset.offset, endOffset);
+        readOffset.moveBy(length);
+        return res;
+    }
+    async _fetchToExpandBufferUpToOffset(endOffset, extraAllocationSize = defaultExtraAllocationSize) {
+        await withLock(this, "modifyBuffer", this._signal, async () => {
+            if (endOffset < this._buffer.length)
+                return;
+            const missingBytesBuffer = await retry(async (bail) => {
+                try {
+                    return await this._fetchByteRange(this._buffer.length, endOffset + extraAllocationSize - this._buffer.length);
+                }
+                catch (err) {
+                    if (this._signal?.aborted) {
+                        bail(this._signal.reason);
+                        throw this._signal.reason;
+                    }
+                    throw err;
+                }
+            }, this.retryOptions);
+            if (this._signal?.aborted)
+                throw this._signal.reason;
+            this._addToBuffer(missingBytesBuffer);
+        });
+    }
+    async _fetchByteRange(start, length) {
+        const response = await fetch(this.url, {
+            headers: {
+                ...this.headers,
+                Range: `bytes=${start}-${start + length}`,
+                accept: "*/*"
+            },
+            signal: this._signal
+        });
+        if (!response.ok)
+            throw new Error(`Failed to fetch byte range: ${response.status} ${response.statusText}`);
+        const arrayBuffer = await response.arrayBuffer();
+        return Buffer.from(arrayBuffer);
+    }
+}
+//# sourceMappingURL=GgufNetworkFetchFileReader.js.map

package/dist/gguf/fileReaders/GgufNetworkFetchFileReader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GgufNetworkFetchFileReader.js","sourceRoot":"","sources":["../../../src/gguf/fileReaders/GgufNetworkFetchFileReader.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,aAAa,CAAC;AAChC,OAAO,EAAC,QAAQ,EAAC,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAC,cAAc,EAAC,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAC,0BAA0B,EAAE,4BAA4B,EAAC,MAAM,cAAc,CAAC;AACtF,OAAO,EAAC,cAAc,EAAC,MAAM,qBAAqB,CAAC;AASnD,MAAM,OAAO,0BAA2B,SAAQ,cAAc;IAC1C,GAAG,CAAS;IACZ,YAAY,CAAgB;IAC5B,OAAO,CAAyB;IAC/B,OAAO,CAAe;IAEvC,YAAmB,EAAC,GAAG,EAAE,YAAY,GAAG,4BAA4B,EAAE,OAAO,EAAE,MAAM,EAA6B;QAC9G,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IAC1B,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,MAA+B,EAAE,MAAc;QACtE,MAAM,UAAU,GAAG,cAAc,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;QAC5D,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC;QAE7C,IAAI,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM;YAChC,MAAM,IAAI,CAAC,8BAA8B,CAAC,SAAS,CAAC,CAAC;QAEzD,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAChE,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1B,OAAO,GAAG,CAAC;IACf,CAAC;IAEO,KAAK,CAAC,8BAA8B,CAAC,SAAiB,EAAE,sBAA8B,0BAA0B;QACpH,MAAM,QAAQ,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;YAC1D,IAAI,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM;gBAC/B,OAAO;YAEX,MAAM,kBAAkB,GAAG,MAAM,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;gBAClD,IAAI;oBACA,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,GAAG,mBAAmB,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;iBACjH;gBAAC,OAAO,GAAG,EAAE;oBACV,IAAI,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE;wBACvB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;wBAC1B,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;qBAC7B;oBAED,MAAM,GAAG,CAAC;iBACb;YACL,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;YAEtB,IAAI,IAAI,CAAC,OAAO,EAAE,OAAO;gBACrB,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;YAE9B,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,KAAK,CAAC,eAAe,CAAC,KAAa,EAAE,MAAc;QACvD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE;YACnC,OAAO,EAAE;gBACL,GAAG,IAAI,CAAC,OAAO;gBACf,KAAK,EAAE,SAAS,KAAK,IAAI,KAAK,GAAG,MAAM,EAAE;gBACzC,MAAM,EAAE,KAAK;aAChB;YACD,MAAM,EAAE,IAAI,CAAC,OAAO;SACvB,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,+BAA+B,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;QAE7F,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC;QACjD,OAAO,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACpC,CAAC;CACJ"}

package/dist/gguf/parser/GgufV2Parser.d.ts

@@ -0,0 +1,19 @@
+import { GgufReadOffset } from "../utils/GgufReadOffset.js";
+import { GgufValueType, GgufVersionParserOptions, GgufVersionParserResult, MetadataKeyValueRecord, MetadataValue } from "../types/GgufFileInfoTypes.js";
+export declare class GgufV2Parser {
+    private readonly _fileReader;
+    private readonly _shouldReadTensorInfo;
+    private readonly _ignoreKeys;
+    private readonly _readOffset;
+    private readonly _logWarnings;
+    constructor({ fileReader, readTensorInfo, ignoreKeys, readOffset, logWarnings }: GgufVersionParserOptions);
+    parse(): Promise<GgufVersionParserResult>;
+    protected _readGgufValue(type: GgufValueType, offset: number | GgufReadOffset): Promise<MetadataValue>;
+    protected _readStringValue(offset: number | GgufReadOffset): Promise<string>;
+    protected _readRawHeader(readOffset: GgufReadOffset): Promise<{
+        tensorCount: number | bigint;
+        metadata: MetadataKeyValueRecord;
+        headerSize: number;
+    }>;
+    private _readTensorInfo;
+}

package/dist/gguf/parser/GgufV2Parser.js

@@ -0,0 +1,115 @@
+import { GgufFileReader, valueTypeToBytesToRead } from "../fileReaders/GgufFileReader.js";
+import { GgufReadOffset } from "../utils/GgufReadOffset.js";
+import { UnsupportedGgufValueTypeError } from "../errors/UnsupportedGgufValueTypeError.js";
+import { GgufValueType } from "../types/GgufFileInfoTypes.js";
+import { convertMetadataKeyValueRecordToNestedObject } from "../utils/convertMetadataKeyValueRecordToNestedObject.js";
+export class GgufV2Parser {
+    _fileReader;
+    _shouldReadTensorInfo;
+    _ignoreKeys;
+    _readOffset;
+    _logWarnings;
+    constructor({ fileReader, readTensorInfo = true, ignoreKeys = [], readOffset, logWarnings }) {
+        this._fileReader = fileReader;
+        this._shouldReadTensorInfo = readTensorInfo;
+        this._ignoreKeys = ignoreKeys;
+        this._readOffset = readOffset;
+        this._logWarnings = logWarnings;
+    }
+    async parse() {
+        const readOffset = this._readOffset;
+        const initialOffset = readOffset.offset;
+        const headerReadResult = await this._readRawHeader(readOffset);
+        const tensorReadResult = this._shouldReadTensorInfo
+            ? await this._readTensorInfo(headerReadResult.tensorCount, readOffset)
+            : null;
+        const metadata = convertMetadataKeyValueRecordToNestedObject(headerReadResult.metadata, {
+            logOverrideWarnings: this._logWarnings,
+            ignoreKeys: this._ignoreKeys
+        });
+        return {
+            tensorCount: headerReadResult.tensorCount,
+            metadata: metadata,
+            tensorInfo: tensorReadResult?.tensorInfo,
+            metadataSize: headerReadResult.headerSize + initialOffset,
+            tensorInfoSize: tensorReadResult?.tensorInfoSize
+        };
+    }
+    async _readGgufValue(type, offset) {
+        const readOffset = GgufReadOffset.resolveReadOffset(offset);
+        switch (type) {
+            case GgufValueType.Uint8: return await this._fileReader.readUint8(readOffset);
+            case GgufValueType.Int8: return await this._fileReader.readInt8(readOffset);
+            case GgufValueType.Uint16: return await this._fileReader.readUint16(readOffset);
+            case GgufValueType.Int16: return await this._fileReader.readInt16(readOffset);
+            case GgufValueType.Uint32: return await this._fileReader.readUint32(readOffset);
+            case GgufValueType.Int32: return await this._fileReader.readInt32(readOffset);
+            case GgufValueType.Float32: return await this._fileReader.readFloat32(readOffset);
+            case GgufValueType.Bool: return await this._fileReader.readBool(readOffset);
+            case GgufValueType.String: return await this._readStringValue(readOffset);
+            case GgufValueType.Uint64: return await this._fileReader.readUint64(readOffset);
+            case GgufValueType.Int64: return await this._fileReader.readInt64(readOffset);
+            case GgufValueType.Float64: return await this._fileReader.readFloat64(readOffset);
+        }
+        if (type === GgufValueType.Array) {
+            const arrayType = await this._fileReader.readUint32(readOffset);
+            const arrayLength = await this._fileReader.readUint64(readOffset);
+            const arrayValues = [];
+            for (let i = 0; i < arrayLength; i++) {
+                const value = await this._readGgufValue(arrayType, readOffset);
+                arrayValues.push(value);
+            }
+            return arrayValues;
+        }
+        throw new UnsupportedGgufValueTypeError(type);
+    }
+    async _readStringValue(offset) {
+        const readOffset = GgufReadOffset.resolveReadOffset(offset);
+        const length = Number(await this._fileReader.readUint64(readOffset));
+        const readLength = valueTypeToBytesToRead.uint8 * length;
+        const stringBytes = await this._fileReader.readByteRange(readOffset, readLength);
+        return String.fromCharCode(...stringBytes);
+    }
+    async _readRawHeader(readOffset) {
+        const initialOffset = readOffset.offset;
+        const tensorCount = await this._fileReader.readUint64(readOffset);
+        const metadataKVCount = Number(await this._fileReader.readUint64(readOffset));
+        const metadata = {};
+        for (let i = 0; i < metadataKVCount; i++) {
+            const keyResult = await this._readStringValue(readOffset);
+            const valueType = await this._fileReader.readUint32(readOffset);
+            metadata[keyResult] = await this._readGgufValue(valueType, readOffset);
+        }
+        return {
+            tensorCount: GgufFileReader.castNumberIfSafe(tensorCount),
+            metadata: metadata,
+            headerSize: readOffset.offset - initialOffset
+        };
+    }
+    async _readTensorInfo(tensorCount, readOffset) {
+        const initialOffset = readOffset.offset;
+        const tensorInfo = [];
+        for (let i = 0n; i < BigInt(tensorCount); i++) {
+            const name = await this._readStringValue(readOffset);
+            const dimensionsNumber = await this._fileReader.readUint32(readOffset);
+            const dimensions = [];
+            for (let i = 0; i < dimensionsNumber; i++) {
+                const dimension = await this._fileReader.readUint64(readOffset);
+                dimensions.push(GgufFileReader.castNumberIfSafe(dimension));
+            }
+            const ggmlType = await this._fileReader.readUint32(readOffset);
+            const offset = await this._fileReader.readUint64(readOffset);
+            tensorInfo.push({
+                name,
+                dimensions,
+                ggmlType: ggmlType,
+                offset: GgufFileReader.castNumberIfSafe(offset)
+            });
+        }
+        return {
+            tensorInfo,
+            tensorInfoSize: readOffset.offset - initialOffset
+        };
+    }
+}
+//# sourceMappingURL=GgufV2Parser.js.map

package/dist/gguf/parser/GgufV2Parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GgufV2Parser.js","sourceRoot":"","sources":["../../../src/gguf/parser/GgufV2Parser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,cAAc,EAAE,sBAAsB,EAAC,MAAM,kCAAkC,CAAC;AACxF,OAAO,EAAC,cAAc,EAAC,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAC,6BAA6B,EAAC,MAAM,4CAA4C,CAAC;AACzF,OAAO,EACH,aAAa,EAChB,MAAM,+BAA+B,CAAC;AAGvC,OAAO,EAAC,2CAA2C,EAAC,MAAM,yDAAyD,CAAC;AAEpH,MAAM,OAAO,YAAY;IACJ,WAAW,CAAiB;IAC5B,qBAAqB,CAAU;IAC/B,WAAW,CAAW;IACtB,WAAW,CAAiB;IAC5B,YAAY,CAAU;IAEvC,YAAmB,EAAC,UAAU,EAAE,cAAc,GAAG,IAAI,EAAE,UAAU,GAAG,EAAE,EAAE,UAAU,EAAE,WAAW,EAA2B;QACtH,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,qBAAqB,GAAG,cAAc,CAAC;QAC5C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IACpC,CAAC;IAEM,KAAK,CAAC,KAAK;QACd,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC;QACpC,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,CAAC;QAExC,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QAC/D,MAAM,gBAAgB,GAAG,IAAI,CAAC,qBAAqB;YAC/C,CAAC,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,WAAW,EAAE,UAAU,CAAC;YACtE,CAAC,CAAC,IAAI,CAAC;QACX,MAAM,QAAQ,GAAG,2CAA2C,CAAC,gBAAgB,CAAC,QAAQ,EAAE;YACpF,mBAAmB,EAAE,IAAI,CAAC,YAAY;YACtC,UAAU,EAAE,IAAI,CAAC,WAAW;SAC/B,CAAC,CAAC;QAEH,OAAO;YACH,WAAW,EAAE,gBAAgB,CAAC,WAAW;YACzC,QAAQ,EAAE,QAA+B;YACzC,UAAU,EAAE,gBAAgB,EAAE,UAAU;YACxC,YAAY,EAAE,gBAAgB,CAAC,UAAU,GAAG,aAAa;YACzD,cAAc,EAAE,gBAAgB,EAAE,cAAc;SACnD,CAAC;IACN,CAAC;IAES,KAAK,CAAC,cAAc,CAAC,IAAmB,EAAE,MAA+B;QAC/E,MAAM,UAAU,GAAG,cAAc,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;QAE5D,QAAQ,IAAI,EAAE;YACV,KAAK,aAAa,CAAC,KAAK,CAAC,CAAC,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;YAC9E,KAAK,aAAa,CAAC,IAAI,CAAC,CAAC,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YAC5E,KAAK,aAAa,CAAC,MAAM,CAAC,CAAC,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAChF,KAAK,aAAa,CAAC,KAAK,CAAC,CAAC,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;YAC9E,KAAK,aAAa,CAAC,MAAM,CAAC,CAAC,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAChF,KAAK,aAAa,CAAC,KAAK,CAAC,CAAC,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;YAC9E,KAAK,aAAa,CAAC,OAAO,CAAC,CAAC,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;YAClF,KAAK,aAAa,CAAC,IAAI,CAAC,CAAC,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YAC5E,KAAK,aAAa,CAAC,MAAM,CAAC,CAAC,OAAO,MAAM,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;YAC1E,KAAK,aAAa,CAAC,MAAM,CAAC,CAAC,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAChF,KAAK,aAAa,CAAC,KAAK,CAAC,CAAC,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;YAC9E,KAAK,aAAa,CAAC,OAAO,CAAC,CAAC,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;SACrF;QAED,IAAI,IAAI,KAAK,aAAa,CAAC,KAAK,EAAE;YAC9B,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAChE,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAElE,MAAM,WAAW,GAAoB,EAAE,CAAC;YACxC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,EAAE,CAAC,EAAE,EAAE;gBAClC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;gBAC/D,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aAC3B;YACD,OAAO,WAAW,CAAC;SACtB;QAED,MAAM,IAAI,6BAA6B,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IAES,KAAK,CAAC,gBAAgB,CAAC,MAA+B;QAC5D,MAAM,UAAU,GAAG,cAAc,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;QAC5D,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;QAErE,MAAM,UAAU,GAAG,sBAAsB,CAAC,KAAK,GAAG,MAAM,CAAC;QACzD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAEjF,OAAO,MAAM,CAAC,YAAY,CAAC,GAAG,WAAW,CAAC,CAAC;IAC/C,CAAC;IAES,KAAK,CAAC,cAAc,CAAC,UAA0B;QACrD,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,CAAC;QAExC,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAClE,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;QAE9E,MAAM,QAAQ,GAA2B,EAAE,CAAC;QAE5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,eAAe,EAAE,CAAC,EAAE,EAAE;YACtC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;YAC1D,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAChE,QAAQ,CAAC,SAAS,CAAC,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;SAC1E;QAED,OAAO;YACH,WAAW,EAAE,cAAc,CAAC,gBAAgB,CAAC,WAAW,CAAC;YACzD,QAAQ,EAAE,QAAQ;YAClB,UAAU,EAAE,UAAU,CAAC,MAAM,GAAG,aAAa;SAChD,CAAC;IACN,CAAC;IAEO,KAAK,CAAC,eAAe,CAAC,WAA4B,EAAE,UAA0B;QAClF,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,CAAC;QACxC,MAAM,UAAU,GAAqB,EAAE,CAAC;QAExC,KAAK,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,EAAE;YAC3C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YACvE,MAAM,UAAU,GAAwB,EAAE,CAAC;YAE3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,gBAAgB,EAAE,CAAC,EAAE,EAAE;gBACvC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;gBAChE,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;aAC/D;YAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAC/D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAE7D,UAAU,CAAC,IAAI,CAAC;gBACZ,IAAI;gBACJ,UAAU;gBACV,QAAQ,EAAE,QAAoB;gBAC9B,MAAM,EAAE,cAAc,CAAC,gBAAgB,CAAC,MAAM,CAAC;aAClD,CAAC,CAAC;SACN;QAED,OAAO;YACH,UAAU;YACV,cAAc,EAAE,UAAU,CAAC,MAAM,GAAG,aAAa;SACpD,CAAC;IACN,CAAC;CACJ"}

package/dist/gguf/parser/GgufV3Parser.d.ts

@@ -0,0 +1,3 @@
+import { GgufV2Parser } from "./GgufV2Parser.js";
+export declare class GgufV3Parser extends GgufV2Parser {
+}

package/dist/gguf/parser/GgufV3Parser.js

@@ -0,0 +1,4 @@
+import { GgufV2Parser } from "./GgufV2Parser.js";
+export class GgufV3Parser extends GgufV2Parser {
+}
+//# sourceMappingURL=GgufV3Parser.js.map

package/dist/gguf/parser/GgufV3Parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GgufV3Parser.js","sourceRoot":"","sources":["../../../src/gguf/parser/GgufV3Parser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,mBAAmB,CAAC;AAE/C,MAAM,OAAO,YAAa,SAAQ,YAAY;CAE7C"}

package/dist/gguf/parser/parseGguf.d.ts

@@ -0,0 +1,8 @@
+import { GgufFileReader } from "../fileReaders/GgufFileReader.js";
+import { GgufFileInfo } from "../types/GgufFileInfoTypes.js";
+export declare function parseGguf({ fileReader, readTensorInfo, ignoreKeys, logWarnings }: {
+    fileReader: GgufFileReader;
+    readTensorInfo?: boolean;
+    ignoreKeys?: string[];
+    logWarnings?: boolean;
+}): Promise<GgufFileInfo>;

package/dist/gguf/parser/parseGguf.js

@@ -0,0 +1,58 @@
+import { InvalidGgufMagicError } from "../errors/InvalidGgufMagicError.js";
+import { getConsoleLogPrefix } from "../../utils/getConsoleLogPrefix.js";
+import { UnsupportedError } from "../../utils/UnsupportedError.js";
+import { GgufReadOffset } from "../utils/GgufReadOffset.js";
+import { valueTypeToBytesToRead } from "../fileReaders/GgufFileReader.js";
+import { getGgufMetadataArchitectureData } from "../utils/getGgufMetadataArchitectureData.js";
+import { GgufV2Parser } from "./GgufV2Parser.js";
+import { GgufV3Parser } from "./GgufV3Parser.js";
+const ggufMagic = "GGUF";
+export async function parseGguf({ fileReader, readTensorInfo = true, ignoreKeys = [], logWarnings = true }) {
+    const readOffset = new GgufReadOffset(0);
+    const magicAndVersion = await parseMagicAndVersion(fileReader, readOffset);
+    const gguifInfo = await parseGgufUsingASpecificVersionParser({
+        fileReader,
+        readTensorInfo,
+        ignoreKeys,
+        version: magicAndVersion.version,
+        readOffset,
+        logWarnings
+    });
+    const architectureMetadata = getGgufMetadataArchitectureData(gguifInfo.metadata);
+    return {
+        version: magicAndVersion.version,
+        tensorCount: gguifInfo.tensorCount,
+        metadata: gguifInfo.metadata,
+        architectureMetadata: architectureMetadata,
+        tensorInfo: gguifInfo.tensorInfo,
+        metadataSize: gguifInfo.metadataSize,
+        tensorInfoSize: gguifInfo.tensorInfoSize
+    };
+}
+async function parseMagicAndVersion(fileReader, readOffset) {
+    const fileMagicBytes = await fileReader.readByteRange(readOffset, valueTypeToBytesToRead.uint8 * ggufMagic.length);
+    const fileMagicText = String.fromCharCode(...fileMagicBytes);
+    if (fileMagicText !== ggufMagic)
+        throw new InvalidGgufMagicError(ggufMagic, fileMagicText);
+    const version = await fileReader.readUint32(readOffset);
+    return {
+        magic: ggufMagic,
+        version
+    };
+}
+async function parseGgufUsingASpecificVersionParser(specificVersionParserOptions) {
+    switch (specificVersionParserOptions.version) {
+        case 1:
+            throw new UnsupportedError("GGUF version 1 is not supported by llama.cpp anymore");
+        case 2:
+            return await (new GgufV2Parser(specificVersionParserOptions)).parse();
+        case 3:
+            return await (new GgufV3Parser(specificVersionParserOptions)).parse();
+        default:
+            if (specificVersionParserOptions.logWarnings)
+                console.warn(getConsoleLogPrefix() +
+                    `Unsupported GGUF version "${specificVersionParserOptions.version}". Reading the file as GGUF version 3`);
+            return await (new GgufV3Parser(specificVersionParserOptions)).parse();
+    }
+}
+//# sourceMappingURL=parseGguf.js.map

package/dist/gguf/parser/parseGguf.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseGguf.js","sourceRoot":"","sources":["../../../src/gguf/parser/parseGguf.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,qBAAqB,EAAC,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAC,mBAAmB,EAAC,MAAM,oCAAoC,CAAC;AACvE,OAAO,EAAC,gBAAgB,EAAC,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAC,cAAc,EAAC,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAiB,sBAAsB,EAAC,MAAM,kCAAkC,CAAC;AAExF,OAAO,EAAC,+BAA+B,EAAC,MAAM,6CAA6C,CAAC;AAC5F,OAAO,EAAC,YAAY,EAAC,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAC,YAAY,EAAC,MAAM,mBAAmB,CAAC;AAE/C,MAAM,SAAS,GAAG,MAAM,CAAC;AAEzB,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,EAC5B,UAAU,EACV,cAAc,GAAG,IAAI,EACrB,UAAU,GAAG,EAAE,EACf,WAAW,GAAG,IAAI,EAMrB;IACG,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC;IACzC,MAAM,eAAe,GAAG,MAAM,oBAAoB,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAC3E,MAAM,SAAS,GAAG,MAAM,oCAAoC,CAAC;QACzD,UAAU;QACV,cAAc;QACd,UAAU;QAEV,OAAO,EAAE,eAAe,CAAC,OAAO;QAChC,UAAU;QACV,WAAW;KACd,CAAC,CAAC;IACH,MAAM,oBAAoB,GAAG,+BAA+B,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAEjF,OAAO;QACH,OAAO,EAAE,eAAe,CAAC,OAAO;QAChC,WAAW,EAAE,SAAS,CAAC,WAAW;QAClC,QAAQ,EAAE,SAAS,CAAC,QAAQ;QAC5B,oBAAoB,EAAE,oBAAoB;QAC1C,UAAU,EAAE,SAAS,CAAC,UAAU;QAChC,YAAY,EAAE,SAAS,CAAC,YAAY;QACpC,cAAc,EAAE,SAAS,CAAC,cAAc;KAC3C,CAAC;AACN,CAAC;AAED,KAAK,UAAU,oBAAoB,CAAC,UAA0B,EAAE,UAA0B;IACtF,MAAM,cAAc,GAAG,MAAM,UAAU,CAAC,aAAa,CAAC,UAAU,EAAE,sBAAsB,CAAC,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;IACnH,MAAM,aAAa,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,cAAc,CAAC,CAAC;IAE7D,IAAI,aAAa,KAAK,SAAS;QAC3B,MAAM,IAAI,qBAAqB,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;IAE9D,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IAExD,OAAO;QACH,KAAK,EAAE,SAAS;QAChB,OAAO;KACV,CAAC;AACN,CAAC;AAED,KAAK,UAAU,oCAAoC,CAC/C,4BAAsD;IAEtD,QAAQ,4BAA4B,CAAC,OAAO,EAAE;QAC1C,KAAK,CAAC;YACF,MAAM,IAAI,gBAAgB,CAAC,sDAAsD,CAAC,CAAC;QAEvF,KAAK,CAAC;YACF,OAAO,MAAM,CAAC,IAAI,YAAY,CAAC,4BAA4B,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;QAE1E,KAAK,CAAC;YACF,OAAO,MAAM,CAAC,IAAI,YAAY,CAAC,4BAA4B,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;QAE1E;YACI,IAAI,4BAA4B,CAAC,WAAW;gBACxC,OAAO,CAAC,IAAI,CACR,mBAAmB,EAAE;oBACrB,6BAA6B,4BAA4B,CAAC,OAAO,uCAAuC,CAC3G,CAAC;YAEN,OAAO,MAAM,CAAC,IAAI,YAAY,CAAC,4BAA4B,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;KAC7E;AACL,CAAC"}

package/dist/gguf/readGgufFileInfo.d.ts

@@ -0,0 +1,30 @@
+/// <reference types="node" />
+import retry from "async-retry";
+/**
+ * Read a GGUF file and return its metadata and tensor info (unless `readTensorInfo` is set to `false`).
+ * Only the parts of the file required for the metadata and tensor info are read.
+ */
+export declare function readGgufFileInfo(pathOrUrl: string, { readTensorInfo, sourceType, ignoreKeys, logWarnings, fetchRetryOptions, fetchHeaders, signal }?: {
+    /**
+     * Whether to read the tensor info from the file's header
+     * Enabled by default.
+     */
+    readTensorInfo?: boolean;
+    /**
+     * Set to a specific value to force it to only use that source type.
+     * By default, it detects whether the path is a network URL or a filesystem path and uses the appropriate reader accordingly.
+     */
+    sourceType?: "network" | "filesystem";
+    /**
+     * Metadata keys to ignore when parsing the metadata.
+     * For example, `["tokenizer.ggml.tokens"]`
+     */
+    ignoreKeys?: string[];
+    /** Whether to log warnings */
+    logWarnings?: boolean;
+    /** Relevant only when fetching from a network */
+    fetchRetryOptions?: retry.Options;
+    /** Relevant only when fetching from a network */
+    fetchHeaders?: Record<string, string>;
+    signal?: AbortSignal;
+}): Promise<import("./types/GgufFileInfoTypes.js").GgufFileInfo>;

package/dist/gguf/readGgufFileInfo.js

@@ -0,0 +1,37 @@
+import { parseGguf } from "./parser/parseGguf.js";
+import { GgufNetworkFetchFileReader } from "./fileReaders/GgufNetworkFetchFileReader.js";
+import { GgufFsFileReader } from "./fileReaders/GgufFsFileReader.js";
+import { ggufDefaultFetchRetryOptions } from "./consts.js";
+import { normalizeGgufDownloadUrl } from "./utils/normalizeGgufDownloadUrl.js";
+/**
+ * Read a GGUF file and return its metadata and tensor info (unless `readTensorInfo` is set to `false`).
+ * Only the parts of the file required for the metadata and tensor info are read.
+ */
+export async function readGgufFileInfo(pathOrUrl, { readTensorInfo = true, sourceType, ignoreKeys = [], logWarnings = true, fetchRetryOptions = ggufDefaultFetchRetryOptions, fetchHeaders = {}, signal } = {}) {
+    function createFileReader() {
+        if (sourceType === "network" || (sourceType == null && (pathOrUrl.startsWith("http://") || pathOrUrl.startsWith("https://")))) {
+            return new GgufNetworkFetchFileReader({
+                url: normalizeGgufDownloadUrl(pathOrUrl),
+                retryOptions: fetchRetryOptions,
+                headers: fetchHeaders,
+                signal
+            });
+        }
+        else if (sourceType === "filesystem" || sourceType == null) {
+            return new GgufFsFileReader({
+                filePath: pathOrUrl,
+                signal
+            });
+        }
+        void (sourceType);
+        throw new Error(`Unsupported sourceType: ${sourceType}`);
+    }
+    const fileReader = createFileReader();
+    return await parseGguf({
+        fileReader,
+        ignoreKeys,
+        readTensorInfo,
+        logWarnings
+    });
+}
+//# sourceMappingURL=readGgufFileInfo.js.map

package/dist/gguf/readGgufFileInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"readGgufFileInfo.js","sourceRoot":"","sources":["../../src/gguf/readGgufFileInfo.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,SAAS,EAAC,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAC,0BAA0B,EAAC,MAAM,6CAA6C,CAAC;AACvF,OAAO,EAAC,gBAAgB,EAAC,MAAM,mCAAmC,CAAC;AACnE,OAAO,EAAC,4BAA4B,EAAC,MAAM,aAAa,CAAC;AACzD,OAAO,EAAC,wBAAwB,EAAC,MAAM,qCAAqC,CAAC;AAG7E;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,SAAiB,EAAE,EACtD,cAAc,GAAG,IAAI,EACrB,UAAU,EACV,UAAU,GAAG,EAAE,EACf,WAAW,GAAG,IAAI,EAClB,iBAAiB,GAAG,4BAA4B,EAChD,YAAY,GAAG,EAAE,EACjB,MAAM,KA8BN,EAAE;IACF,SAAS,gBAAgB;QACrB,IAAI,UAAU,KAAK,SAAS,IAAI,CAAC,UAAU,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE;YAC3H,OAAO,IAAI,0BAA0B,CAAC;gBAClC,GAAG,EAAE,wBAAwB,CAAC,SAAS,CAAC;gBACxC,YAAY,EAAE,iBAAiB;gBAC/B,OAAO,EAAE,YAAY;gBACrB,MAAM;aACT,CAAC,CAAC;SACN;aAAM,IAAI,UAAU,KAAK,YAAY,IAAI,UAAU,IAAI,IAAI,EAAE;YAC1D,OAAO,IAAI,gBAAgB,CAAC;gBACxB,QAAQ,EAAE,SAAS;gBACnB,MAAM;aACT,CAAC,CAAC;SACN;QAED,KAAK,CAAC,UAA0B,CAAC,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,2BAA2B,UAAU,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED,MAAM,UAAU,GAAG,gBAAgB,EAAE,CAAC;IACtC,OAAO,MAAM,SAAS,CAAC;QACnB,UAAU;QACV,UAAU;QACV,cAAc;QACd,WAAW;KACd,CAAC,CAAC;AACP,CAAC"}

package/dist/gguf/types/GgufFileInfoTypes.d.ts

@@ -0,0 +1,52 @@
+import type { GgufReadOffset } from "../utils/GgufReadOffset.js";
+import type { GgufFileReader } from "../fileReaders/GgufFileReader.js";
+import type { MergeOptionalUnionTypes } from "../../utils/mergeUnionTypes.js";
+import type { GgufArchitectureType, GgufMetadata } from "./GgufMetadataTypes.js";
+import type { GgufTensorInfo } from "./GgufTensorInfoTypes.js";
+export type MetadataValue = string | number | bigint | boolean | MetadataValue[];
+export type MetadataKeyValueRecord = Record<string, MetadataValue>;
+export type MetadataNestedObject = {
+    [key: string]: MetadataValue | MetadataNestedObject;
+};
+export type GgufFileInfo = {
+    readonly version: 2 | 3 | number;
+    readonly tensorCount: number | bigint;
+    readonly metadata: GgufMetadata;
+    readonly metadataSize: number;
+    /** Same value as `metadata[metadata.general.architecture]`, but with merged types for convenience */
+    readonly architectureMetadata: MergeOptionalUnionTypes<Exclude<GgufMetadata[GgufArchitectureType], undefined>>;
+    /** can be null if `readTensorInfo` is set to `false` */
+    readonly tensorInfo?: GgufTensorInfo[];
+    /** can be null if `readTensorInfo` is set to `false` */
+    readonly tensorInfoSize?: number;
+};
+export declare const enum GgufValueType {
+    Uint8 = 0,
+    Int8 = 1,
+    Uint16 = 2,
+    Int16 = 3,
+    Uint32 = 4,
+    Int32 = 5,
+    Float32 = 6,
+    Bool = 7,
+    String = 8,
+    Array = 9,
+    Uint64 = 10,
+    Int64 = 11,
+    Float64 = 12
+}
+export type GgufVersionParserOptions = {
+    fileReader: GgufFileReader;
+    readTensorInfo?: boolean;
+    ignoreKeys?: string[];
+    version: number;
+    readOffset: GgufReadOffset;
+    logWarnings: boolean;
+};
+export type GgufVersionParserResult = {
+    tensorCount: number | bigint;
+    metadata: GgufMetadata;
+    tensorInfo?: GgufTensorInfo[];
+    metadataSize: number;
+    tensorInfoSize?: number;
+};

package/dist/gguf/types/GgufFileInfoTypes.js

@@ -0,0 +1,18 @@
+// source: `enum gguf_type` in `ggml.h` in the `llama.cpp` source code
+export var GgufValueType;
+(function (GgufValueType) {
+    GgufValueType[GgufValueType["Uint8"] = 0] = "Uint8";
+    GgufValueType[GgufValueType["Int8"] = 1] = "Int8";
+    GgufValueType[GgufValueType["Uint16"] = 2] = "Uint16";
+    GgufValueType[GgufValueType["Int16"] = 3] = "Int16";
+    GgufValueType[GgufValueType["Uint32"] = 4] = "Uint32";
+    GgufValueType[GgufValueType["Int32"] = 5] = "Int32";
+    GgufValueType[GgufValueType["Float32"] = 6] = "Float32";
+    GgufValueType[GgufValueType["Bool"] = 7] = "Bool";
+    GgufValueType[GgufValueType["String"] = 8] = "String";
+    GgufValueType[GgufValueType["Array"] = 9] = "Array";
+    GgufValueType[GgufValueType["Uint64"] = 10] = "Uint64";
+    GgufValueType[GgufValueType["Int64"] = 11] = "Int64";
+    GgufValueType[GgufValueType["Float64"] = 12] = "Float64";
+})(GgufValueType || (GgufValueType = {}));
+//# sourceMappingURL=GgufFileInfoTypes.js.map

package/dist/gguf/types/GgufFileInfoTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GgufFileInfoTypes.js","sourceRoot":"","sources":["../../../src/gguf/types/GgufFileInfoTypes.ts"],"names":[],"mappings":"AA6BA,sEAAsE;AACtE,MAAM,CAAN,IAAkB,aAcjB;AAdD,WAAkB,aAAa;IAC3B,mDAAS,CAAA;IACT,iDAAQ,CAAA;IACR,qDAAU,CAAA;IACV,mDAAS,CAAA;IACT,qDAAU,CAAA;IACV,mDAAS,CAAA;IACT,uDAAW,CAAA;IACX,iDAAQ,CAAA;IACR,qDAAU,CAAA;IACV,mDAAS,CAAA;IACT,sDAAW,CAAA;IACX,oDAAU,CAAA;IACV,wDAAY,CAAA;AAChB,CAAC,EAdiB,aAAa,KAAb,aAAa,QAc9B"}