Skip to content

fix: reject invalid MUVERA sizes #827

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AryanRG wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: reject invalid MUVERA sizes #827

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions fastembed/postprocess/muvera.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,14 @@ def __init__(
reproducible results. Defaults to 42.

Raises:
ValueError: If dim_proj > dim (cannot project to higher dimensionality)
ValueError: If dim, dim_proj, or r_reps are not positive, or if dim_proj > dim
"""
if dim <= 0:
raise ValueError(f"dim must be positive, got {dim}")
if dim_proj <= 0:
raise ValueError(f"dim_proj must be positive, got {dim_proj}")
if r_reps <= 0:
raise ValueError(f"r_reps must be positive, got {r_reps}")
if dim_proj > dim:
raise ValueError(
f"Cannot project to a higher dimensionality (dim_proj={dim_proj} > dim={dim})"
Expand Down Expand Up @@ -186,7 +192,8 @@ def from_multivector_model(
Muvera: A configured MUVERA instance ready to process embeddings from the given model.

Raises:
ValueError: If dim_proj > model.embedding_size (cannot project to higher dimensionality)
ValueError: If the model dimension, dim_proj, or r_reps are not positive, or if
dim_proj > model.embedding_size

Example:
>>> from fastembed import LateInteractionTextEmbedding
Expand Down
14 changes: 14 additions & 0 deletions tests/test_postprocess.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,20 @@
R_REPS = 20


@pytest.mark.parametrize(
("kwargs", "message"),
[
({"dim": 0, "dim_proj": 0}, "dim must be positive"),
({"dim": 4, "dim_proj": 0}, "dim_proj must be positive"),
({"dim": 4, "dim_proj": 2, "r_reps": 0}, "r_reps must be positive"),
],
)
def test_muvera_rejects_non_positive_sizes(kwargs: dict[str, int], message: str) -> None:
"""Configurations that cannot produce an embedding must fail during construction."""
with pytest.raises(ValueError, match=message):
Muvera(**kwargs)


def test_single_input():
model = LateInteractionTextEmbedding("colbert-ir/colbertv2.0", lazy_load=True)
random_generator = np.random.default_rng(42)
Expand Down