lumierenoir commited on
Commit
ff3fb1b
·
verified ·
1 Parent(s): 4c563ae

Install section: pip install klev

Browse files
Files changed (1) hide show
  1. README.md +34 -0
README.md CHANGED
@@ -237,6 +237,40 @@ so it has to enter as a score, not as a perturbation.
237
  Probe hyperparameters (in `stitch/probe-*.pt`): TweetEval `T = 105.19`, `beta = 16.0`,
238
  `ext_weight = 1.0`; RumourEval `T = 1305.8`, `beta = 16.0`, `ext_weight = 1.0`.
239
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
240
  ## Usage
241
 
242
  klev is a **library first**. A decision model is small and stateless, so the normal way to use
 
237
  Probe hyperparameters (in `stitch/probe-*.pt`): TweetEval `T = 105.19`, `beta = 16.0`,
238
  `ext_weight = 1.0`; RumourEval `T = 1305.8`, `beta = 16.0`, `ext_weight = 1.0`.
239
 
240
+ ## Install
241
+
242
+ ```bash
243
+ pip install klev
244
+ ```
245
+
246
+ `klev` is the library: it carries the loader, the pointer readout, the record format and both
247
+ usage paths, so a consumer does not clone this repo to use a checkpoint. Two version floors
248
+ matter and pip does not know they are related to the architecture:
249
+
250
+ | | why |
251
+ |---|---|
252
+ | `transformers >= 5.5.0` | the `qwen3_5` and `gemma4` architectures do not exist before it. On 5.3.0 `AutoConfig` raises "Transformers does not recognize this architecture", which unsloth then **misreports** as a generic "not supported yet" ValueError — it reads like a missing model, not a version. |
253
+ | `unsloth >= 2026.9.11` | first release carrying gemma4 support. |
254
+
255
+ Install unsloth with `--no-deps` if you are on ROCm, so its CUDA `xformers` dependency does not
256
+ replace your ROCm torch build.
257
+
258
+ On AMD/ROCm also `source scripts/rocm_env.sh` from the repo (shipped in the wheel as
259
+ `klev.scripts`) **before** importing — it sets the arch override, `TORCH_ROCM_AOTRITON_ENABLE_BF16=0`,
260
+ `UNSLOTH_COMPILE_DISABLE=1` and the rest. All of it is load-bearing; see
261
+ `docs/m11-qwen35-08b.md`.
262
+
263
+ Two console scripts come with it:
264
+
265
+ ```bash
266
+ klev-system-one --ckpt lumierenoir/klev-0.8b --request my_request.json # no server
267
+ klev-serve --ckpt lumierenoir/klev-0.8b --port 8090 # optional HTTP
268
+ ```
269
+
270
+ `load_klev()` reads the base model from the checkpoint's own `adapter_config.json` and picks the
271
+ matching delimiters, so you do not have to pass `base=` or `preset=`. Pairing a checkpoint with
272
+ another model's weights would otherwise be silent nonsense rather than an error.
273
+
274
  ## Usage
275
 
276
  klev is a **library first**. A decision model is small and stateless, so the normal way to use