Skip to content

Commit 2c937db

Browse files
committed
Add sparse normalization info to docs
1 parent ba0d1ea commit 2c937db

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

docs/embeddings/configuration/scoring.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ path: sparse vector model path
3131
vectormethod: vector embeddings method
3232
vectornormalize: enable vector embeddings normalization (boolean)
3333
gpu: boolean|int|string|device
34-
normalize: enable score normalization (boolean | float)
34+
normalize: enable score normalization (boolean|float|string|dict)
3535
batch: Sets the transform batch size
3636
encodebatch: Sets the encode batch size
3737
vectors: additional model init args
@@ -43,7 +43,12 @@ Sparse vector scoring options. The sparse scoring instance combines a sparse vec
4343
4444
Vector normalization normalizes all vectors to have a magnitude of 1. By extension, all generated scores will be 0 to 1.
4545
46-
Score normalization scales output scores by a scale factor. When `normalize` is set to `True` it uses a default scale factor. If `normalize` is an integer, then that is used as the scale factor. This scales the scores from 0 to 1.
46+
Score normalization scales the output between 0 and 1. This setting supports:
47+
48+
- `True` for default scale normalization
49+
- `float` normalize using this as the scale factor
50+
- `"bayes"` for Bayesian normalization using dynamic candidate score statistics
51+
- `{method: "bayes", alpha: 1.0, beta: null}` for Bayesian normalization with optional custom parameters
4752

4853
#### ivfsparse
4954
```yaml
@@ -83,9 +88,8 @@ normalize: boolean|str|dict
8388

8489
Enables normalized scoring (ranging from 0 to 1). This setting supports:
8590

86-
- `true` for standard score normalization
87-
- `"bayes"` for Bayesian normalization using dynamic candidate score statistics
88-
- `"bb25"` alias for Bayesian BM25 (BB25) normalization
91+
- `True` for standard score normalization
92+
- `"bayes"` | `"bb25"` for Bayesian normalization using dynamic candidate score statistics
8993
- `{method: "bayes", alpha: 1.0, beta: null}` for Bayesian normalization with optional custom parameters
9094

9195
When standard normalization is enabled, statistics from the index are used to calculate normalized scores.

0 commit comments

Comments
 (0)