Type Alias: GgufMetadataGeneral<A>

type GgufMetadataGeneral<A>: {
  architecture: A;
  quantization_version: string;
  alignment: string;
  name: string;
  basename: string;
  size_label: string;
  author: string;
  url: string;
  description: string;
  license: string;
  license.name: string;
  license.link: string;
  source: {
     url: string;
     huggingface: {
        repository: string;
       };
    };
  file_type: GgufFileType;
  base_model: {
   [key: ${bigint}]: {
     name: string;
     author: string;
     version: string;
     organization: string;
     url: string;
     doi: string;
     uuid: string;
     repo_url: string;
    };   count: number;
    };
};

Type Parameters

Type Parameter	Default type
A extends GgufArchitectureType	GgufArchitectureType

Type declaration

architecture

readonly architecture: A;

quantization_version

readonly quantization_version: string;

The version of the quantization format. Not required if the model is not quantized (i.e. no tensors are quantized). If any tensors are quantized, this must be present. This is separate to the quantization scheme of the tensors itself; the quantization version may change without changing the scheme's name (e.g. the quantization scheme is Q5_K, and the quantization version is 4).

alignment?

readonly optional alignment: string;

the global alignment to use, as described above. This can vary to allow for different alignment schemes, but it must be a multiple of 8. Some writers may not write the alignment. If the alignment is not specified, assume it is 32.

name?

readonly optional name: string;

The name of the model. This should be a human-readable name that can be used to identify the model. It should be unique within the community that the model is defined in.

basename?

readonly optional basename: string;

size_label?

readonly optional size_label: string;

author?

readonly optional author: string;

url?

readonly optional url: string;

URL to the model's homepage. This can be a GitHub repo, a paper, etc.

description?

readonly optional description: string;

free-form description of the model including anything that isn't covered by the other fields

license?

readonly optional license: string;

License of the model, expressed as a SPDX license expression (e.g. MIT OR Apache-2.0). Should not include any other information, such as the license text or the URL to the license.

license.name?

readonly optional name: string;

license.link?

readonly optional link: string;

source?

readonly optional source: {
  url: string;
  huggingface: {
     repository: string;
    };
};

Information about where this model came from. This is useful for tracking the provenance of the model, and for finding the original source if the model is modified. For a model that was converted from GGML, for example, these keys would point to the model that was converted from.

source.url?

readonly optional url: string;

URL to the source of the model. Can be a GitHub repo, a paper, etc.

source.huggingface?

readonly optional huggingface: {
  repository: string;
};

source.huggingface.repository?

readonly optional repository: string;

file_type?

readonly optional file_type: GgufFileType;

An enumerated value describing the type of the majority of the tensors in the file. Optional; can be inferred from the tensor types.

base_model?

readonly optional base_model: {
[key: ${bigint}]: {
  name: string;
  author: string;
  version: string;
  organization: string;
  url: string;
  doi: string;
  uuid: string;
  repo_url: string;
 };   count: number;
};

Index Signature

[key: `${bigint}`]: { name: string; author: string; version: string; organization: string; url: string; doi: string; uuid: string; repo_url: string; }

base_model.count

readonly count: number;

Defined in

gguf/types/GgufMetadataTypes.ts:122