usearch 2.1.0 → 2.1.1

package/.github/workflows/Dockerfile.libs

@@ -7,7 +7,7 @@ ARG docker_ip
 ARG user_pass
 
 RUN apt-get update && \
-    apt-get install -y --no-install-recommends python3.11 python3-pip cmake g++-12 build-essential libjemalloc-dev golang openssh-client sshpass && \
+    apt-get install -y --no-install-recommends cmake g++-12 build-essential libjemalloc-dev golang openssh-client sshpass && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/*
 
@@ -23,12 +23,12 @@ RUN if [ "$TARGETPLATFORM" = "linux/amd64" ]; then \
         export arch="arm"; \
     fi && \
     version=$(cat VERSION) && \
-    mkdir -p usearch_"$arch"_"$version"/DEBIAN && \
-    touch usearch_"$arch"_"$version"/DEBIAN/control && \
-    mkdir -p usearch_"$arch"_"$version"/usr/local/lib && \
-    mkdir usearch_"$arch"_"$version"/usr/local/include && \
-    cp c/usearch.h usearch_"$arch"_"$version"/usr/local/include/ && \
-    cp golang/libusearch.a usearch_"$arch"_"$version"/usr/local/lib/ && \
-    echo "Package: usearch\nVersion: $version\nMaintainer: Ashot Vardanian\nArchitecture: "$arch"\nDescription: Faster & Smaller Single-File Search Engine for Vectors & Texts" > usearch_"$arch"_"$version"/DEBIAN/control && \
-    dpkg-deb --build usearch_"$arch"_"$version" && \
-    sshpass -p "$user_pass" scp -o StrictHostKeyChecking=no usearch_"$arch"_"$version".deb "$user_name"@"$docker_ip":/home/$user_name/work/usearch/usearch/
+    mkdir -p usearch_linux_"$arch"_"$version"/DEBIAN && \
+    touch usearch_linux_"$arch"_"$version"/DEBIAN/control && \
+    mkdir -p usearch_linux_"$arch"_"$version"/usr/local/lib && \
+    mkdir usearch_linux_"$arch"_"$version"/usr/local/include && \
+    cp c/usearch.h usearch_linux_"$arch"_"$version"/usr/local/include/ && \
+    cp golang/libusearch.a usearch_linux_"$arch"_"$version"/usr/local/lib/ && \
+    echo "Package: usearch\nVersion: $version\nMaintainer: Ashot Vardanian\nArchitecture: "$arch"\nDescription: Faster & Smaller Single-File Search Engine for Vectors & Texts" > usearch_linux_"$arch"_"$version"/DEBIAN/control && \
+    dpkg-deb --build usearch_linux_"$arch"_"$version" && \
+    sshpass -p "$user_pass" scp -o StrictHostKeyChecking=no usearch_linux_"$arch"_"$version".deb "$user_name"@"$docker_ip":/home/$user_name/work/usearch/usearch/

package/.github/workflows/prerelease.yml

@@ -219,6 +219,33 @@ jobs:
         shell: bash
         working-directory: ${{ github.workspace }}/csharp/
 
+  test_golang:
+    name: Test Golang
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        persist-credentials: false
+        ref: 'main-dev'
+    - run: git submodule update --init --recursive
+
+    - name: Prepare environment
+      run: |
+        sudo apt update && 
+        sudo apt install -y cmake g++-12 build-essential libjemalloc-dev
+          
+    - name: Build library
+      run: |
+        cd golang && make -C ../c libusearch_c.so
+        sudo mv ../c/libusearch_c.so /usr/local/lib/libusearch.a
+        sudo mv ../c/usearch.h /usr/local/include/usearch.h
+
+    - name: Run test
+      run: |
+        cd golang
+        go test -v
+        
+
   build_docker:
     name: Test Docker Image
     runs-on: ubuntu-latest

package/.github/workflows/release.yml

@@ -14,6 +14,7 @@ permissions:
   contents: write
   pages: write
   id-token: write
+  packages: write
 
 jobs:
 
@@ -52,54 +53,10 @@ jobs:
           force: True
 
 
-  publish_hashes:
-    name: Add hashes to release notes
+  create_linux_deb_package:
+    name: Create Debian Package for ${{ matrix.arch }}
     runs-on: ubuntu-latest
     needs: versioning
-    steps:
-    - name: Get last release ID
-      id: last_release
-      run: |
-          response=$(curl -s -H "Authorization: Bearer ${{ secrets.SEMANTIC_RELEASE_TOKEN }}" \
-            "https://api.github.com/repos/${{ github.repository }}/releases/latest")
-          echo "last_release_id=$(echo "$response" | jq -r '.id')" >> $GITHUB_OUTPUT
-
-    - uses: robinraju/release-downloader@v1.8
-      name: Download release assets
-      with:
-        latest: true
-        fileName: "*"
-        out-file-path: "downloads"
-        tarBall: true
-        zipBall: true
-
-    - name: Calculate source hashes
-      id: hashes
-      run: |
-        source_zip_path=$(find $GITHUB_WORKSPACE/downloads -name "*.zip")
-        zip_hash=$(sha256sum "$source_zip_path" | awk '{print $1}')
-        source_tar_path=$(find $GITHUB_WORKSPACE/downloads -name "*.tar.gz" ! -name "docs.tar.gz")
-        tar_hash=$(sha256sum "$source_tar_path" | awk '{print $1}')
-        echo "zip_hash=$zip_hash" >> $GITHUB_OUTPUT
-        echo "tar_hash=$tar_hash" >> $GITHUB_OUTPUT
-          
-    - name: Upload hashes to release
-      uses: irongut/EditRelease@v1.2.0
-      with:
-        token: ${{ secrets.SEMANTIC_RELEASE_TOKEN }}
-        id: ${{ steps.last_release.outputs.last_release_id }}
-        prerelease: false
-        replacebody: false
-        body: |
-            ## Hashes
-            * Source code (zip) : `${{ steps.hashes.outputs.zip_hash }}` 
-            * Source code (tar.gz) : `${{ steps.hashes.outputs.tar_hash }}`
-
-
-  create_deb_packages_linux:
-    name: Create deb package for Linux on ${{ matrix.arch }}
-    needs: versioning
-    runs-on: ubuntu-latest
     strategy:
       matrix:
         arch: ["linux/amd64", "linux/arm64"]
@@ -110,26 +67,26 @@ jobs:
         ref: 'main'
     - run: git submodule update --init --recursive
 
-    - name: Set up QEMU
+    - name: Setup QEMU
       uses: docker/setup-qemu-action@v2
 
-    - name: Set up Docker Buildx
+    - name: Setup Docker
       uses: docker/setup-buildx-action@v2
 
-    - name: Get docker daemon IP
+    - name: Get Docker daemon IP
       id: dockerip
       run: |
         docker_ip=$(ip addr show docker0 | grep -Po 'inet \K[\d.]+') && \
         echo "docker_ip=$docker_ip" >> "$GITHUB_OUTPUT"
-
-    - name: Set new password for runner user
+        
+    - name: Set runner user password
       id: userpass
       run: |
         user_pass="1122"
         echo "runner:$user_pass" | sudo chpasswd
         echo "user_pass=$user_pass" >> "$GITHUB_OUTPUT"
           
-    - name: Build Usearch lib
+    - name: Build library
       run: |
         docker buildx create --use
         docker buildx build \
@@ -139,11 +96,10 @@ jobs:
         --file .github/workflows/Dockerfile.libs \
         --tag unum/ustore-deps:latest \
         --load .
-
     - name: Clear Docker buildx cache
       run: docker buildx prune --all --force
 
-    - name: Upload archive to release Assets
+    - name: Upload archive
       uses: xresloader/upload-to-github-release@v1
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -152,6 +108,157 @@ jobs:
         update_latest_release: true
 
 
+  create_windows_dll_library:
+    name: Create Dll Library for Windows ${{ matrix.arch }}
+    runs-on: windows-latest
+    needs: versioning
+    strategy:
+      matrix:
+        arch: [x64, x86]
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        persist-credentials: false
+        ref: 'main'
+    - run: git submodule update --init --recursive
+    
+    - name: Setup Cmake
+      uses: jwlawson/actions-setup-cmake@v1.13
+    
+    - uses: actions/setup-go@v4
+      with:
+        go-version: '^1.19.0'
+
+    - name: Setup Mingw
+      uses: egor-tensin/setup-mingw@v2
+      with:
+        platform: ${{ matrix.arch }}
+
+    - name: Get version
+      id: set_version
+      shell: bash
+      run: |
+        version=$(cat VERSION)
+        echo "version=$version" >> $GITHUB_OUTPUT
+        
+    - name: Build library
+      run: |
+        cd c/ && g++ -std=c++11 -o libusearch.dll -O3 lib.cpp -I.  -I ../include/  -I ../fp16/include/ -shared && cd ..
+        cp c/libusearch.dll golang/libusearch.dll && cp c/usearch.h golang/usearch.h
+    
+    - name: Golang test
+      run: |
+        cd golang/ && go test -v
+      if: ${{ matrix.arch == 'x64' }}
+
+    - name: Compress library
+      run: |
+        cd golang/
+        tar -cvf usearch_windows_${{ matrix.arch }}_${{ steps.set_version.outputs.version }}.tar .\libusearch.dll .\usearch.h
+
+    - name: Upload archive
+      uses: xresloader/upload-to-github-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        file: "golang/usearch_windows_${{ matrix.arch }}_${{ steps.set_version.outputs.version }}.tar"
+        update_latest_release: true
+
+
+  create_macos_library:
+    name: Create Library for MacOS ${{ matrix.arch }}
+    runs-on: macOS-latest
+    needs: versioning
+    strategy:
+      matrix:
+        arch: [arm64, x86_64]
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        persist-credentials: false
+        ref: 'main'
+    - run: git submodule update --init --recursive
+    
+    - uses: actions/setup-go@v4
+      with:
+        go-version: '^1.21.0'
+
+    - name: Get version
+      id: version
+      run: |
+        version=$(cat VERSION)
+        echo "version=$version" >> $GITHUB_OUTPUT
+
+    - name: Build library
+      run: |
+        cd c/ && clang++ -std=c++11 -o libusearch.so -O3 lib.cpp -I.  -I ../include/  -I ../fp16/include/ -shared -target ${{ matrix.arch }}-apple-macos11 && cd ..
+        cp c/usearch.h golang/
+        cp c/libusearch.so golang/libusearch.so
+
+    - name: Golang test
+      run: |
+        cd golang/
+        go test -v
+      if: ${{ matrix.arch == 'x86_64' }}
+
+    - name: Compress library
+      run: |
+        cd golang/
+        zip -r usearch_macOS_${{ matrix.arch }}_${{ steps.version.outputs.version }}.zip libusearch.so usearch.h 
+
+    - name: Upload archive
+      uses: xresloader/upload-to-github-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        file: "golang/*.zip"
+        update_latest_release: true
+
+
+  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]
+    steps:
+    - name: Get last release ID
+      id: last_release
+      run: |
+          response=$(curl -s -H "Authorization: Bearer ${{ secrets.SEMANTIC_RELEASE_TOKEN }}" \
+            "https://api.github.com/repos/${{ github.repository }}/releases/latest")
+          echo "last_release_id=$(echo "$response" | jq -r '.id')" >> $GITHUB_OUTPUT
+
+    - uses: robinraju/release-downloader@v1.8
+      name: Download release assets
+      with:
+        latest: true
+        fileName: "*"
+        out-file-path: "downloads"
+        tarBall: true
+        zipBall: true
+
+    - name: Calculate source hashes
+      id: hashes
+      run: |
+        source_zip_path=$(find $GITHUB_WORKSPACE/downloads -name "*.zip")
+        zip_hash=$(sha256sum "$source_zip_path" | awk '{print $1}')
+        source_tar_path=$(find $GITHUB_WORKSPACE/downloads -name "*.tar.gz" ! -name "docs.tar.gz")
+        tar_hash=$(sha256sum "$source_tar_path" | awk '{print $1}')
+        echo "zip_hash=$zip_hash" >> $GITHUB_OUTPUT
+        echo "tar_hash=$tar_hash" >> $GITHUB_OUTPUT
+          
+    - name: Upload hashes to release
+      uses: irongut/EditRelease@v1.2.0
+      with:
+        token: ${{ secrets.SEMANTIC_RELEASE_TOKEN }}
+        id: ${{ steps.last_release.outputs.last_release_id }}
+        prerelease: false
+        replacebody: false
+        body: |
+            ## Hashes
+            * Source code (zip) : `${{ steps.hashes.outputs.zip_hash }}` 
+            * Source code (tar.gz) : `${{ steps.hashes.outputs.tar_hash }}`
+
+
   build_wheels:
     name: Build Wheels for ${{ matrix.os }}
     needs: versioning
@@ -375,11 +482,12 @@ jobs:
     runs-on: ubuntu-latest
     needs: [build_csharp]
     env:
+      SOLUTION: ${{ github.workspace }}/csharp
       USEARCH_LIBS: ${{ github.workspace }}/csharp/lib
-      NUGET_DIR: ${{ github.workspace }}/csharp/packages
+      NUGET_PACKAGES: ${{ github.workspace }}/csharp/packages
       # NUGET_SOURCE: https://apiint.nugettest.org/v3/index.json
       NUGET_SOURCE: https://api.nuget.org/v3/index.json
-      SOLUTION_DIR: ${{ github.workspace }}/csharp
+      GITHUB_PACKAGES_SOURCE: https://nuget.pkg.github.com/${{ github.repository_owner }}/index.json
     steps:
       - uses: actions/checkout@v3
       - run: git submodule update --init --recursive
@@ -398,12 +506,17 @@ jobs:
       - name: Pack project
         run: |
           VERSION_CONTENT=$(< VERSION)
-          dotnet pack "${{ env.SOLUTION_DIR }}" -c Release -p:Version="$VERSION_CONTENT" --output ${{ env.NUGET_DIR }}
+          dotnet pack "${{ env.SOLUTION }}" -c Release -p:Version="$VERSION_CONTENT" --output ${{ env.NUGET_PACKAGES }}
         working-directory: ${{ github.workspace }}
 
-      - name: Publish NuGet packages
-        run: |
-          dotnet nuget push "${{  env.NUGET_DIR }}/*.nupkg" --api-key "${{ secrets.NUGET_API }}" --source "${{ env.NUGET_SOURCE }}"
+      - name: Publish to NuGet
+        run: dotnet nuget push "${{ env.NUGET_PACKAGES }}/*.nupkg" --api-key "${{ secrets.NUGET_API }}" --source "${{ env.NUGET_SOURCE }}" --skip-duplicate
+
+      - name: Prepare publish to GitHub Registry
+        run: dotnet nuget add source --username ${{ github.repository_owner }} --password ${{ secrets.GITHUB_TOKEN }} --store-password-in-clear-text --name github "${{ env.GITHUB_PACKAGES_SOURCE }}"
+
+      - name: Publish to GitHub Registry
+        run: dotnet nuget push "${{ env.NUGET_PACKAGES }}/*.nupkg"  --api-key "${{ secrets.GITHUB_TOKEN }}" --source "github" --skip-duplicate
 
   build_docs:
     name: Build Docs

package/Cargo.toml

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

package/conanfile.py

@@ -4,7 +4,7 @@ from conans import ConanFile
 class USearchConan(ConanFile):
 
     name = 'USearch'
-    version = '2.1.0'
+    version = '2.1.1'
     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

@@ -15,14 +15,14 @@
 
     <PackageIcon>unum.png</PackageIcon>
     <PackageIconUrl>unum.png</PackageIconUrl>
-    <PackageReadmeFile>NUGET.md</PackageReadmeFile>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>
     <None Include="$(NativeLibDir)runtimes\**\*.*" Pack="true" PackagePath="runtimes" />
     <None Include="$(RepoRoot)LICENSE" Pack="true" PackagePath=""/>
     <None Include="$(RepoRoot)assets\unum.png" Pack="true" PackagePath=""/>
-    <None Include="$(CSharpDir)nuget\NUGET.md" Pack="true" PackagePath=""/>
+    <None Include="$(RepoRoot)README.md" Pack="true" PackagePath=""/>
   </ItemGroup>
 
   <!-- Package validation https://learn.microsoft.com/en-us/dotnet/fundamentals/package-validation/overview?WT.mc_id=DT-MVP-5003978 -->

package/golang/README.md

@@ -2,14 +2,36 @@
 
 ## Installation
 
+### Linux
+
 Download and install from the Debian package from the latest release.
 Substitute `<release_tag>`, `<arch>`, and `<usearch_version>` with your settings.
 
 ```
-wget https://github.com/unum-cloud/usearch/releases/download/<release_tag>/usearch_<arch>_<usearch_version>.deb
+wget https://github.com/unum-cloud/usearch/releases/download/<release_tag>/usearch_linux_<arch>_<usearch_version>.deb
 dpkg -i usearch_<arch>_<usearch_version>.deb
 ```
 
+### Windows
+
+Run a `winlibinstaller.bat` script from the main repository in the folder where you will run `go run`.
+That will install the USearch library and include in the same folder` where the script was run.
+
+```
+.\usearch\winlibinstaller.bat
+```
+
+### MacOS
+
+Download and unpack a zip archive from the latest release.
+Move the USearch library and the include file to their respective folders.
+```
+wget https://github.com/unum-cloud/usearch/releases/download/<release_tag>/usearch_macOS_<arch>_<usearch_version>.zip
+unzip usearch_macOS_<arch>_<usearch_version>.zip
+sudo mv libusearch.so /usr/local/lib && sudo mv usearch.h /usr/local/include
+
+```
+
 ## Quickstart
 
 1. Create a `go.mod` file:

package/package.json

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

package/wasmer.toml

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

package/winlibinstaller.bat

@@ -0,0 +1,42 @@
+@echo off
+
+rem Get latest release tag
+set "repo_owner=unum-cloud"
+set "repo_name=usearch"
+
+rem Get the latest tag without quotes
+for /f "delims=" %%i in ('curl -s https://api.github.com/repos/%repo_owner%/%repo_name%/releases/latest ^| findstr "tag_name"') do (
+    for /f "tokens=2 delims=:, " %%a in ("%%i") do (
+        set "latest_tag=%%~a"
+    )
+)
+
+rem Get Windows architecture
+for /f "tokens=2 delims= " %%a in ('wmic OS get OSArchitecture ^| find "64"') do set "arch=x64"
+if "%arch%"=="" set "arch=x86"
+
+echo Split library version from release version!
+timeout /t 1
+rem Split the first 'v' from the version number.
+for /f "tokens=1 delims=v" %%a in ('echo %latest_tag%') do (
+    set lib_version=%%a
+)
+
+echo Download usearch library archive!
+rem Download the file.
+timeout /t 2
+curl -LO https://github.com/%repo_owner%/%repo_name%/releases/download/%latest_tag%/usearch_windows_%arch%_%lib_version%.tar
+echo Download is complete!
+
+echo Extract archive!
+rem Extract archive.
+timeout /t 1
+tar -xf usearch_windows_%arch%_%lib_version%.tar
+echo Extract is complete!
+
+rem Remove the archive.
+del usearch_windows_%arch%_%lib_version%.tar
+
+echo Extraction complete and downloaded .tar file removed.
+timeout /t 1
+exit /b

package/csharp/nuget/NUGET.md

@@ -1,11 +0,0 @@
-**Cloud.Unum.USearch** is a wrapper for the USearch vector search engine, offering fast searches, multiple metrics, and features like SIMD-optimized metrics.
-
-**Supported metrics**: Euclidean, Angular, Jaccard, Hamming, Haversine, User-Defined Metrics
-
-**Platforms**: Linux, MacOS, Windows
-
-# Getting Started ⚡
-
-- [Quickstart](https://github.com/unum-cloud/usearch/blob/main/csharp/README.md)
-- Join the [Discord community](https://discord.gg/A6wxt6dS9j)
-- Check out the [GitHub repository](https://github.com/unum-cloud/usearch)