larql/crates/larql-vindex-spec/schema/vindex-v1.schema.json at main · chrishayuk/larql · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://huggingface.co/larql/vindex-spec/raw/main/vindex-v1.schema.json",
  "title": "VindexManifest",
  "description": "Vindex Spec v1 manifest. Mirrors the Rust types in larql-vindex-spec/src/lib.rs; Rust is authoritative. Loader-domain fields (layer_bands, model_config, fp4, ffn_layout, ...) are not validated by this schema and pass through unchanged.",
  "type": "object",
  "additionalProperties": true,
  "required": [
    "vindex_spec_version",
    "version",
    "model",
    "family",
    "source",
    "checksums",
    "num_layers",
    "hidden_size",
    "intermediate_size",
    "vocab_size",
    "embed_scale",
    "extract_level",
    "dtype",
    "quant",
    "layers",
    "down_top_k",
    "has_model_weights"
  ],
  "properties": {
    "vindex_spec_version": {
      "type": "integer",
      "const": 1,
      "description": "Public spec version. Must equal 1 for v1 manifests."
    },
    "version": {
      "type": "integer",
      "minimum": 0,
      "description": "On-disk file-format version. Independent of vindex_spec_version."
    },
    "model": {
      "type": "string",
      "description": "Upstream model identifier (e.g. 'google/gemma-3-4b-it')."
    },
    "family": {
      "type": "string",
      "description": "Architecture family for loader dispatch."
    },
    "source": { "$ref": "#/$defs/Source" },
    "checksums": {
      "type": "object",
      "description": "Map of filename -> SHA256 hex digest. Must cover every .bin referenced by the manifest.",
      "additionalProperties": {
        "type": "string",
        "pattern": "^[0-9a-f]{64}$"
      }
    },
    "num_layers": { "type": "integer", "minimum": 0 },
    "hidden_size": { "type": "integer", "minimum": 1 },
    "intermediate_size": { "type": "integer", "minimum": 1 },
    "vocab_size": { "type": "integer", "minimum": 1 },
    "embed_scale": { "type": "number" },
    "extract_level": {
      "enum": ["browse", "attention", "inference", "all"],
      "description": "Browse < Attention < Inference < All. Each tier is a superset of the previous."
    },
    "dtype": {
      "enum": ["f32", "f16"],
      "description": "Storage precision for non-quantised float tensors."
    },
    "quant": {
      "enum": ["none", "q4k", "kquant"],
      "description": "Quant scheme for FFN weight files. v1 readers accept either `q4k` or `kquant` (the post-rename canonical tag); v1 writers continue to emit `q4k` so vindexes published before the rename keep their wire format. A v2 schema will flip the writer to `kquant`."
    },
    "layers": {
      "type": "array",
      "items": { "$ref": "#/$defs/LayerEntry" }
    },
    "down_top_k": { "type": "integer", "minimum": 1 },
    "has_model_weights": { "type": "boolean" }
  },
  "$defs": {
    "Source": {
      "type": "object",
      "required": [
        "huggingface_repo",
        "huggingface_revision",
        "base_model_sha",
        "base_safetensors_sha256",
        "extracted_at",
        "larql_version",
        "extractor_sha"
      ],
      "properties": {
        "huggingface_repo": { "type": "string" },
        "huggingface_revision": { "type": "string" },
        "base_model_sha": {
          "type": "string",
          "description": "Upstream git commit SHA pinning the exact bytes the vindex was built from."
        },
        "base_safetensors_sha256": {
          "type": "object",
          "additionalProperties": {
            "type": "string",
            "pattern": "^[0-9a-f]{64}$"
          }
        },
        "extracted_at": {
          "type": "string",
          "format": "date-time"
        },
        "larql_version": { "type": "string" },
        "extractor_sha": { "type": "string" }
      }
    },
    "LayerEntry": {
      "type": "object",
      "required": ["layer", "num_features"],
      "description": "Layer slot. Exactly one of single-file (file+offset+length) or sharded form must be present. MoE-only fields (num_experts, num_features_per_expert) are optional.",
      "properties": {
        "layer": { "type": "integer", "minimum": 0 },
        "num_features": { "type": "integer", "minimum": 1 },
        "file": { "type": "string" },
        "offset": { "type": "integer", "minimum": 0 },
        "length": { "type": "integer", "minimum": 0 },
        "shards": {
          "type": "array",
          "minItems": 1,
          "items": { "$ref": "#/$defs/ShardSlot" }
        },
        "num_experts": { "type": "integer", "minimum": 1 },
        "num_features_per_expert": { "type": "integer", "minimum": 1 }
      },
      "oneOf": [
        {
          "required": ["file", "offset", "length"],
          "not": { "required": ["shards"] }
        },
        {
          "required": ["shards"],
          "not": {
            "anyOf": [
              { "required": ["file"] },
              { "required": ["offset"] },
              { "required": ["length"] }
            ]
          }
        }
      ]
    },
    "ShardSlot": {
      "type": "object",
      "required": ["file", "offset", "length"],
      "properties": {
        "file": {
          "type": "string",
          "pattern": ".+-[0-9]{5}-of-[0-9]{5}\\.bin$",
          "description": "Convention: <base>-NNNNN-of-NNNNN.bin, zero-padded, 1-indexed."
        },
        "offset": { "type": "integer", "minimum": 0 },
        "length": { "type": "integer", "minimum": 0 }
      }
    }
  }
}