usearch 2.0.2 → 2.1.0

package/.github/workflows/Dockerfile.libs

@@ -0,0 +1,34 @@
+FROM ubuntu:22.04
+ENV DEBIAN_FRONTEND=noninteractive
+
+ENV user_name="runner"
+ARG TARGETPLATFORM
+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 clean && \
+    rm -rf /var/lib/apt/lists/*
+
+COPY . .
+
+RUN cd golang && make -C ../c libusearch_c.so && \
+    mv ../c/libusearch_c.so libusearch.a && cp ../c/usearch.h usearch.h && \
+    go test -v && cd ..
+
+RUN if [ "$TARGETPLATFORM" = "linux/amd64" ]; then \
+        export arch="amd"; \
+    elif [ "$TARGETPLATFORM" = "linux/arm64" ]; 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/

package/.github/workflows/release.yml

@@ -96,6 +96,62 @@ jobs:
             * 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"]
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        persist-credentials: false
+        ref: 'main'
+    - run: git submodule update --init --recursive
+
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v2
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v2
+
+    - 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
+      id: userpass
+      run: |
+        user_pass="1122"
+        echo "runner:$user_pass" | sudo chpasswd
+        echo "user_pass=$user_pass" >> "$GITHUB_OUTPUT"
+          
+    - name: Build Usearch lib
+      run: |
+        docker buildx create --use
+        docker buildx build \
+        --platform ${{ matrix.arch }} \
+        --build-arg docker_ip=${{ steps.dockerip.outputs.docker_ip }} \
+        --build-arg user_pass=${{ steps.userpass.outputs.user_pass }} \
+        --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
+      uses: xresloader/upload-to-github-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        file: "*.deb"
+        update_latest_release: true
+
+
   build_wheels:
     name: Build Wheels for ${{ matrix.os }}
     needs: versioning

package/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "usearch"
-version = "2.0.2"
+version = "2.1.0"
 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.0.2'
+    version = '2.1.0'
     license = 'Apache 2.0'
     url = 'https://github.com/unum-cloud/usearch'
     description = 'Smaller & Faster Single-File Vector Search Engine from Unum'

package/csharp/README.md

@@ -40,7 +40,7 @@ index.Save("index.usearch")
 using var indexLoaded = new USearchIndex("index.usearch");
 
 // Or view from disk without loading in memory
-// using var indexLoaded = new USearchIndex("index.usearch", view: True);
+// using var indexLoaded = new USearchIndex("index.usearch", view: true);
 
 Trace.Assert(indexLoaded.Size() == 1);
 Trace.Assert(indexLoaded.Dimensions() == 3);

package/golang/README.md

@@ -2,51 +2,72 @@
 
 ## Installation
 
-```golang
-import (
-	"github.com/unum-cloud/usearch/golang-go"
-)
+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
+dpkg -i usearch_<arch>_<usearch_version>.deb
 ```
 
 ## Quickstart
 
-```golang
-package main
+1. Create a `go.mod` file:
 
-import (
-	"fmt"
-	"github.com/unum-cloud/usearch/golang-go"
-)
+	```
+	module usearch_example
 
-func main() {
-	dim := uint(128)
-	conf := DefaultConfig(dim)
-	ind, err := NewIndex(conf)
-	if err != nil {
-		panic("Failed to construct the index: %s", err)
-	}
-	defer ind.Destroy()
+	go <go_version>
+	```
 
-	err = ind.Reserve(100)
-	if err != nil {
-		panic("Failed to reserve capacity: %s", err)
-	}
+2. Create an `example.go`:
 
-	vec := make([]float32, dim)
-	vec[0] = 40.0
-	vec[1] = 2.0
+	```golang
+	package main
 
-	err = ind.Add(42, vec)
-	if err != nil {
-		panic("Failed to insert: %s", err)
-	}
+	import (
+		"fmt"
+		usearch "github.com/unum-cloud/usearch/golang"
+	)
 
-	keys, distances, err := ind.Search(vec, 10)
-	if err != nil {
-		panic("Failed to search: %s", err)
-	}
-	if keys[0] != 42 || distances[0] != 0.0 {
-		panic("Expected result 42 with distance 0, got key %d with distance %f", keys[0], distances[0])
+	func main() {
+
+		// Create Index
+		vector_size := 3
+		vectors_count := 100
+		conf := usearch.DefaultConfig(uint(vector_size))
+		index,err := usearch.NewIndex(conf)
+		if err != nil {
+			panic("Failed to create Index")
+		}
+		defer index.Destroy()
+		
+		// Add to Index
+		err = index.Reserve(uint(vectors_count))
+		for i := 0; i < vectors_count; i++ {
+			err = index.Add(usearch.Key(i), []float32{float32(i), float32(i+1), float32(i+2)})
+			if err != nil {
+				panic("Failed to add")
+			}
+		}
+
+		// Search
+		keys, distances, err := index.Search([]float32{0.0, 1.0, 2.0}, 3)
+		if err != nil {
+			panic("Failed to search")
+		}
+		fmt.Println(keys, distances)
 	}
-}
-```
+	```
+
+3. Get USearch:
+
+	```
+	go get github.com/unum-cloud/usearch/golang
+	```
+
+4. Run:
+
+	```
+	go run example.go
+	```

package/golang/lib.go

@@ -6,9 +6,8 @@ import (
 )
 
 /*
-#cgo CFLAGS: -I${SRCDIR}/../c/
-#cgo LDFLAGS: -L${SRCDIR}/. -Wl,-rpath,\$ORIGIN/ -lusearch_c
-#include <usearch.h>
+#cgo LDFLAGS: -L. -lusearch
+#include "usearch.h"
 #include <stdlib.h>
 */
 import "C"
@@ -91,6 +90,8 @@ type IndexConfig struct {
 	ExpansionAdd uint
 	// The @b optional expansion factor used for index construction during search operations.
 	ExpansionSearch uint
+	// The @b optional multi flag.
+	Multi bool
 }
 
 func DefaultConfig(dimensions uint) IndexConfig {
@@ -101,6 +102,7 @@ func DefaultConfig(dimensions uint) IndexConfig {
 	c.Connectivity = 0
 	c.ExpansionAdd = 0
 	c.ExpansionSearch = 0
+	c.Multi = false
 	return c
 }
 
@@ -114,16 +116,18 @@ func NewIndex(conf IndexConfig) (index *Index, err error) {
 	index = &Index{config: conf}
 
 	conf = index.config
-	dimensions := C.ulong(conf.Dimensions)
-	connectivity := C.ulong(conf.Connectivity)
-	expansion_add := C.ulong(conf.ExpansionAdd)
-	expansion_search := C.ulong(conf.ExpansionSearch)
+	dimensions := C.size_t(conf.Dimensions)
+	connectivity := C.size_t(conf.Connectivity)
+	expansion_add := C.size_t(conf.ExpansionAdd)
+	expansion_search := C.size_t(conf.ExpansionSearch)
+	multi := C.bool(conf.Multi)
 
 	options := C.struct_usearch_init_options_t{}
 	options.dimensions = dimensions
 	options.connectivity = connectivity
 	options.expansion_add = expansion_add
 	options.expansion_search = expansion_search
+	options.multi = multi
 
 	// Map the metric kind to a C enum
 	switch conf.Metric {
@@ -281,21 +285,21 @@ func (index *Index) Contains(key Key) (found bool, err error) {
 	return found, nil
 }
 
-func (index *Index) Get(key Key) (vector []float32, err error) {
+func (index *Index) Get(key Key, count uint) (vectors []float32, err error) {
 	if index.opaque_handle == nil {
 		panic("Index is uninitialized")
 	}
 
-	vector = make([]float32, index.config.Dimensions)
+	vectors = make([]float32, index.config.Dimensions * count)
 	var errorMessage *C.char
-	found := bool(C.usearch_get((C.usearch_index_t)(unsafe.Pointer(index.opaque_handle)), (C.usearch_key_t)(key), unsafe.Pointer(&vector[0]), C.usearch_scalar_f32_k, (*C.usearch_error_t)(&errorMessage)))
+	found := uint(C.usearch_get((C.usearch_index_t)(unsafe.Pointer(index.opaque_handle)), (C.usearch_key_t)(key), (C.size_t)(count), unsafe.Pointer(&vectors[0]), C.usearch_scalar_f32_k, (*C.usearch_error_t)(&errorMessage)))
 	if errorMessage != nil {
 		return nil, errors.New(C.GoString(errorMessage))
 	}
-	if !found {
+	if found == 0 {
 		return nil, nil
 	}
-	return vector, nil
+	return vectors, nil
 }
 
 // Performs k-Approximate Nearest Neighbors Search for closest vectors to query.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "usearch",
-    "version": "2.0.2",
+    "version": "2.1.0",
     "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.0.2"
+version="2.1.0"
 description="Smaller & Faster Single-File Vector Search Engine from Unum"
 license="Apache-2.0"
 readme="README.md"