vicinity 0.11.0

Approximate nearest-neighbor search
Documentation 
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
163
164
165
166
167
168
169
170

from __future__ import annotations

import importlib.util
import json
from pathlib import Path
from types import ModuleType
from typing import NoReturn

import pytest


def load_script() -> ModuleType:
    script_path = (
        Path(__file__).resolve().parents[1] / "scripts/generate_ann_smoke_data.py"
    )
    spec = importlib.util.spec_from_file_location(
        "generate_ann_smoke_data",
        script_path,
    )
    assert spec is not None
    assert spec.loader is not None
    module = importlib.util.module_from_spec(spec)
    spec.loader.exec_module(module)
    return module


def test_matching_manifest_reuses_existing_outputs(
    tmp_path: Path,
    monkeypatch: pytest.MonkeyPatch,
) -> None:
    script = load_script()
    output = tmp_path / "ann-smoke"
    monkeypatch.setattr(
        "sys.argv",
        [
            "generate_ann_smoke_data.py",
            str(output),
            "--train",
            "16",
            "--test",
            "5",
            "--dim",
            "4",
            "--k",
            "3",
        ],
    )
    script.main()

    def fail_make_train(*_args: object, **_kwargs: object) -> NoReturn:
        raise AssertionError("matching outputs should be reused")

    monkeypatch.setattr(script, "make_train", fail_make_train)

    script.main()


def test_manifest_mismatch_does_not_reuse_outputs(tmp_path: Path) -> None:
    script = load_script()
    output = tmp_path / "ann-smoke"
    output.mkdir()
    train = script.make_train(16, 4)
    test = script.make_test(train, 5)
    neighbors = script.ground_truth(train, test, 3)
    script.write_vec1(output / "train.bin", train)
    script.write_vec1(output / "test.bin", test)
    script.write_nbr1(output / "neighbors.bin", neighbors)
    script.write_manifest_atomic(
        output / "ann_smoke_dataset.json",
        script.manifest_with_outputs(output, script.expected_manifest(16, 5, 4, 3)),
    )

    assert not script.matching_outputs(output, script.expected_manifest(16, 5, 4, 4))


def test_matching_manifest_rejects_truncated_payload(tmp_path: Path) -> None:
    script = load_script()
    output = tmp_path / "ann-smoke"
    output.mkdir()
    train = script.make_train(16, 4)
    test = script.make_test(train, 5)
    neighbors = script.ground_truth(train, test, 3)
    script.write_vec1(output / "train.bin", train)
    script.write_vec1(output / "test.bin", test)
    script.write_nbr1(output / "neighbors.bin", neighbors)
    script.write_manifest_atomic(
        output / "ann_smoke_dataset.json",
        script.manifest_with_outputs(output, script.expected_manifest(16, 5, 4, 3)),
    )

    train_path = output / "train.bin"
    train_path.write_bytes(train_path.read_bytes()[:12])

    assert not script.matching_outputs(output, script.expected_manifest(16, 5, 4, 3))


def test_manifest_records_payload_hashes(tmp_path: Path) -> None:
    script = load_script()
    output = tmp_path / "ann-smoke"
    output.mkdir()
    train = script.make_train(16, 4)
    test = script.make_test(train, 5)
    neighbors = script.ground_truth(train, test, 3)
    script.write_vec1(output / "train.bin", train)
    script.write_vec1(output / "test.bin", test)
    script.write_nbr1(output / "neighbors.bin", neighbors)

    manifest = script.manifest_with_outputs(
        output,
        script.expected_manifest(16, 5, 4, 3),
    )

    assert set(manifest["outputs"]) == {"train.bin", "test.bin", "neighbors.bin"}
    assert (
        manifest["outputs"]["train.bin"]["bytes"]
        == (output / "train.bin").stat().st_size
    )
    assert len(manifest["outputs"]["train.bin"]["sha256"]) == 64


def test_matching_manifest_rejects_same_size_payload_drift(tmp_path: Path) -> None:
    script = load_script()
    output = tmp_path / "ann-smoke"
    output.mkdir()
    train = script.make_train(16, 4)
    test = script.make_test(train, 5)
    neighbors = script.ground_truth(train, test, 3)
    script.write_vec1(output / "train.bin", train)
    script.write_vec1(output / "test.bin", test)
    script.write_nbr1(output / "neighbors.bin", neighbors)
    script.write_manifest_atomic(
        output / "ann_smoke_dataset.json",
        script.manifest_with_outputs(output, script.expected_manifest(16, 5, 4, 3)),
    )

    train_path = output / "train.bin"
    payload = bytearray(train_path.read_bytes())
    payload[-1] ^= 0x01
    train_path.write_bytes(payload)

    assert not script.matching_outputs(output, script.expected_manifest(16, 5, 4, 3))


def test_cli_writes_hashed_manifest(
    tmp_path: Path,
    monkeypatch: pytest.MonkeyPatch,
) -> None:
    script = load_script()
    output = tmp_path / "ann-smoke"
    monkeypatch.setattr(
        "sys.argv",
        [
            "generate_ann_smoke_data.py",
            str(output),
            "--train",
            "16",
            "--test",
            "5",
            "--dim",
            "4",
            "--k",
            "3",
        ],
    )

    script.main()

    manifest = json.loads((output / "ann_smoke_dataset.json").read_text())
    assert "outputs" in manifest
    assert len(manifest["outputs"]["neighbors.bin"]["sha256"]) == 64