constants.py 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564
  1. from __future__ import annotations
  2. import sys
  3. from enum import Enum, IntEnum, auto
  4. from typing import Any
  5. #
  6. # constants
  7. #
  8. GGUF_MAGIC = 0x46554747 # "GGUF"
  9. GGUF_VERSION = 3
  10. GGUF_DEFAULT_ALIGNMENT = 32
  11. #
  12. # metadata keys
  13. #
  14. class Keys:
  15. class General:
  16. ARCHITECTURE = "general.architecture"
  17. QUANTIZATION_VERSION = "general.quantization_version"
  18. ALIGNMENT = "general.alignment"
  19. NAME = "general.name"
  20. AUTHOR = "general.author"
  21. URL = "general.url"
  22. DESCRIPTION = "general.description"
  23. LICENSE = "general.license"
  24. SOURCE_URL = "general.source.url"
  25. SOURCE_HF_REPO = "general.source.huggingface.repository"
  26. FILE_TYPE = "general.file_type"
  27. class LLM:
  28. CONTEXT_LENGTH = "{arch}.context_length"
  29. EMBEDDING_LENGTH = "{arch}.embedding_length"
  30. BLOCK_COUNT = "{arch}.block_count"
  31. FEED_FORWARD_LENGTH = "{arch}.feed_forward_length"
  32. USE_PARALLEL_RESIDUAL = "{arch}.use_parallel_residual"
  33. TENSOR_DATA_LAYOUT = "{arch}.tensor_data_layout"
  34. EXPERT_COUNT = "{arch}.expert_count"
  35. EXPERT_USED_COUNT = "{arch}.expert_used_count"
  36. class Attention:
  37. HEAD_COUNT = "{arch}.attention.head_count"
  38. HEAD_COUNT_KV = "{arch}.attention.head_count_kv"
  39. MAX_ALIBI_BIAS = "{arch}.attention.max_alibi_bias"
  40. CLAMP_KQV = "{arch}.attention.clamp_kqv"
  41. LAYERNORM_EPS = "{arch}.attention.layer_norm_epsilon"
  42. LAYERNORM_RMS_EPS = "{arch}.attention.layer_norm_rms_epsilon"
  43. class Rope:
  44. DIMENSION_COUNT = "{arch}.rope.dimension_count"
  45. FREQ_BASE = "{arch}.rope.freq_base"
  46. SCALING_TYPE = "{arch}.rope.scaling.type"
  47. SCALING_FACTOR = "{arch}.rope.scaling.factor"
  48. SCALING_ORIG_CTX_LEN = "{arch}.rope.scaling.original_context_length"
  49. SCALING_FINETUNED = "{arch}.rope.scaling.finetuned"
  50. class Tokenizer:
  51. MODEL = "tokenizer.ggml.model"
  52. LIST = "tokenizer.ggml.tokens"
  53. TOKEN_TYPE = "tokenizer.ggml.token_type"
  54. SCORES = "tokenizer.ggml.scores"
  55. MERGES = "tokenizer.ggml.merges"
  56. BOS_ID = "tokenizer.ggml.bos_token_id"
  57. EOS_ID = "tokenizer.ggml.eos_token_id"
  58. UNK_ID = "tokenizer.ggml.unknown_token_id"
  59. SEP_ID = "tokenizer.ggml.seperator_token_id"
  60. PAD_ID = "tokenizer.ggml.padding_token_id"
  61. ADD_BOS = "tokenizer.ggml.add_bos_token"
  62. ADD_EOS = "tokenizer.ggml.add_eos_token"
  63. HF_JSON = "tokenizer.huggingface.json"
  64. RWKV = "tokenizer.rwkv.world"
  65. CHAT_TEMPLATE = "tokenizer.chat_template"
  66. #
  67. # recommended mapping of model tensor names for storage in gguf
  68. #
  69. class MODEL_ARCH(IntEnum):
  70. LLAMA = auto()
  71. FALCON = auto()
  72. BAICHUAN = auto()
  73. GPT2 = auto()
  74. GPTJ = auto()
  75. GPTNEOX = auto()
  76. MPT = auto()
  77. STARCODER = auto()
  78. PERSIMMON = auto()
  79. REFACT = auto()
  80. BERT = auto()
  81. BLOOM = auto()
  82. STABLELM = auto()
  83. QWEN = auto()
  84. PHI2 = auto()
  85. PLAMO = auto()
  86. class MODEL_TENSOR(IntEnum):
  87. TOKEN_EMBD = auto()
  88. TOKEN_EMBD_NORM = auto()
  89. TOKEN_TYPES = auto()
  90. POS_EMBD = auto()
  91. OUTPUT = auto()
  92. OUTPUT_NORM = auto()
  93. ROPE_FREQS = auto()
  94. ATTN_Q = auto()
  95. ATTN_K = auto()
  96. ATTN_V = auto()
  97. ATTN_QKV = auto()
  98. ATTN_OUT = auto()
  99. ATTN_NORM = auto()
  100. ATTN_NORM_2 = auto()
  101. ATTN_ROT_EMBD = auto()
  102. FFN_GATE_INP = auto()
  103. FFN_NORM = auto()
  104. FFN_GATE = auto()
  105. FFN_DOWN = auto()
  106. FFN_UP = auto()
  107. FFN_ACT = auto()
  108. FFN_GATE_EXP = auto()
  109. FFN_DOWN_EXP = auto()
  110. FFN_UP_EXP = auto()
  111. ATTN_Q_NORM = auto()
  112. ATTN_K_NORM = auto()
  113. MODEL_ARCH_NAMES: dict[MODEL_ARCH, str] = {
  114. MODEL_ARCH.LLAMA: "llama",
  115. MODEL_ARCH.FALCON: "falcon",
  116. MODEL_ARCH.BAICHUAN: "baichuan",
  117. MODEL_ARCH.GPT2: "gpt2",
  118. MODEL_ARCH.GPTJ: "gptj",
  119. MODEL_ARCH.GPTNEOX: "gptneox",
  120. MODEL_ARCH.MPT: "mpt",
  121. MODEL_ARCH.STARCODER: "starcoder",
  122. MODEL_ARCH.PERSIMMON: "persimmon",
  123. MODEL_ARCH.REFACT: "refact",
  124. MODEL_ARCH.BERT: "bert",
  125. MODEL_ARCH.BLOOM: "bloom",
  126. MODEL_ARCH.STABLELM: "stablelm",
  127. MODEL_ARCH.QWEN: "qwen",
  128. MODEL_ARCH.PHI2: "phi2",
  129. MODEL_ARCH.PLAMO: "plamo",
  130. }
  131. TENSOR_NAMES: dict[MODEL_TENSOR, str] = {
  132. MODEL_TENSOR.TOKEN_EMBD: "token_embd",
  133. MODEL_TENSOR.TOKEN_EMBD_NORM: "token_embd_norm",
  134. MODEL_TENSOR.TOKEN_TYPES: "token_types",
  135. MODEL_TENSOR.POS_EMBD: "position_embd",
  136. MODEL_TENSOR.OUTPUT_NORM: "output_norm",
  137. MODEL_TENSOR.OUTPUT: "output",
  138. MODEL_TENSOR.ROPE_FREQS: "rope_freqs",
  139. MODEL_TENSOR.ATTN_NORM: "blk.{bid}.attn_norm",
  140. MODEL_TENSOR.ATTN_NORM_2: "blk.{bid}.attn_norm_2",
  141. MODEL_TENSOR.ATTN_QKV: "blk.{bid}.attn_qkv",
  142. MODEL_TENSOR.ATTN_Q: "blk.{bid}.attn_q",
  143. MODEL_TENSOR.ATTN_K: "blk.{bid}.attn_k",
  144. MODEL_TENSOR.ATTN_V: "blk.{bid}.attn_v",
  145. MODEL_TENSOR.ATTN_OUT: "blk.{bid}.attn_output",
  146. MODEL_TENSOR.ATTN_ROT_EMBD: "blk.{bid}.attn_rot_embd",
  147. MODEL_TENSOR.ATTN_Q_NORM: "blk.{bid}.attn_q_norm",
  148. MODEL_TENSOR.ATTN_K_NORM: "blk.{bid}.attn_k_norm",
  149. MODEL_TENSOR.FFN_GATE_INP: "blk.{bid}.ffn_gate_inp",
  150. MODEL_TENSOR.FFN_NORM: "blk.{bid}.ffn_norm",
  151. MODEL_TENSOR.FFN_GATE: "blk.{bid}.ffn_gate",
  152. MODEL_TENSOR.FFN_DOWN: "blk.{bid}.ffn_down",
  153. MODEL_TENSOR.FFN_UP: "blk.{bid}.ffn_up",
  154. MODEL_TENSOR.FFN_ACT: "blk.{bid}.ffn",
  155. MODEL_TENSOR.FFN_GATE_EXP: "blk.{bid}.ffn_gate.{xid}",
  156. MODEL_TENSOR.FFN_DOWN_EXP: "blk.{bid}.ffn_down.{xid}",
  157. MODEL_TENSOR.FFN_UP_EXP: "blk.{bid}.ffn_up.{xid}",
  158. }
  159. MODEL_TENSORS: dict[MODEL_ARCH, list[MODEL_TENSOR]] = {
  160. MODEL_ARCH.LLAMA: [
  161. MODEL_TENSOR.TOKEN_EMBD,
  162. MODEL_TENSOR.OUTPUT_NORM,
  163. MODEL_TENSOR.OUTPUT,
  164. MODEL_TENSOR.ROPE_FREQS,
  165. MODEL_TENSOR.ATTN_NORM,
  166. MODEL_TENSOR.ATTN_Q,
  167. MODEL_TENSOR.ATTN_K,
  168. MODEL_TENSOR.ATTN_V,
  169. MODEL_TENSOR.ATTN_OUT,
  170. MODEL_TENSOR.ATTN_ROT_EMBD,
  171. MODEL_TENSOR.FFN_GATE_INP,
  172. MODEL_TENSOR.FFN_NORM,
  173. MODEL_TENSOR.FFN_GATE,
  174. MODEL_TENSOR.FFN_DOWN,
  175. MODEL_TENSOR.FFN_UP,
  176. MODEL_TENSOR.FFN_GATE_EXP,
  177. MODEL_TENSOR.FFN_DOWN_EXP,
  178. MODEL_TENSOR.FFN_UP_EXP,
  179. ],
  180. MODEL_ARCH.GPTNEOX: [
  181. MODEL_TENSOR.TOKEN_EMBD,
  182. MODEL_TENSOR.OUTPUT_NORM,
  183. MODEL_TENSOR.OUTPUT,
  184. MODEL_TENSOR.ATTN_NORM,
  185. MODEL_TENSOR.ATTN_QKV,
  186. MODEL_TENSOR.ATTN_OUT,
  187. MODEL_TENSOR.FFN_NORM,
  188. MODEL_TENSOR.FFN_DOWN,
  189. MODEL_TENSOR.FFN_UP,
  190. ],
  191. MODEL_ARCH.FALCON: [
  192. MODEL_TENSOR.TOKEN_EMBD,
  193. MODEL_TENSOR.OUTPUT_NORM,
  194. MODEL_TENSOR.OUTPUT,
  195. MODEL_TENSOR.ATTN_NORM,
  196. MODEL_TENSOR.ATTN_NORM_2,
  197. MODEL_TENSOR.ATTN_QKV,
  198. MODEL_TENSOR.ATTN_OUT,
  199. MODEL_TENSOR.FFN_DOWN,
  200. MODEL_TENSOR.FFN_UP,
  201. ],
  202. MODEL_ARCH.BAICHUAN: [
  203. MODEL_TENSOR.TOKEN_EMBD,
  204. MODEL_TENSOR.OUTPUT_NORM,
  205. MODEL_TENSOR.OUTPUT,
  206. MODEL_TENSOR.ROPE_FREQS,
  207. MODEL_TENSOR.ATTN_NORM,
  208. MODEL_TENSOR.ATTN_Q,
  209. MODEL_TENSOR.ATTN_K,
  210. MODEL_TENSOR.ATTN_V,
  211. MODEL_TENSOR.ATTN_OUT,
  212. MODEL_TENSOR.ATTN_ROT_EMBD,
  213. MODEL_TENSOR.FFN_NORM,
  214. MODEL_TENSOR.FFN_GATE,
  215. MODEL_TENSOR.FFN_DOWN,
  216. MODEL_TENSOR.FFN_UP,
  217. ],
  218. MODEL_ARCH.STARCODER: [
  219. MODEL_TENSOR.TOKEN_EMBD,
  220. MODEL_TENSOR.POS_EMBD,
  221. MODEL_TENSOR.OUTPUT_NORM,
  222. MODEL_TENSOR.OUTPUT,
  223. MODEL_TENSOR.ATTN_NORM,
  224. MODEL_TENSOR.ATTN_QKV,
  225. MODEL_TENSOR.ATTN_OUT,
  226. MODEL_TENSOR.FFN_NORM,
  227. MODEL_TENSOR.FFN_DOWN,
  228. MODEL_TENSOR.FFN_UP,
  229. ],
  230. MODEL_ARCH.BERT: [
  231. MODEL_TENSOR.TOKEN_EMBD,
  232. MODEL_TENSOR.TOKEN_TYPES,
  233. MODEL_TENSOR.POS_EMBD,
  234. MODEL_TENSOR.OUTPUT_NORM,
  235. MODEL_TENSOR.ATTN_NORM,
  236. MODEL_TENSOR.ATTN_Q,
  237. MODEL_TENSOR.ATTN_K,
  238. MODEL_TENSOR.ATTN_V,
  239. MODEL_TENSOR.ATTN_OUT,
  240. MODEL_TENSOR.FFN_NORM,
  241. MODEL_TENSOR.FFN_DOWN,
  242. MODEL_TENSOR.FFN_UP,
  243. ],
  244. MODEL_ARCH.MPT: [
  245. MODEL_TENSOR.TOKEN_EMBD,
  246. MODEL_TENSOR.OUTPUT_NORM,
  247. MODEL_TENSOR.OUTPUT,
  248. MODEL_TENSOR.ATTN_NORM,
  249. MODEL_TENSOR.ATTN_QKV,
  250. MODEL_TENSOR.ATTN_OUT,
  251. MODEL_TENSOR.FFN_NORM,
  252. MODEL_TENSOR.FFN_DOWN,
  253. MODEL_TENSOR.FFN_UP,
  254. MODEL_TENSOR.FFN_ACT,
  255. ],
  256. MODEL_ARCH.GPTJ: [
  257. MODEL_TENSOR.TOKEN_EMBD,
  258. MODEL_TENSOR.OUTPUT_NORM,
  259. MODEL_TENSOR.OUTPUT,
  260. MODEL_TENSOR.ATTN_NORM,
  261. MODEL_TENSOR.ATTN_Q,
  262. MODEL_TENSOR.ATTN_K,
  263. MODEL_TENSOR.ATTN_V,
  264. MODEL_TENSOR.ATTN_OUT,
  265. MODEL_TENSOR.FFN_DOWN,
  266. MODEL_TENSOR.FFN_UP,
  267. ],
  268. MODEL_ARCH.PERSIMMON: [
  269. MODEL_TENSOR.TOKEN_EMBD,
  270. MODEL_TENSOR.OUTPUT,
  271. MODEL_TENSOR.OUTPUT_NORM,
  272. MODEL_TENSOR.ATTN_NORM,
  273. MODEL_TENSOR.ATTN_QKV,
  274. MODEL_TENSOR.ATTN_OUT,
  275. MODEL_TENSOR.FFN_NORM,
  276. MODEL_TENSOR.FFN_DOWN,
  277. MODEL_TENSOR.FFN_UP,
  278. MODEL_TENSOR.ATTN_Q_NORM,
  279. MODEL_TENSOR.ATTN_K_NORM,
  280. MODEL_TENSOR.ATTN_ROT_EMBD,
  281. ],
  282. MODEL_ARCH.REFACT: [
  283. MODEL_TENSOR.TOKEN_EMBD,
  284. MODEL_TENSOR.OUTPUT_NORM,
  285. MODEL_TENSOR.OUTPUT,
  286. MODEL_TENSOR.ATTN_NORM,
  287. MODEL_TENSOR.ATTN_Q,
  288. MODEL_TENSOR.ATTN_K,
  289. MODEL_TENSOR.ATTN_V,
  290. MODEL_TENSOR.ATTN_OUT,
  291. MODEL_TENSOR.FFN_NORM,
  292. MODEL_TENSOR.FFN_GATE,
  293. MODEL_TENSOR.FFN_DOWN,
  294. MODEL_TENSOR.FFN_UP,
  295. ],
  296. MODEL_ARCH.BLOOM: [
  297. MODEL_TENSOR.TOKEN_EMBD,
  298. MODEL_TENSOR.TOKEN_EMBD_NORM,
  299. MODEL_TENSOR.OUTPUT_NORM,
  300. MODEL_TENSOR.OUTPUT,
  301. MODEL_TENSOR.ATTN_NORM,
  302. MODEL_TENSOR.ATTN_QKV,
  303. MODEL_TENSOR.ATTN_OUT,
  304. MODEL_TENSOR.FFN_NORM,
  305. MODEL_TENSOR.FFN_DOWN,
  306. MODEL_TENSOR.FFN_UP,
  307. ],
  308. MODEL_ARCH.STABLELM: [
  309. MODEL_TENSOR.TOKEN_EMBD,
  310. MODEL_TENSOR.OUTPUT_NORM,
  311. MODEL_TENSOR.OUTPUT,
  312. MODEL_TENSOR.ROPE_FREQS,
  313. MODEL_TENSOR.ATTN_NORM,
  314. MODEL_TENSOR.ATTN_Q,
  315. MODEL_TENSOR.ATTN_K,
  316. MODEL_TENSOR.ATTN_V,
  317. MODEL_TENSOR.ATTN_OUT,
  318. MODEL_TENSOR.FFN_NORM,
  319. MODEL_TENSOR.FFN_GATE,
  320. MODEL_TENSOR.FFN_DOWN,
  321. MODEL_TENSOR.FFN_UP,
  322. ],
  323. MODEL_ARCH.QWEN: [
  324. MODEL_TENSOR.TOKEN_EMBD,
  325. MODEL_TENSOR.OUTPUT_NORM,
  326. MODEL_TENSOR.OUTPUT,
  327. MODEL_TENSOR.ROPE_FREQS,
  328. MODEL_TENSOR.ATTN_NORM,
  329. MODEL_TENSOR.ATTN_QKV,
  330. MODEL_TENSOR.ATTN_OUT,
  331. MODEL_TENSOR.ATTN_ROT_EMBD,
  332. MODEL_TENSOR.FFN_NORM,
  333. MODEL_TENSOR.FFN_GATE,
  334. MODEL_TENSOR.FFN_DOWN,
  335. MODEL_TENSOR.FFN_UP,
  336. ],
  337. MODEL_ARCH.PLAMO: [
  338. MODEL_TENSOR.TOKEN_EMBD,
  339. MODEL_TENSOR.OUTPUT_NORM,
  340. MODEL_TENSOR.OUTPUT,
  341. MODEL_TENSOR.ROPE_FREQS,
  342. MODEL_TENSOR.ATTN_NORM,
  343. MODEL_TENSOR.ATTN_Q,
  344. MODEL_TENSOR.ATTN_K,
  345. MODEL_TENSOR.ATTN_V,
  346. MODEL_TENSOR.ATTN_OUT,
  347. MODEL_TENSOR.ATTN_ROT_EMBD,
  348. MODEL_TENSOR.FFN_GATE,
  349. MODEL_TENSOR.FFN_DOWN,
  350. MODEL_TENSOR.FFN_UP,
  351. ],
  352. MODEL_ARCH.GPT2: [
  353. MODEL_TENSOR.TOKEN_EMBD,
  354. MODEL_TENSOR.POS_EMBD,
  355. MODEL_TENSOR.OUTPUT_NORM,
  356. MODEL_TENSOR.OUTPUT,
  357. MODEL_TENSOR.ATTN_NORM,
  358. MODEL_TENSOR.ATTN_QKV,
  359. MODEL_TENSOR.ATTN_OUT,
  360. MODEL_TENSOR.FFN_NORM,
  361. MODEL_TENSOR.FFN_DOWN,
  362. MODEL_TENSOR.FFN_UP,
  363. ],
  364. MODEL_ARCH.PHI2: [
  365. MODEL_TENSOR.TOKEN_EMBD,
  366. MODEL_TENSOR.OUTPUT_NORM,
  367. MODEL_TENSOR.OUTPUT,
  368. MODEL_TENSOR.ATTN_NORM,
  369. MODEL_TENSOR.ATTN_QKV,
  370. MODEL_TENSOR.ATTN_OUT,
  371. MODEL_TENSOR.FFN_NORM,
  372. MODEL_TENSOR.FFN_DOWN,
  373. MODEL_TENSOR.FFN_UP,
  374. ]
  375. # TODO
  376. }
  377. # tensors that will not be serialized
  378. MODEL_TENSOR_SKIP: dict[MODEL_ARCH, list[MODEL_TENSOR]] = {
  379. MODEL_ARCH.LLAMA: [
  380. MODEL_TENSOR.ROPE_FREQS,
  381. MODEL_TENSOR.ATTN_ROT_EMBD,
  382. ],
  383. MODEL_ARCH.BAICHUAN: [
  384. MODEL_TENSOR.ROPE_FREQS,
  385. MODEL_TENSOR.ATTN_ROT_EMBD,
  386. ],
  387. MODEL_ARCH.PERSIMMON: [
  388. MODEL_TENSOR.ROPE_FREQS,
  389. ],
  390. MODEL_ARCH.QWEN: [
  391. MODEL_TENSOR.ROPE_FREQS,
  392. MODEL_TENSOR.ATTN_ROT_EMBD,
  393. ],
  394. }
  395. #
  396. # types
  397. #
  398. class TokenType(IntEnum):
  399. NORMAL = 1
  400. UNKNOWN = 2
  401. CONTROL = 3
  402. USER_DEFINED = 4
  403. UNUSED = 5
  404. BYTE = 6
  405. class RopeScalingType(Enum):
  406. NONE = 'none'
  407. LINEAR = 'linear'
  408. YARN = 'yarn'
  409. class GGMLQuantizationType(IntEnum):
  410. F32 = 0
  411. F16 = 1
  412. Q4_0 = 2
  413. Q4_1 = 3
  414. Q5_0 = 6
  415. Q5_1 = 7
  416. Q8_0 = 8
  417. Q8_1 = 9
  418. Q2_K = 10
  419. Q3_K = 11
  420. Q4_K = 12
  421. Q5_K = 13
  422. Q6_K = 14
  423. Q8_K = 15
  424. class GGUFEndian(IntEnum):
  425. LITTLE = 0
  426. BIG = 1
  427. class GGUFValueType(IntEnum):
  428. UINT8 = 0
  429. INT8 = 1
  430. UINT16 = 2
  431. INT16 = 3
  432. UINT32 = 4
  433. INT32 = 5
  434. FLOAT32 = 6
  435. BOOL = 7
  436. STRING = 8
  437. ARRAY = 9
  438. UINT64 = 10
  439. INT64 = 11
  440. FLOAT64 = 12
  441. @staticmethod
  442. def get_type(val: Any) -> GGUFValueType:
  443. if isinstance(val, (str, bytes, bytearray)):
  444. return GGUFValueType.STRING
  445. elif isinstance(val, list):
  446. return GGUFValueType.ARRAY
  447. elif isinstance(val, float):
  448. return GGUFValueType.FLOAT32
  449. elif isinstance(val, bool):
  450. return GGUFValueType.BOOL
  451. elif isinstance(val, int):
  452. return GGUFValueType.INT32
  453. # TODO: need help with 64-bit types in Python
  454. else:
  455. print("Unknown type:", type(val))
  456. sys.exit()
  457. # Note: Does not support GGML_QKK_64
  458. QK_K = 256
  459. # Items here are (block size, type size)
  460. GGML_QUANT_SIZES = {
  461. GGMLQuantizationType.F32: (1, 4),
  462. GGMLQuantizationType.F16: (1, 2),
  463. GGMLQuantizationType.Q4_0: (32, 2 + 16),
  464. GGMLQuantizationType.Q4_1: (32, 2 + 2 + 16),
  465. GGMLQuantizationType.Q5_0: (32, 2 + 4 + 16),
  466. GGMLQuantizationType.Q5_1: (32, 2 + 2 + 4 + 16),
  467. GGMLQuantizationType.Q8_0: (32, 2 + 32),
  468. GGMLQuantizationType.Q8_1: (32, 4 + 4 + 32),
  469. GGMLQuantizationType.Q2_K: (256, 2 + 2 + QK_K // 16 + QK_K // 4),
  470. GGMLQuantizationType.Q3_K: (256, 2 + QK_K // 4 + QK_K // 8 + 12),
  471. GGMLQuantizationType.Q4_K: (256, 2 + 2 + QK_K // 2 + 12),
  472. GGMLQuantizationType.Q5_K: (256, 2 + 2 + QK_K // 2 + QK_K // 8 + 12),
  473. GGMLQuantizationType.Q6_K: (256, 2 + QK_K // 2 + QK_K // 4 + QK_K // 16),
  474. GGMLQuantizationType.Q8_K: (256, 4 + QK_K + QK_K // 8),
  475. }
  476. # Aliases for backward compatibility.
  477. # general
  478. KEY_GENERAL_ARCHITECTURE = Keys.General.ARCHITECTURE
  479. KEY_GENERAL_QUANTIZATION_VERSION = Keys.General.QUANTIZATION_VERSION
  480. KEY_GENERAL_ALIGNMENT = Keys.General.ALIGNMENT
  481. KEY_GENERAL_NAME = Keys.General.NAME
  482. KEY_GENERAL_AUTHOR = Keys.General.AUTHOR
  483. KEY_GENERAL_URL = Keys.General.URL
  484. KEY_GENERAL_DESCRIPTION = Keys.General.DESCRIPTION
  485. KEY_GENERAL_LICENSE = Keys.General.LICENSE
  486. KEY_GENERAL_SOURCE_URL = Keys.General.SOURCE_URL
  487. KEY_GENERAL_SOURCE_HF_REPO = Keys.General.SOURCE_HF_REPO
  488. KEY_GENERAL_FILE_TYPE = Keys.General.FILE_TYPE
  489. # LLM
  490. KEY_CONTEXT_LENGTH = Keys.LLM.CONTEXT_LENGTH
  491. KEY_EMBEDDING_LENGTH = Keys.LLM.EMBEDDING_LENGTH
  492. KEY_BLOCK_COUNT = Keys.LLM.BLOCK_COUNT
  493. KEY_FEED_FORWARD_LENGTH = Keys.LLM.FEED_FORWARD_LENGTH
  494. KEY_USE_PARALLEL_RESIDUAL = Keys.LLM.USE_PARALLEL_RESIDUAL
  495. KEY_TENSOR_DATA_LAYOUT = Keys.LLM.TENSOR_DATA_LAYOUT
  496. # attention
  497. KEY_ATTENTION_HEAD_COUNT = Keys.Attention.HEAD_COUNT
  498. KEY_ATTENTION_HEAD_COUNT_KV = Keys.Attention.HEAD_COUNT_KV
  499. KEY_ATTENTION_MAX_ALIBI_BIAS = Keys.Attention.MAX_ALIBI_BIAS
  500. KEY_ATTENTION_CLAMP_KQV = Keys.Attention.CLAMP_KQV
  501. KEY_ATTENTION_LAYERNORM_EPS = Keys.Attention.LAYERNORM_EPS
  502. KEY_ATTENTION_LAYERNORM_RMS_EPS = Keys.Attention.LAYERNORM_RMS_EPS
  503. # RoPE
  504. KEY_ROPE_DIMENSION_COUNT = Keys.Rope.DIMENSION_COUNT
  505. KEY_ROPE_FREQ_BASE = Keys.Rope.FREQ_BASE
  506. KEY_ROPE_SCALING_TYPE = Keys.Rope.SCALING_TYPE
  507. KEY_ROPE_SCALING_FACTOR = Keys.Rope.SCALING_FACTOR
  508. KEY_ROPE_SCALING_ORIG_CTX_LEN = Keys.Rope.SCALING_ORIG_CTX_LEN
  509. KEY_ROPE_SCALING_FINETUNED = Keys.Rope.SCALING_FINETUNED
  510. # tokenization
  511. KEY_TOKENIZER_MODEL = Keys.Tokenizer.MODEL
  512. KEY_TOKENIZER_LIST = Keys.Tokenizer.LIST
  513. KEY_TOKENIZER_TOKEN_TYPE = Keys.Tokenizer.TOKEN_TYPE
  514. KEY_TOKENIZER_SCORES = Keys.Tokenizer.SCORES
  515. KEY_TOKENIZER_MERGES = Keys.Tokenizer.MERGES
  516. KEY_TOKENIZER_BOS_ID = Keys.Tokenizer.BOS_ID
  517. KEY_TOKENIZER_EOS_ID = Keys.Tokenizer.EOS_ID
  518. KEY_TOKENIZER_UNK_ID = Keys.Tokenizer.UNK_ID
  519. KEY_TOKENIZER_SEP_ID = Keys.Tokenizer.SEP_ID
  520. KEY_TOKENIZER_PAD_ID = Keys.Tokenizer.PAD_ID
  521. KEY_TOKENIZER_HF_JSON = Keys.Tokenizer.HF_JSON
  522. KEY_TOKENIZER_RWKV = Keys.Tokenizer.RWKV