vicinity 0.11.1

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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229

from __future__ import annotations

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

import numpy as np
import pytest


def load_script() -> ModuleType:
    script_path = (
        Path(__file__).resolve().parents[1] / "scripts/download_ann_benchmarks.py"
    )
    spec = importlib.util.spec_from_file_location(
        "download_ann_benchmarks", 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 write_converted_fixture(script: ModuleType, output_dir: Path) -> dict[str, object]:
    output_dir.mkdir()
    hdf5_path = output_dir / "tiny-angular.hdf5"
    hdf5_path.write_bytes(b"cached-hdf5")
    script.write_vec1(output_dir / "train.bin", np.zeros((3, 2), dtype=np.float32))
    script.write_vec1(output_dir / "test.bin", np.ones((2, 2), dtype=np.float32))
    script.write_nbr1(
        output_dir / "neighbors.bin",
        np.array([[0, 1], [1, 2]], dtype=np.int32),
    )
    return {
        "url": "https://example.invalid/tiny-angular.hdf5",
        "metric": "angular",
        "normalize": True,
        "recompute_ground_truth": True,
        "expected_bytes": hdf5_path.stat().st_size,
        "expected_sha256": script.sha256_file(hdf5_path),
    }


def test_manifestless_outputs_require_explicit_adoption(tmp_path: Path) -> None:
    script = load_script()
    output_dir = tmp_path / "tiny-angular"
    info = write_converted_fixture(script, output_dir)

    with pytest.raises(SystemExit, match="--adopt-existing"):
        script.convert_dataset(
            "tiny-angular",
            info,
            output_dir,
            force=False,
            redownload=False,
        )

    assert not (output_dir / "dataset.json").exists()


def test_adopt_existing_outputs_writes_manifest(tmp_path: Path) -> None:
    script = load_script()
    output_dir = tmp_path / "tiny-angular"
    info = write_converted_fixture(script, output_dir)

    script.convert_dataset(
        "tiny-angular",
        info,
        output_dir,
        force=False,
        redownload=False,
        adopt_existing=True,
    )

    manifest = json.loads((output_dir / "dataset.json").read_text())
    assert manifest["complete"] is True
    assert manifest["settings"] == script.conversion_settings("tiny-angular", info)
    assert manifest["outputs"] == {
        "train_shape": [3, 2],
        "test_shape": [2, 2],
        "neighbors_shape": [2, 2],
    }


def test_matching_manifest_reuses_converted_outputs(
    tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> None:
    script = load_script()
    output_dir = tmp_path / "tiny-angular"
    info = write_converted_fixture(script, output_dir)
    hdf5_path = output_dir / "tiny-angular.hdf5"
    script.write_complete_manifest_from_shapes(
        output_dir,
        "tiny-angular",
        info,
        hdf5_path,
        script.existing_output_shapes(output_dir),
    )

    def fail_download(*_args: object, **_kwargs: object) -> NoReturn:
        raise AssertionError("idempotent conversion should not download")

    monkeypatch.setattr(script, "download_file", fail_download)

    script.convert_dataset(
        "tiny-angular",
        info,
        output_dir,
        force=False,
        redownload=False,
    )


def test_adopt_existing_outputs_checks_hdf5_size(tmp_path: Path) -> None:
    script = load_script()
    output_dir = tmp_path / "tiny-angular"
    info = write_converted_fixture(script, output_dir)
    info["expected_bytes"] = 1

    with pytest.raises(SystemExit, match="expected 1"):
        script.convert_dataset(
            "tiny-angular",
            info,
            output_dir,
            force=False,
            redownload=False,
            adopt_existing=True,
        )


def test_adopt_existing_outputs_checks_hdf5_sha256(tmp_path: Path) -> None:
    script = load_script()
    output_dir = tmp_path / "tiny-angular"
    info = write_converted_fixture(script, output_dir)
    info["expected_sha256"] = "0" * 64

    with pytest.raises(SystemExit, match="SHA256"):
        script.convert_dataset(
            "tiny-angular",
            info,
            output_dir,
            force=False,
            redownload=False,
            adopt_existing=True,
        )


def test_download_file_checks_cached_hdf5_sha256(tmp_path: Path) -> None:
    script = load_script()
    path = tmp_path / "tiny.hdf5"
    path.write_bytes(b"cached-hdf5")

    with pytest.raises(SystemExit, match="SHA256"):
        script.download_file(
            "https://example.invalid/tiny.hdf5",
            path,
            expected_sha256="0" * 64,
        )


def test_download_dataset_hdf5_downloads_without_converting(
    tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> None:
    script = load_script()
    output_dir = tmp_path / "tiny-angular"
    info = {
        "url": "https://example.invalid/tiny-angular.hdf5",
        "metric": "angular",
        "normalize": True,
        "expected_bytes": len(b"hdf5"),
        "expected_sha256": "expected-hash",
    }

    def fake_download(
        _url: str,
        dest: Path,
        *,
        redownload: bool,
        expected_bytes: int | None,
        expected_sha256: str | None,
    ) -> None:
        assert redownload is False
        assert expected_bytes == len(b"hdf5")
        assert expected_sha256 == "expected-hash"
        dest.write_bytes(b"hdf5")

    monkeypatch.setattr(script, "download_file", fake_download)

    script.download_dataset_hdf5(
        "tiny-angular",
        info,
        output_dir,
        redownload=False,
    )

    assert (output_dir / "tiny-angular.hdf5").read_bytes() == b"hdf5"
    assert not (output_dir / "dataset.json").exists()
    assert not (output_dir / "train.bin").exists()


def test_selected_dataset_names_returns_single_dataset() -> None:
    script = load_script()

    assert script.selected_dataset_names("glove-25-angular", False) == [
        "glove-25-angular"
    ]


def test_selected_dataset_names_returns_all_configured_datasets() -> None:
    script = load_script()

    assert script.selected_dataset_names(None, True) == list(script.DATASETS)


def test_selected_dataset_names_rejects_missing_dataset() -> None:
    script = load_script()

    with pytest.raises(SystemExit, match="dataset is required"):
        script.selected_dataset_names(None, False)


def test_selected_dataset_names_rejects_all_with_named_dataset() -> None:
    script = load_script()

    with pytest.raises(SystemExit, match="--all cannot be combined"):
        script.selected_dataset_names("glove-25-angular", True)