[docs] Update return statement of index search

[stevhliu]

Clarifies in the return statement of the docstring that the retrieval score is IndexFlatL2 by default (see PR and internal Slack convo), and fixes the formatting because multiple return values are not supported.

[HuggingFaceDocBuilderDev]

The documentation is not available anymore as the PR was closed or merged.

[lhoestq]

Thanks ! Just one suggestion:

[github-actions]

Show benchmarks

PyArrow==8.0.0

Show updated benchmarks!

Benchmark: benchmark_array_xd.json

metric	read_batch_formatted_as_numpy after write_array2d	read_batch_formatted_as_numpy after write_flattened_sequence	read_batch_formatted_as_numpy after write_nested_sequence	read_batch_unformated after write_array2d	read_batch_unformated after write_flattened_sequence	read_batch_unformated after write_nested_sequence	read_col_formatted_as_numpy after write_array2d	read_col_formatted_as_numpy after write_flattened_sequence	read_col_formatted_as_numpy after write_nested_sequence	read_col_unformated after write_array2d	read_col_unformated after write_flattened_sequence	read_col_unformated after write_nested_sequence	read_formatted_as_numpy after write_array2d	read_formatted_as_numpy after write_flattened_sequence	read_formatted_as_numpy after write_nested_sequence	read_unformated after write_array2d	read_unformated after write_flattened_sequence	read_unformated after write_nested_sequence	write_array2d	write_flattened_sequence	write_nested_sequence
new / old (diff)	0.007697 / 0.011353 (-0.003656)	0.004233 / 0.011008 (-0.006776)	0.087890 / 0.038508 (0.049382)	0.065305 / 0.023109 (0.042196)	0.366919 / 0.275898 (0.091020)	0.399656 / 0.323480 (0.076176)	0.006753 / 0.007986 (-0.001232)	0.003428 / 0.004328 (-0.000900)	0.070180 / 0.004250 (0.065930)	0.054164 / 0.037052 (0.017112)	0.377130 / 0.258489 (0.118641)	0.403456 / 0.293841 (0.109615)	0.042639 / 0.128546 (-0.085907)	0.012396 / 0.075646 (-0.063250)	0.314235 / 0.419271 (-0.105036)	0.061976 / 0.043533 (0.018443)	0.376959 / 0.255139 (0.121820)	0.433313 / 0.283200 (0.150113)	0.031253 / 0.141683 (-0.110430)	1.555749 / 1.452155 (0.103594)	1.643905 / 1.492716 (0.151189)

Benchmark: benchmark_getitem_100B.json

metric	get_batch_of_1024_random_rows	get_batch_of_1024_rows	get_first_row	get_last_row
new / old (diff)	0.208630 / 0.018006 (0.190624)	0.519532 / 0.000490 (0.519042)	0.003719 / 0.000200 (0.003519)	0.000099 / 0.000054 (0.000045)

Benchmark: benchmark_indices_mapping.json

metric	select	shard	shuffle	sort	train_test_split
new / old (diff)	0.027403 / 0.037411 (-0.010008)	0.080990 / 0.014526 (0.066464)	0.090424 / 0.176557 (-0.086133)	0.153922 / 0.737135 (-0.583213)	0.098156 / 0.296338 (-0.198183)

Benchmark: benchmark_iterating.json

metric	read 5000	read 50000	read_batch 50000 10	read_batch 50000 100	read_batch 50000 1000	read_formatted numpy 5000	read_formatted pandas 5000	read_formatted tensorflow 5000	read_formatted torch 5000	read_formatted_batch numpy 5000 10	read_formatted_batch numpy 5000 1000	shuffled read 5000	shuffled read 50000	shuffled read_batch 50000 10	shuffled read_batch 50000 100	shuffled read_batch 50000 1000	shuffled read_formatted numpy 5000	shuffled read_formatted_batch numpy 5000 10	shuffled read_formatted_batch numpy 5000 1000
new / old (diff)	0.519453 / 0.215209 (0.304244)	5.100089 / 2.077655 (3.022434)	2.212165 / 1.504120 (0.708045)	1.894405 / 1.541195 (0.353210)	1.922914 / 1.468490 (0.454424)	0.762443 / 4.584777 (-3.822334)	4.669214 / 3.745712 (0.923502)	5.016066 / 5.269862 (-0.253796)	3.128821 / 4.565676 (-1.436856)	0.091541 / 0.424275 (-0.332734)	0.007582 / 0.007607 (-0.000026)	0.652753 / 0.226044 (0.426709)	6.601375 / 2.268929 (4.332446)	3.076948 / 55.444624 (-52.367677)	2.250544 / 6.876477 (-4.625933)	2.404059 / 2.142072 (0.261987)	0.994917 / 4.805227 (-3.810311)	0.200318 / 6.500664 (-6.300346)	0.069354 / 0.075469 (-0.006115)

Benchmark: benchmark_map_filter.json

metric	filter	map fast-tokenizer batched	map identity	map identity batched	map no-op batched	map no-op batched numpy	map no-op batched pandas	map no-op batched pytorch	map no-op batched tensorflow
new / old (diff)	1.482559 / 1.841788 (-0.359229)	20.722092 / 8.074308 (12.647784)	17.703217 / 10.191392 (7.511825)	0.215370 / 0.680424 (-0.465053)	0.028208 / 0.534201 (-0.505993)	0.425992 / 0.579283 (-0.153291)	0.492785 / 0.434364 (0.058421)	0.474154 / 0.540337 (-0.066183)	0.644599 / 1.386936 (-0.742337)

PyArrow==latest

Show updated benchmarks!

Benchmark: benchmark_array_xd.json

metric	read_batch_formatted_as_numpy after write_array2d	read_batch_formatted_as_numpy after write_flattened_sequence	read_batch_formatted_as_numpy after write_nested_sequence	read_batch_unformated after write_array2d	read_batch_unformated after write_flattened_sequence	read_batch_unformated after write_nested_sequence	read_col_formatted_as_numpy after write_array2d	read_col_formatted_as_numpy after write_flattened_sequence	read_col_formatted_as_numpy after write_nested_sequence	read_col_unformated after write_array2d	read_col_unformated after write_flattened_sequence	read_col_unformated after write_nested_sequence	read_formatted_as_numpy after write_array2d	read_formatted_as_numpy after write_flattened_sequence	read_formatted_as_numpy after write_nested_sequence	read_unformated after write_array2d	read_unformated after write_flattened_sequence	read_unformated after write_nested_sequence	write_array2d	write_flattened_sequence	write_nested_sequence
new / old (diff)	0.008372 / 0.011353 (-0.002981)	0.004543 / 0.011008 (-0.006465)	0.070564 / 0.038508 (0.032056)	0.066855 / 0.023109 (0.043746)	0.386724 / 0.275898 (0.110826)	0.432184 / 0.323480 (0.108704)	0.005250 / 0.007986 (-0.002736)	0.003630 / 0.004328 (-0.000698)	0.069310 / 0.004250 (0.065060)	0.055759 / 0.037052 (0.018707)	0.375789 / 0.258489 (0.117299)	0.417335 / 0.293841 (0.123494)	0.043424 / 0.128546 (-0.085122)	0.013106 / 0.075646 (-0.062541)	0.087836 / 0.419271 (-0.331436)	0.057770 / 0.043533 (0.014237)	0.396694 / 0.255139 (0.141555)	0.439350 / 0.283200 (0.156150)	0.031660 / 0.141683 (-0.110023)	1.571339 / 1.452155 (0.119185)	1.667169 / 1.492716 (0.174452)

Benchmark: benchmark_getitem_100B.json

metric	get_batch_of_1024_random_rows	get_batch_of_1024_rows	get_first_row	get_last_row
new / old (diff)	0.180534 / 0.018006 (0.162528)	0.540027 / 0.000490 (0.539537)	0.003573 / 0.000200 (0.003373)	0.000141 / 0.000054 (0.000086)

Benchmark: benchmark_indices_mapping.json

metric	select	shard	shuffle	sort	train_test_split
new / old (diff)	0.031380 / 0.037411 (-0.006032)	0.083762 / 0.014526 (0.069236)	0.098166 / 0.176557 (-0.078390)	0.160761 / 0.737135 (-0.576374)	0.097683 / 0.296338 (-0.198656)

Benchmark: benchmark_iterating.json

metric	read 5000	read 50000	read_batch 50000 10	read_batch 50000 100	read_batch 50000 1000	read_formatted numpy 5000	read_formatted pandas 5000	read_formatted tensorflow 5000	read_formatted torch 5000	read_formatted_batch numpy 5000 10	read_formatted_batch numpy 5000 1000	shuffled read 5000	shuffled read 50000	shuffled read_batch 50000 10	shuffled read_batch 50000 100	shuffled read_batch 50000 1000	shuffled read_formatted numpy 5000	shuffled read_formatted_batch numpy 5000 10	shuffled read_formatted_batch numpy 5000 1000
new / old (diff)	0.568074 / 0.215209 (0.352865)	5.660544 / 2.077655 (3.582889)	2.416698 / 1.504120 (0.912578)	2.177096 / 1.541195 (0.635901)	2.206178 / 1.468490 (0.737688)	0.844864 / 4.584777 (-3.739912)	4.793636 / 3.745712 (1.047923)	7.062387 / 5.269862 (1.792525)	4.201228 / 4.565676 (-0.364449)	0.091997 / 0.424275 (-0.332279)	0.007881 / 0.007607 (0.000274)	0.679466 / 0.226044 (0.453422)	6.580268 / 2.268929 (4.311340)	3.229907 / 55.444624 (-52.214717)	2.524877 / 6.876477 (-4.351600)	2.463796 / 2.142072 (0.321723)	0.975627 / 4.805227 (-3.829600)	0.186670 / 6.500664 (-6.313994)	0.065307 / 0.075469 (-0.010163)

Benchmark: benchmark_map_filter.json

metric	filter	map fast-tokenizer batched	map identity	map identity batched	map no-op batched	map no-op batched numpy	map no-op batched pandas	map no-op batched pytorch	map no-op batched tensorflow
new / old (diff)	1.501447 / 1.841788 (-0.340340)	21.231037 / 8.074308 (13.156729)	17.591671 / 10.191392 (7.400279)	0.212745 / 0.680424 (-0.467679)	0.026100 / 0.534201 (-0.508101)	0.428391 / 0.579283 (-0.150892)	0.535268 / 0.434364 (0.100904)	0.506733 / 0.540337 (-0.033604)	0.660832 / 1.386936 (-0.726104)