Text Ranking
sentence-transformers
Safetensors
Transformers
multilingual
t5gemma2
text2text-generation
reranker
encoder-decoder
FBNL
Retrieval
RAG
cosyy commited on
Commit
005fa6a
·
verified ·
1 Parent(s): 77c420e

Update vllm_support/README.md

Browse files
Files changed (1) hide show
  1. vllm_support/README.md +16 -28
vllm_support/README.md CHANGED
@@ -1,7 +1,7 @@
1
- # KaLM-Reranker-V1-Nano vLLM Support
2
 
3
  This directory contains the experimental vLLM 0.19.1 adapter for
4
- `KaLM-Embedding/KaLM-Reranker-V1-Nano`. It supports offline Python and CLI
5
  reranking plus an optional FastAPI service.
6
 
7
  The adapter does not modify or retrain the checkpoint. It reads the original
@@ -35,9 +35,9 @@ conda activate kalm-vllm
35
  pip install "vllm==0.19.1" "transformers==5.6.2"
36
  pip install "fastapi>=0.136,<0.137" "uvicorn>=0.46,<0.47"
37
 
38
- hf download KaLM-Embedding/KaLM-Reranker-V1-Nano \
39
- --local-dir ./KaLM-Reranker-V1-Nano
40
- pip install ./KaLM-Reranker-V1-Nano/vllm_support --no-deps
41
  export VLLM_PLUGINS=kalm_t5gemma2
42
  ```
43
 
@@ -45,10 +45,10 @@ The model can also be loaded directly by its Hugging Face ID. In that case,
45
  only download the `vllm_support` directory before installing the plugin:
46
 
47
  ```bash
48
- hf download KaLM-Embedding/KaLM-Reranker-V1-Nano \
49
  --include "vllm_support/**" \
50
- --local-dir ./KaLM-Reranker-V1-Nano
51
- pip install ./KaLM-Reranker-V1-Nano/vllm_support --no-deps
52
  ```
53
 
54
  ## Offline Python API
@@ -64,7 +64,7 @@ documents = [
64
 
65
  pairs = [(query, document) for document in documents]
66
  with KaLMVLLMReranker(
67
- "KaLM-Embedding/KaLM-Reranker-V1-Nano",
68
  query_max_length=512,
69
  document_max_length=1024,
70
  encoder_chunk_size=4,
@@ -97,7 +97,7 @@ Score JSONL input:
97
 
98
  ```bash
99
  kalm-vllm-rerank \
100
- --input-jsonl ./KaLM-Reranker-V1-Nano/vllm_support/examples/sample_pairs.jsonl \
101
  --output-jsonl ./scores.jsonl \
102
  --return-margin
103
  ```
@@ -114,7 +114,7 @@ Start one model instance:
114
  kalm-vllm-serve \
115
  --host 0.0.0.0 \
116
  --port 8000 \
117
- --model KaLM-Embedding/KaLM-Reranker-V1-Nano \
118
  --encoder-chunk-size 4
119
  ```
120
 
@@ -123,7 +123,7 @@ variables:
123
 
124
  ```bash
125
  CUDA_VISIBLE_DEVICES=0 PORT=8000 \
126
- ./KaLM-Reranker-V1-Nano/vllm_support/examples/start_online_server.sh
127
  ```
128
 
129
  In a second terminal, check health and send built-in demo requests:
@@ -140,7 +140,7 @@ one query against multiple documents:
140
  ```bash
141
  kalm-vllm-client \
142
  --endpoint rerank \
143
- --json-file ./KaLM-Reranker-V1-Nano/vllm_support/examples/rerank_request.json \
144
  --return-margin \
145
  --top-k 10
146
  ```
@@ -150,7 +150,7 @@ Use `/score` for a batch of independent query-document pairs:
150
  ```bash
151
  kalm-vllm-client \
152
  --endpoint score \
153
- --json-file ./KaLM-Reranker-V1-Nano/vllm_support/examples/score_request.json \
154
  --return-margin
155
  ```
156
 
@@ -247,7 +247,7 @@ Reinstall the package and ensure the environment variable includes its entry
247
  point name:
248
 
249
  ```bash
250
- pip install ./KaLM-Reranker-V1-Nano/vllm_support --no-deps --force-reinstall
251
  export VLLM_PLUGINS=kalm_t5gemma2
252
  ```
253
 
@@ -258,22 +258,10 @@ sensitive.
258
 
259
  **The tokenizer check fails**
260
 
261
- Confirm that the tokenizer belongs to this Nano checkpoint. The adapter
262
  requires `yes -> 4443` and `no -> 1904`.
263
 
264
  **CUDA runs out of memory**
265
 
266
  Reduce `batch_size`, `document_max_length`, `query_max_length`,
267
  `max_model_len`, or `gpu_memory_utilization`.
268
-
269
- **CUDA initialization fails with error 803**
270
-
271
- The process may be resolving a CUDA compatibility library before the host
272
- driver library. On common Debian/Ubuntu layouts, retry with:
273
-
274
- ```bash
275
- export LD_LIBRARY_PATH="/lib/x86_64-linux-gnu:/usr/lib/x86_64-linux-gnu${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}"
276
- ```
277
-
278
- The provided `start_online_server.sh` applies this adjustment automatically
279
- when both directories exist.
 
1
+ # KaLM-Reranker-V1-Small vLLM Support
2
 
3
  This directory contains the experimental vLLM 0.19.1 adapter for
4
+ `KaLM-Embedding/KaLM-Reranker-V1-Small`. It supports offline Python and CLI
5
  reranking plus an optional FastAPI service.
6
 
7
  The adapter does not modify or retrain the checkpoint. It reads the original
 
35
  pip install "vllm==0.19.1" "transformers==5.6.2"
36
  pip install "fastapi>=0.136,<0.137" "uvicorn>=0.46,<0.47"
37
 
38
+ hf download KaLM-Embedding/KaLM-Reranker-V1-Small \
39
+ --local-dir ./KaLM-Reranker-V1-Small
40
+ pip install ./KaLM-Reranker-V1-Small/vllm_support --no-deps
41
  export VLLM_PLUGINS=kalm_t5gemma2
42
  ```
43
 
 
45
  only download the `vllm_support` directory before installing the plugin:
46
 
47
  ```bash
48
+ hf download KaLM-Embedding/KaLM-Reranker-V1-Small \
49
  --include "vllm_support/**" \
50
+ --local-dir ./KaLM-Reranker-V1-Small
51
+ pip install ./KaLM-Reranker-V1-Small/vllm_support --no-deps
52
  ```
53
 
54
  ## Offline Python API
 
64
 
65
  pairs = [(query, document) for document in documents]
66
  with KaLMVLLMReranker(
67
+ "KaLM-Embedding/KaLM-Reranker-V1-Small",
68
  query_max_length=512,
69
  document_max_length=1024,
70
  encoder_chunk_size=4,
 
97
 
98
  ```bash
99
  kalm-vllm-rerank \
100
+ --input-jsonl ./KaLM-Reranker-V1-Small/vllm_support/examples/sample_pairs.jsonl \
101
  --output-jsonl ./scores.jsonl \
102
  --return-margin
103
  ```
 
114
  kalm-vllm-serve \
115
  --host 0.0.0.0 \
116
  --port 8000 \
117
+ --model KaLM-Embedding/KaLM-Reranker-V1-Small \
118
  --encoder-chunk-size 4
119
  ```
120
 
 
123
 
124
  ```bash
125
  CUDA_VISIBLE_DEVICES=0 PORT=8000 \
126
+ ./KaLM-Reranker-V1-Small/vllm_support/examples/start_online_server.sh
127
  ```
128
 
129
  In a second terminal, check health and send built-in demo requests:
 
140
  ```bash
141
  kalm-vllm-client \
142
  --endpoint rerank \
143
+ --json-file ./KaLM-Reranker-V1-Small/vllm_support/examples/rerank_request.json \
144
  --return-margin \
145
  --top-k 10
146
  ```
 
150
  ```bash
151
  kalm-vllm-client \
152
  --endpoint score \
153
+ --json-file ./KaLM-Reranker-V1-Small/vllm_support/examples/score_request.json \
154
  --return-margin
155
  ```
156
 
 
247
  point name:
248
 
249
  ```bash
250
+ pip install ./KaLM-Reranker-V1-Small/vllm_support --no-deps --force-reinstall
251
  export VLLM_PLUGINS=kalm_t5gemma2
252
  ```
253
 
 
258
 
259
  **The tokenizer check fails**
260
 
261
+ Confirm that the tokenizer belongs to this Small checkpoint. The adapter
262
  requires `yes -> 4443` and `no -> 1904`.
263
 
264
  **CUDA runs out of memory**
265
 
266
  Reduce `batch_size`, `document_max_length`, `query_max_length`,
267
  `max_model_len`, or `gpu_memory_utilization`.