usearch 2.15.1 → 2.15.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -68,17 +68,19 @@ test('Operations with invalid values', () => {
68
68
  const keys = [NaN, 16n];
69
69
  const vectors = [new Float32Array([10, 30]), new Float32Array([1, 5])];
70
70
 
71
- try {
72
- indexBatch.add(keys, vectors);
73
- throw new Error('indexBatch.add should have thrown an error.');
74
- } catch (err) {
75
- assert.equal(err.message, 'All keys must be positive integers or bigints.');
76
- }
77
-
78
- try {
79
- indexBatch.search(NaN, 2);
80
- throw new Error('indexBatch.search should have thrown an error.');
81
- } catch (err) {
82
- assert.equal(err.message, 'Vectors must be a TypedArray or an array of arrays.');
83
- }
71
+ assert.throws(
72
+ () => indexBatch.add(keys, vectors),
73
+ {
74
+ name: 'Error',
75
+ message: 'All keys must be positive integers or bigints.'
76
+ }
77
+ );
78
+
79
+ assert.throws(
80
+ () => indexBatch.search(NaN, 2),
81
+ {
82
+ name: 'Error',
83
+ message: 'Vectors must be a TypedArray or an array of arrays.'
84
+ }
85
+ );
84
86
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "usearch",
3
- "version": "2.15.1",
3
+ "version": "2.15.3",
4
4
  "description": "Smaller & Faster Single-File Vector Search Engine from Unum",
5
5
  "author": "Ash Vardanian (https://ashvardanian.com/)",
6
6
  "license": "Apache 2.0",
Binary file
Binary file
@@ -0,0 +1,128 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our
6
+ community a harassment-free experience for everyone, regardless of age, body
7
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
8
+ identity and expression, level of experience, education, socio-economic status,
9
+ nationality, personal appearance, race, religion, or sexual identity
10
+ and orientation.
11
+
12
+ We pledge to act and interact in ways that contribute to an open, welcoming,
13
+ diverse, inclusive, and healthy community.
14
+
15
+ ## Our Standards
16
+
17
+ Examples of behavior that contributes to a positive environment for our
18
+ community include:
19
+
20
+ * Demonstrating empathy and kindness toward other people
21
+ * Being respectful of differing opinions, viewpoints, and experiences
22
+ * Giving and gracefully accepting constructive feedback
23
+ * Accepting responsibility and apologizing to those affected by our mistakes,
24
+ and learning from the experience
25
+ * Focusing on what is best not just for us as individuals, but for the
26
+ overall community
27
+
28
+ Examples of unacceptable behavior include:
29
+
30
+ * The use of sexualized language or imagery, and sexual attention or
31
+ advances of any kind
32
+ * Trolling, insulting or derogatory comments, and personal or political attacks
33
+ * Public or private harassment
34
+ * Publishing others' private information, such as a physical or email
35
+ address, without their explicit permission
36
+ * Other conduct which could reasonably be considered inappropriate in a
37
+ professional setting
38
+
39
+ ## Enforcement Responsibilities
40
+
41
+ Community leaders are responsible for clarifying and enforcing our standards of
42
+ acceptable behavior and will take appropriate and fair corrective action in
43
+ response to any behavior that they deem inappropriate, threatening, offensive,
44
+ or harmful.
45
+
46
+ Community leaders have the right and responsibility to remove, edit, or reject
47
+ comments, commits, code, wiki edits, issues, and other contributions that are
48
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
49
+ decisions when appropriate.
50
+
51
+ ## Scope
52
+
53
+ This Code of Conduct applies within all community spaces, and also applies when
54
+ an individual is officially representing the community in public spaces.
55
+ Examples of representing our community include using an official e-mail address,
56
+ posting via an official social media account, or acting as an appointed
57
+ representative at an online or offline event.
58
+
59
+ ## Enforcement
60
+
61
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
+ reported to the community leaders responsible for enforcement at
63
+ info@unum.cloud.
64
+ All complaints will be reviewed and investigated promptly and fairly.
65
+
66
+ All community leaders are obligated to respect the privacy and security of the
67
+ reporter of any incident.
68
+
69
+ ## Enforcement Guidelines
70
+
71
+ Community leaders will follow these Community Impact Guidelines in determining
72
+ the consequences for any action they deem in violation of this Code of Conduct:
73
+
74
+ ### 1. Correction
75
+
76
+ **Community Impact**: Use of inappropriate language or other behavior deemed
77
+ unprofessional or unwelcome in the community.
78
+
79
+ **Consequence**: A private, written warning from community leaders, providing
80
+ clarity around the nature of the violation and an explanation of why the
81
+ behavior was inappropriate. A public apology may be requested.
82
+
83
+ ### 2. Warning
84
+
85
+ **Community Impact**: A violation through a single incident or series
86
+ of actions.
87
+
88
+ **Consequence**: A warning with consequences for continued behavior. No
89
+ interaction with the people involved, including unsolicited interaction with
90
+ those enforcing the Code of Conduct, for a specified period of time. This
91
+ includes avoiding interactions in community spaces as well as external channels
92
+ like social media. Violating these terms may lead to a temporary or
93
+ permanent ban.
94
+
95
+ ### 3. Temporary Ban
96
+
97
+ **Community Impact**: A serious violation of community standards, including
98
+ sustained inappropriate behavior.
99
+
100
+ **Consequence**: A temporary ban from any sort of interaction or public
101
+ communication with the community for a specified period of time. No public or
102
+ private interaction with the people involved, including unsolicited interaction
103
+ with those enforcing the Code of Conduct, is allowed during this period.
104
+ Violating these terms may lead to a permanent ban.
105
+
106
+ ### 4. Permanent Ban
107
+
108
+ **Community Impact**: Demonstrating a pattern of violation of community
109
+ standards, including sustained inappropriate behavior, harassment of an
110
+ individual, or aggression toward or disparagement of classes of individuals.
111
+
112
+ **Consequence**: A permanent ban from any sort of public interaction within
113
+ the community.
114
+
115
+ ## Attribution
116
+
117
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
+ version 2.0, available at
119
+ https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120
+
121
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct
122
+ enforcement ladder](https://github.com/mozilla/diversity).
123
+
124
+ [homepage]: https://www.contributor-covenant.org
125
+
126
+ For answers to common questions about this code of conduct, see the FAQ at
127
+ https://www.contributor-covenant.org/faq. Translations are available at
128
+ https://www.contributor-covenant.org/translations.
@@ -6,7 +6,7 @@ To rerun experiments utilize the following command:
6
6
 
7
7
  ```sh
8
8
  sudo apt install libopenblas-dev # BLAS installation is optional, but recommended for benchmarks
9
- cmake -DCMAKE_BUILD_TYPE=Release -DSIMSIMD_BUILD_TESTS=1 -DSIMSIMD_BUILD_BENCHMARKS=1 -DSIMSIMD_BUILD_BENCHMARKS_WITH_CBLAS=1 -B build_release
9
+ cmake -D CMAKE_BUILD_TYPE=Release -D SIMSIMD_BUILD_TESTS=1 -D SIMSIMD_BUILD_BENCHMARKS=1 -D SIMSIMD_BUILD_BENCHMARKS_WITH_CBLAS=1 -B build_release
10
10
  cmake --build build_release --config Release
11
11
  build_release/simsimd_bench
12
12
  build_release/simsimd_bench --benchmark_filter=js
@@ -14,7 +14,7 @@ build_release/simsimd_test_run_time
14
14
  build_release/simsimd_test_compile_time # no need to run this one, it's just a compile-time test
15
15
  ```
16
16
 
17
- To utilize newest instructions, use GCC 12 or newer, or Clang 16 or newer.
17
+ To utilize `f16` instructions, use GCC 12 or newer, or Clang 16 or newer.
18
18
  To install them on Ubuntu 22.04, use:
19
19
 
20
20
  ```sh
@@ -28,9 +28,9 @@ Replacing the default compiler is not recommended, as it may break the system, b
28
28
 
29
29
  ```sh
30
30
  brew install llvm
31
- cmake -DCMAKE_BUILD_TYPE=Release -DSIMSIMD_BUILD_TESTS=1 \
32
- -DCMAKE_C_COMPILER="$(brew --prefix llvm)/bin/clang" \
33
- -DCMAKE_CXX_COMPILER="$(brew --prefix llvm)/bin/clang++" \
31
+ cmake -D CMAKE_BUILD_TYPE=Release -D SIMSIMD_BUILD_TESTS=1 \
32
+ -D CMAKE_C_COMPILER="$(brew --prefix llvm)/bin/clang" \
33
+ -D CMAKE_CXX_COMPILER="$(brew --prefix llvm)/bin/clang++" \
34
34
  -B build_release
35
35
  cmake --build build_release --config Release
36
36
  ```
@@ -40,15 +40,25 @@ cmake --build build_release --config Release
40
40
  Testing:
41
41
 
42
42
  ```sh
43
- pip install -e . # to install the package in editable mode
44
- pip install pytest pytest-repeat # testing dependencies
45
- pytest python/test.py -s -x -Wd # to run tests
43
+ pip install -e . # to install the package in editable mode
44
+ pip install pytest pytest-repeat tabulate # testing dependencies
45
+ pytest python/test.py -s -x -Wd # to run tests
46
+
47
+ # to check supported SIMD instructions:
48
+ python -c "import simsimd; print(simsimd.get_capabilities())"
46
49
  ```
47
50
 
48
51
  Here, `-s` will output the logs.
49
52
  The `-x` will stop on the first failure.
50
53
  The `-Wd` will silence overflows and runtime warnings.
51
54
 
55
+ When building on MacOS, same as with C/C++, use non-Apple Clang version:
56
+
57
+ ```sh
58
+ brew install llvm
59
+ CC=$(brew --prefix llvm)/bin/clang CXX=$(brew --prefix llvm)/bin/clang++ pip install -e .
60
+ ```
61
+
52
62
  Benchmarking:
53
63
 
54
64
  ```sh
@@ -496,7 +496,7 @@ dependencies = [
496
496
 
497
497
  [[package]]
498
498
  name = "simsimd"
499
- version = "5.0.0"
499
+ version = "5.6.4"
500
500
  dependencies = [
501
501
  "cc",
502
502
  "criterion",
@@ -1,7 +1,7 @@
1
1
  [package]
2
2
  name = "simsimd"
3
3
  description = "Fastest SIMD-Accelerated Vector Similarity Functions for x86 and Arm"
4
- version = "5.0.0"
4
+ version = "5.6.4"
5
5
  edition = "2021"
6
6
  license = "Apache-2.0"
7
7
  authors = ["Ash Vardanian <1983160+ashvardanian@users.noreply.github.com>"]
@@ -0,0 +1,2 @@
1
+ include include/simsimd/*.h
2
+ include include/*