usearch 2.3.2 → 2.4.1

package/.github/workflows/prerelease.yml

@@ -34,7 +34,7 @@ jobs:
         cmake -B ./build_release \
         -DCMAKE_CXX_COMPILER="g++-12" \
         -DCMAKE_BUILD_TYPE=Release \
-        -DUSEARCH_BUILD_TEST=1 \
+        -DUSEARCH_BUILD_CTEST=1 \
         -DUSEARCH_USE_OPENMP=1 \
         -DUSEARCH_USE_SIMSIMD=1 \
         -DUSEARCH_USE_JEMALLOC=1 \
@@ -101,7 +101,7 @@ jobs:
         run: python -m pip install .
         if: ${{ matrix.os != 'ubuntu-22.04' }}
       - name: Test with PyTest
-        run: pytest python/scripts/
+        run: pytest python/scripts/ -s -x
 
 
   test_python_37:
@@ -136,7 +136,7 @@ jobs:
         if: ${{ matrix.os == 'ubuntu-22.04' }}
 
       - name: Test with PyTest
-        run: pytest python/scripts/
+        run: pytest python/scripts/ -s -x
 
 
   test_javascript:

package/.github/workflows/release.yml

@@ -216,10 +216,95 @@ jobs:
         update_latest_release: true
 
 
-  publish_hashes:
-    name: Add hashes to release notes
+  wasm_c_library:
+    name: WASM builds for C libraries on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    needs: versioning
+    strategy:
+      matrix:
+        os: [ubuntu-22.04, macOS-11, windows-2022]
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        persist-credentials: false
+        ref: 'main'
+    - run: git submodule update --init --recursive
+
+    - name: Get version
+      id: version
+      run: |
+        version=$(cat VERSION)
+        echo "version=$version" >> $GITHUB_OUTPUT
+      shell: bash
+
+    - name: Build library on Ubuntu
+      run: |
+        export WASI_VERSION=20
+        export WASI_VERSION_FULL=${WASI_VERSION}.0
+        wget https://github.com/WebAssembly/wasi-sdk/releases/download/wasi-sdk-${WASI_VERSION}/wasi-sdk-${WASI_VERSION_FULL}-linux.tar.gz
+        tar xf wasi-sdk-${WASI_VERSION_FULL}-linux.tar.gz
+        rm -rf wasi-sdk-${WASI_VERSION_FULL}-linux.tar.gz
+        export WASI_SDK_PATH=/home/runner/work/usearch/usearch/wasi-sdk-${WASI_VERSION_FULL}
+        archs=("x86_64" "arm64")
+        cd ./c
+        for arch in "${archs[@]}"
+        do
+          ../wasi-sdk-20.0/bin/clang++ --sysroot=${WASI_SDK_PATH}/share/wasi-sysroot -o libusearch.so -O3 lib.cpp -I.  -I ../include/  -I ../fp16/include/ -shared --target=wasm32-wasi-threads  -Wl,--no-entry -nostdlib -D_WASI_EMULATED_MMAN -march="$arch"
+          tar -czvf usearch_wasm_linux_"$arch"_${{ steps.version.outputs.version }}.tar.gz libusearch.so
+          mv usearch_wasm_linux_"$arch"_${{ steps.version.outputs.version }}.tar.gz ../ && rm -rf libusearch.so
+        done
+      if: matrix.os == 'ubuntu-22.04'
+
+    - name: Build library on MacOS
+      run: |
+        export WASI_VERSION=20
+        export WASI_VERSION_FULL=${WASI_VERSION}.0
+        wget https://github.com/WebAssembly/wasi-sdk/releases/download/wasi-sdk-${WASI_VERSION}/wasi-sdk-${WASI_VERSION_FULL}-macos.tar.gz
+        tar xf wasi-sdk-${WASI_VERSION_FULL}-macos.tar.gz
+        rm -rf wasi-sdk-${WASI_VERSION_FULL}-macos.tar.gz
+        export WASI_SDK_PATH=/Users/runner/work/usearch/usearch/wasi-sdk-${WASI_VERSION_FULL}
+        archs=("x86_64" "arm64")
+        cd ./c 
+        for arch in "${archs[@]}"
+        do
+          ../wasi-sdk-20.0/bin/clang++ --sysroot=${WASI_SDK_PATH}/share/wasi-sysroot -o libusearch.so -O3 lib.cpp -I.  -I ../include/  -I ../fp16/include/ -shared --target=wasm32-wasi-threads  -Wl,--no-entry -nostdlib -D_WASI_EMULATED_MMAN -march="$arch"
+          zip -r usearch_wasm_macos_"$arch"_${{ steps.version.outputs.version }}.zip libusearch.so
+          mv usearch_wasm_macos_"$arch"_${{ steps.version.outputs.version }}.zip ../ && rm -rf libusearch.so
+        done
+      if: matrix.os == 'macOS-11'
+
+    - name: Build library on Windows
+      run: |
+        export WASI_VERSION=20
+        export WASI_VERSION_FULL=${WASI_VERSION}.0
+        curl -LOJ https://github.com/WebAssembly/wasi-sdk/releases/download/wasi-sdk-${WASI_VERSION}/wasi-sdk-${WASI_VERSION_FULL}.m-mingw.tar.gz
+        tar xf wasi-sdk-${WASI_VERSION_FULL}.m-mingw.tar.gz
+        rm -rf wasi-sdk-${WASI_VERSION_FULL}.m-mingw.tar.gz
+        export WASI_SDK_PATH=/d/a/usearch/usearch/wasi-sdk-${WASI_VERSION_FULL}+m
+        archs=("x64" "x86")
+        cd ./c 
+        for arch in "${archs[@]}"
+        do
+          ../wasi-sdk-20.0+m/bin/clang++ --sysroot=${WASI_SDK_PATH}/share/wasi-sysroot -o libusearch.so -O3 lib.cpp -I.  -I ../include/  -I ../fp16/include/ -shared --target=wasm32-wasi-threads  -Wl,--no-entry -nostdlib -D_WASI_EMULATED_MMAN -march="$arch"
+          tar -cvf usearch_wasm_windows_"$arch"_${{ steps.version.outputs.version }}.tar.gz libusearch.so
+          mv usearch_wasm_windows_"$arch"_${{ steps.version.outputs.version }}.tar.gz ../ && rm -rf libusearch.so
+        done
+      shell: bash
+      if: matrix.os == 'windows-2022'
+
+    - name: Upload archive
+      uses: xresloader/upload-to-github-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        file: "*.zip;*.tar.gz"
+        update_latest_release: true
+        
+
+  publish_checksums:
+    name: Compute Assets Checksums
     runs-on: ubuntu-latest
-    needs: [versioning, create_linux_deb_package, create_windows_dll_library, create_macos_library, deploy_docs_pages]
+    needs: [versioning, create_linux_deb_package, create_windows_dll_library, create_macos_library, deploy_docs_pages, wasm_c_library]
     steps:
     - name: Get last release ID
       id: last_release
@@ -267,10 +352,16 @@ jobs:
             * ${{ 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 }}`
+            * ${{ steps.hashes.outputs.asset_name_10 }} : `${{ steps.hashes.outputs.asset_hash_10 }}`
+            * ${{ steps.hashes.outputs.asset_name_11 }} : `${{ steps.hashes.outputs.asset_hash_11 }}`
+            * ${{ steps.hashes.outputs.asset_name_12 }} : `${{ steps.hashes.outputs.asset_hash_12 }}`
+            * ${{ steps.hashes.outputs.asset_name_13 }} : `${{ steps.hashes.outputs.asset_hash_13 }}`
+            * ${{ steps.hashes.outputs.asset_name_14 }} : `${{ steps.hashes.outputs.asset_hash_14 }}`
+            * ${{ steps.hashes.outputs.asset_name_15 }} : `${{ steps.hashes.outputs.asset_hash_15 }}`
 
 
   build_wheels:
-    name: Build Wheels for ${{ matrix.os }}
+    name: Build Python
     needs: versioning
     runs-on: ${{ matrix.os }}
     strategy:
@@ -445,7 +536,7 @@ jobs:
         labels: ${{ steps.meta.outputs.labels }}
 
   build_csharp:
-    name: Build NuGet
+    name: Build C#
     needs: versioning
     strategy:
       matrix:

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: 2.3.2
+version: 2.4.1
 doi: 10.5281/zenodo.7949416
 date-released: 2022-06-12
 url: "https://github.com/unum-cloud/usearch"

package/CMakeLists.txt

@@ -15,6 +15,7 @@ option(USEARCH_BUILD_TEST "Compile a native unit test in C++" ${USEARCH_IS_MAIN_
 option(USEARCH_BUILD_BENCHMARK "Compile a native benchmark in C++" ${USEARCH_IS_MAIN_PROJECT})
 option(USEARCH_BUILD_WOLFRAM "Compile Wolfram Language bindings" OFF)
 option(USEARCH_BUILD_CLIB "Compile a native library for the C 99 interface" OFF)
+option(USEARCH_BUILD_CTEST "Compile a test for the C 99 interface" OFF)
 
 # Includes
 set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake ${CMAKE_MODULE_PATH})
@@ -128,7 +129,6 @@ if(USEARCH_INSTALL)
 endif()
 
 if(${USEARCH_BUILD_TEST} OR ${USEARCH_BUILD_BENCHMARK})
-    add_subdirectory(c)
     add_subdirectory(cpp)
 endif()
 
@@ -140,6 +140,6 @@ if(${USEARCH_BUILD_WASM})
     add_subdirectory(wasm)
 endif()
 
-if (${USEARCH_BUILD_CLIB})
+if (${USEARCH_BUILD_CLIB} OR ${USEARCH_BUILD_CTEST})
     add_subdirectory(c)
 endif()

package/Cargo.toml

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

package/README.md

@@ -99,7 +99,7 @@ index = Index(
 
 vector = np.array([0.2, 0.6, 0.4])
 index.add(42, vector)
-matches: Matches = index.search(vector, 10)
+matches = index.search(vector, 10)
 
 assert len(index) == 1
 assert len(matches) == 1
@@ -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 = {2.3.2},
+version = {2.4.1},
 year = {2022},
 month = jun,
 }

package/c/CMakeLists.txt

@@ -45,7 +45,7 @@ if (${USEARCH_LOOKUP_LABEL})
     target_compile_definitions(usearch_c PRIVATE USEARCH_LOOKUP_LABEL=1)
 endif()
 
-if(${USEARCH_BUILD_TEST})
+if(${USEARCH_BUILD_CTEST})
     add_executable(test_c "${CMAKE_CURRENT_SOURCE_DIR}/test.c")
     target_link_libraries(test_c usearch_c)
     set_target_properties(test_c PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR})

package/c/README.md

@@ -6,7 +6,7 @@ The simplest form to integrate is to copy the contents of `usearch/c/` into your
 To build the library `libusearch_c`, pass enable the `USEARCH_BUILD_CLIB` CMake option:
 
 ```bash
- cmake -DUSEARCH_BUILD_CLIB=1 -DUSEARCH_BUILD_STATIC=0 -DUSEARCH_BUILD_TEST=0 -DUSEARCH_BUILD_BENCHMARK=0 ..
+ cmake -DUSEARCH_BUILD_CLIB=1 -DUSEARCH_BUILD_CTEST=1 -DUSEARCH_BUILD_STATIC=0 -DUSEARCH_BUILD_TEST=0 -DUSEARCH_BUILD_BENCHMARK=0 ..
  ```
 
 You can choose between a static and dynamic library by setting `USEARCH_BUILD_STATIC`.

package/conanfile.py

@@ -1,19 +1,26 @@
 from conans import ConanFile
 
 
+required_conan_version = ">=1.53.0"
+
+
 class USearchConan(ConanFile):
 
-    name = 'USearch'
-    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'
+    name = "usearch"
+    version = '2.4.1'
+    license = "Apache-2.0"
+    description = "Smaller & Faster Single-File Vector Search Engine from Unum"
+    homepage = "https://github.com/unum-cloud/usearch"
+    topics = ("search", "vector", "simd")
+    settings = "os", "arch", "compiler", "build_type"
+    url = "https://github.com/conan-io/conan-center-index"
+    package_type = "header-library"
 
     # No settings/options are necessary, this is header only
     # Potentially add unit-tests in the future:
     # https://docs.conan.io/1/howtos/header_only.html#with-unit-tests
-    exports_sources = 'include/*'
+    exports_sources = "include/*"
     no_copy_source = True
 
     def package(self):
-        self.copy('*.h')
+        self.copy("*.h")

package/cpp/test.cpp

@@ -36,6 +36,13 @@ void test_cosine(index_at& index, std::vector<std::vector<scalar_at>> const& vec
     scalar_t const* vector_third = vectors[2].data();
     std::size_t dimensions = vectors[0].size();
 
+    // Try checking the empty state
+    if constexpr (punned_ak) {
+        expect(!index.contains(key_first));
+        expect(!index.get(key_first, (f32_t*)nullptr, 1));
+    }
+
+    // Add data
     index.reserve(10);
     index.add(key_first, vector_first, args...);
 

package/csharp/nuget/nuget-package.props

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