usearch 2.3.0 → 2.3.2

package/.github/workflows/release.yml

@@ -219,7 +219,7 @@ jobs:
   publish_hashes:
     name: Add hashes to release notes
     runs-on: ubuntu-latest
-    needs: [versioning, create_linux_deb_package, create_windows_dll_library, create_macos_library]
+    needs: [versioning, create_linux_deb_package, create_windows_dll_library, create_macos_library, deploy_docs_pages]
     steps:
     - name: Get last release ID
       id: last_release
@@ -266,6 +266,7 @@ jobs:
             * ${{ steps.hashes.outputs.asset_name_6 }} : `${{ steps.hashes.outputs.asset_hash_6 }}`
             * ${{ steps.hashes.outputs.asset_name_7 }} : `${{ steps.hashes.outputs.asset_hash_7 }}`
             * ${{ steps.hashes.outputs.asset_name_8 }} : `${{ steps.hashes.outputs.asset_hash_8 }}`
+            * ${{ steps.hashes.outputs.asset_name_9 }} : `${{ steps.hashes.outputs.asset_hash_9 }}`
 
 
   build_wheels:

package/.releaserc

@@ -77,10 +77,14 @@
                     "conanfile.py",
                     "package.json",
                     "Cargo.toml",
-                    "wasmer.toml"
+                    "wasmer.toml",
+                    "./include/usearch/index.hpp",
+                    "README.md",
+                    "./csharp/nuget/nuget-package.props",
+                    "CITATION.cff"
                 ],
                 "message": "Build: Released ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
             }
         ]
     ]
-}
+}

package/CITATION.cff

@@ -5,7 +5,7 @@ authors:
   given-names: "Ash"
   orcid: "https://orcid.org/0000-0002-4882-1815"
 title: "USearch by Unum Cloud"
-version: 0.13.0
+version: 2.3.2
 doi: 10.5281/zenodo.7949416
 date-released: 2022-06-12
 url: "https://github.com/unum-cloud/usearch"

package/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "usearch"
-version = "2.3.0"
+version = "2.3.2"
 authors = ["Ash Vardanian <1983160+ashvardanian@users.noreply.github.com>"]
 description = "Smaller & Faster Single-File Vector Search Engine from Unum"
 edition = "2021"

package/README.md

@@ -392,7 +392,7 @@ doi = {10.5281/zenodo.7949416},
 author = {Vardanian, Ash},
 title = {{USearch by Unum Cloud}},
 url = {https://github.com/unum-cloud/usearch},
-version = {1.0.0},
+version = {2.3.2},
 year = {2022},
 month = jun,
 }

package/conanfile.py

@@ -4,7 +4,7 @@ from conans import ConanFile
 class USearchConan(ConanFile):
 
     name = 'USearch'
-    version = '2.3.0'
+    version = '2.3.2'
     license = 'Apache 2.0'
     url = 'https://github.com/unum-cloud/usearch'
     description = 'Smaller & Faster Single-File Vector Search Engine from Unum'

package/csharp/nuget/nuget-package.props

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project>
   <PropertyGroup>
-    <Version Condition="'$(Version)' == ''">0.0.2</Version>
+    <Version Condition="'$(Version)' == ''">2.3.2</Version>
 
     <Authors>Unum</Authors>
     <Company>Unum</Company>

package/include/usearch/index.hpp

@@ -9,9 +9,9 @@
 #ifndef UNUM_USEARCH_HPP
 #define UNUM_USEARCH_HPP
 
-#define USEARCH_VERSION_MAJOR 0
-#define USEARCH_VERSION_MINOR 0
-#define USEARCH_VERSION_PATCH 0
+#define USEARCH_VERSION_MAJOR 2
+#define USEARCH_VERSION_MINOR 3
+#define USEARCH_VERSION_PATCH 2
 
 // Inferring C++ version
 // https://stackoverflow.com/a/61552074
@@ -1362,7 +1362,7 @@ class output_file_t {
         serialization_result_t result;
         std::size_t written = std::fwrite(begin, length, 1, file_);
         if (!written)
-            result.failed(std::strerror(errno));
+            return result.failed(std::strerror(errno));
         return result;
     }
     void close() noexcept {
@@ -1404,7 +1404,7 @@ class input_file_t {
         serialization_result_t result;
         std::size_t read = std::fread(begin, length, 1, file_);
         if (!read)
-            result.failed(std::feof(file_) ? "End of file reached!" : std::strerror(errno));
+            return result.failed(std::feof(file_) ? "End of file reached!" : std::strerror(errno));
         return result;
     }
     void close() noexcept {

package/include/usearch/index_dense.hpp

@@ -1041,8 +1041,10 @@ class index_dense_gt {
             },
             config, std::forward<progress_at>(progress));
 
-        if (!stream_result)
+        if (!stream_result) {
+            io_result.error.release();
             return stream_result;
+        }
         return io_result;
     }
 
@@ -1093,8 +1095,10 @@ class index_dense_gt {
             },
             config, std::forward<progress_at>(progress));
 
-        if (!stream_result)
+        if (!stream_result) {
+            io_result.error.release();
             return stream_result;
+        }
         return io_result;
     }
 

package/include/usearch/index_plugins.hpp

@@ -41,7 +41,15 @@
 #endif
 
 #if USEARCH_USE_SIMSIMD
-#if __linux__
+#if defined(USEARCH_DEFINED_LINUX)
+#define SIMSIMD_TARGET_X86_AVX2 1
+#define SIMSIMD_TARGET_X86_AVX512 1
+#define SIMSIMD_TARGET_ARM_NEON 1
+#define SIMSIMD_TARGET_ARM_SVE 1
+#include <simsimd/simsimd.h>
+#elif defined(USEARCH_DEFINED_APPLE)
+#define SIMSIMD_TARGET_X86_AVX2 1
+#define SIMSIMD_TARGET_ARM_NEON 1
 #include <simsimd/simsimd.h>
 #endif
 #endif

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "usearch",
-    "version": "2.3.0",
+    "version": "2.3.2",
     "description": "Smaller & Faster Single-File Vector Search Engine from Unum",
     "author": "Ash Vardanian",
     "license": "Apache 2.0",

package/python/lib.cpp

@@ -1021,8 +1021,8 @@ PYBIND11_MODULE(compiled, m) {
 
     m.def(
         "hardware_acceleration",
-        [](scalar_kind_t scalar_kind, std::size_t dimensions, metric_kind_t metric_kind) -> bool {
-            return metric_t(dimensions, metric_kind, scalar_kind).isa_kind() != isa_kind_t::auto_k;
+        [](scalar_kind_t scalar_kind, std::size_t dimensions, metric_kind_t metric_kind) -> py::str {
+            return isa_name(metric_t(dimensions, metric_kind, scalar_kind).isa_kind());
         },
         py::kw_only(),                                //
         py::arg("dtype") = scalar_kind_t::f32_k,      //

package/rust/README.md

@@ -6,18 +6,20 @@
 cargo add usearch
 ```
 
+You can find [interface documentation on docs.rs](https://docs.rs/usearch/2.3.0/usearch/ffi/struct.Index.html).
+
 ## Quickstart
 
 ```rust
 
 let options = IndexOptions {
-            dimensions: 3,
-            metric: MetricKind::IP,
-            quantization: ScalarKind::F16,
-            connectivity: 0,
-            expansion_add: 0,
-            expansion_search: 0
-        };
+    dimensions: 3,
+    metric: MetricKind::IP,
+    quantization: ScalarKind::F16,
+    connectivity: 0,
+    expansion_add: 0,
+    expansion_search: 0
+};
 
 let index = new_index(&options).unwrap();
 
@@ -39,17 +41,6 @@ let results = index.search(&first, 10).unwrap();
 assert_eq!(results.keys.len(), 2);
 ```
 
-## Multi-Threading
-
-```rust
-assert!(index.add_in_thread(42, &first, 0).is_ok());
-assert!(index.add_in_thread(43, &second, 0).is_ok());
-let results = index.search_in_thread(&first, 10, 0).unwrap();
-```
-
-Being a systems-programming language, Rust has better control over memory management and concurrency but lacks function overloading.
-Aside from the `add` and `search`, USearch Rust binding also provides `add_in_thread` and `search_in_thread`, which let users identify the calling thread to use underlying temporary memory more efficiently.
-
 ## Serialization
 
 ```rust
@@ -58,6 +49,14 @@ assert!(index.load("index.usearch").is_ok());
 assert!(index.view("index.usearch").is_ok());
 ```
 
+Similarly, serializing to/from buffers is supported.
+
+```rust
+assert!(index.save_to_buffer(&mut serialization_buffer).is_ok());
+assert!(index.load_from_buffer(&serialization_buffer).is_ok());
+assert!(index.view_from_buffer(&serialization_buffer).is_ok());
+```
+
 ## Metrics
 
 ```rust

package/swift/README.md

@@ -9,13 +9,13 @@ https://github.com/unum-cloud/usearch
 ## Quickstart
 
 ```swift
-let index = Index.l2sq(dimensions: 3, connectivity: 8)
-let vectorA: [Float32] = [0.3, 0.5, 1.2]
-let vectorB: [Float32] = [0.4, 0.2, 1.2]
-index.add(key: 42, vector: vectorA[...])
-index.add(key: 43, vector: vectorB[...])
+let index = USearchIndex.make(metric: .Cos, dimensions: 3, connectivity: 8)
+let vectorA: [Float32] = [0.3, 0.5, 1.2] // `Float32` and `Float64` are always supported
+let vectorB: [Float32] = [0.4, 0.2, 1.2] // `Float16` supports on the OS & hardware version
+index.add(key: 42, vector: vectorA) // Pass full arrays or slices
+index.add(key: 43, vector: vectorB)
 
-let results = index.search(vector: vectorA[...], count: 10)
+let results = index.search(vector: vectorA, count: 10)
 assert(results.0[0] == 42)
 ```
 
@@ -32,7 +32,7 @@ struct USearchMobileApp: App {
             let index = USearchIndex.make(metric: .IP, dimensions: 2, connectivity: 16, quantization: .F32)
             let _ = index.reserve(10)
             let coordiantes: Array<Float32> = [40.177200, 44.503490]
-            let _ = index.add(key: 10, vector: coordiantes[...])            
+            let _ = index.add(key: 10, vector: coordiantes)            
             VStack {
                 Text("USearch index contains \(index.length) vectors")
                 Spacer()
@@ -42,3 +42,7 @@ struct USearchMobileApp: App {
     }
 }
 ```
+
+You can find a working example of using USearch with SwiftUI maps at [ashvardanian/SwiftVectorSearch](https://github.com/ashvardanian/SwiftVectorSearch).
+
+[![](https://media.githubusercontent.com/media/ashvardanian/SwiftVectorSearch/main/USearch%2BSwiftUI.gif)](https://github.com/ashvardanian/SwiftVectorSearch)

package/wasmer.toml

@@ -1,6 +1,6 @@
 [package]
 name="unum/usearch"
-version="2.3.0"
+version="2.3.2"
 description="Smaller & Faster Single-File Vector Search Engine from Unum"
 license="Apache-2.0"
 readme="README.md"