usearch 2.8.7 → 2.8.9

package/docs/conf.py

@@ -1,53 +0,0 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# For the full list of built-in configuration values, see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-
-project = "Unum · USearch"
-copyright = "2023, Unum"
-author = "Unum"
-release = open("../VERSION", "r").read().strip()
-with open("_static/custom.js", "r+") as js:
-    content = js.read()
-    js.seek(0)
-    js.truncate()
-    js.write(content.replace("$(VERSION)", release))
-
-# -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-
-extensions = [
-    "breathe",
-    "m2r2",
-    "sphinx.ext.autodoc",
-    "sphinx_js",
-    "sphinx.ext.autosummary",
-    "sphinx.ext.intersphinx",
-    "sphinx.ext.napoleon",
-    "sphinxcontrib.jquery",
-    "sphinxcontrib.googleanalytics",
-]
-
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "*.md"]
-
-
-googleanalytics_id = "341385789"
-googleanalytics_enabled = True
-
-# -- Options for HTML output -------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-
-html_logo = "../assets/unum.png"
-html_theme = "furo"
-html_static_path = ["_static"]
-html_css_files = ["custom.css"]
-html_js_files = ["custom.js"]
-html_baseurl = "/docs/usearch/"
-
-breathe_projects = {"USearch": "../build/xml"}
-breathe_default_project = "USearch"
-
-js_source_path = "../javascript/usearch.js"

package/docs/contributing.rst

@@ -1,5 +0,0 @@
-========================
-Contributing
-========================
-
-.. mdinclude:: ../CONTRIBUTING.md

package/docs/cpp/index.rst

@@ -1,11 +0,0 @@
-=====================
-C++ SDK
-=====================
-
-
-.. mdinclude:: ../../cpp/README.md
-
-.. toctree::
-   :hidden:
-
-   reference

package/docs/cpp/reference.rst

@@ -1,17 +0,0 @@
-API Reference
-===============
-
-=================================
-usearch/index.hpp
-=================================
-.. doxygenfile:: index.hpp
-
-=================================
-usearch/index_plugins.hpp
-=================================
-.. doxygenfile:: index_plugins.hpp
-
-=================================
-usearch/index_dense.hpp
-=================================
-.. doxygenfile:: index_dense.hpp

package/docs/csharp/index.rst

@@ -1,6 +0,0 @@
-==============
-C# SDK
-==============
-
-
-.. mdinclude:: ../../csharp/README.md

package/docs/format.md

@@ -1,86 +0,0 @@
-# USearch File Format Specification
-
-> ⚠️ __Important Note__: The file format is slated for updates in the upcoming 3.0 release. These changes aim to support sparse indexes and enhance startup performance when loading large indexes from disk using the `view` command.
-
-## Upcoming Version: v3
-
-The v3 file format is designed for compatibility with Apache Arrow arrays and consists of an array of variable-length binary strings. The structure for a file with `N` entries is as follows:
-
-### File Structure
-
-1. __File Header__: Metadata and other essential information.
-2. __Offset Array__: An array of `N+1` eight-byte unsigned integers (`uint64_t`).
-    - The entry at index `0 <= i < N` indicates the byte-level offset of the `i-th` vector in the file.
-    - The entry at index `N` specifies the total length of the binary file.
-3. __Data Chunks__: `N` binary data chunks, each starting with the vector itself, followed by index system data.
-
-### Data Retrieval
-
-To retrieve the Binary Large Object (BLOB) corresponding to a specific vector, subtract the consecutive offsets indicated in the Offset Array.
-
-### Advantages of the v3 Format
-
-The v3 format offers several benefits, making it more future-proof:
-
-- __Flexibility__: Easily accommodates variable-length strings.
-- __Performance__: Co-locates vectors with proximity graph entries for optimized data access.
-- __Compatibility__: Simplifies memory-mapping and casting to an Apache Arrow array of vectors or strings.
-- __Extensibility__: Enables external storage systems to reuse the underlying `index_gt` more extensively, particularly in database systems.
-
----
-
-## Current: v2
-
-### Dense Indexes
-
-Dense index files consist of two main parts: [a binary matrix of all vectors](#matrix-blob) and the [index](#index-blob) itself.
-
-#### Matrix BLOB
-
-The matrix BLOB is optionally prepended to the index file. It starts with the number of `rows` and `columns`, which can be either 32-bit or 64-bit unsigned integers.
-
-- The number of `rows` corresponds to the number of vectors in the index.
-- The number of `columns` corresponds to the number of bytes in a single vector.
-
-#### Index BLOB
-
-The index BLOB is composed of three main sections:
-
-1. __Metadata__: Occupies 64 bytes and contains the following fields:
-    1. 7-byte magic string `usearch` to infer the MIME type of the file.
-    2. 3-byte version number, containing the `major`, `minor`, and `patch` release numbers.
-    3. 1-byte enums for `metric`, `scalar`, `key`, and `compressed_slot` types.
-    4. 8-byte integers for the number of present vectors, number of deleted vectors, and number of dimensions.
-    5. 1-byte flags for multi-vector support.
-
-2. __Levels__: Contains 1-byte integers representing the level each node occupies. This information is used to estimate memory requirements and to enable memory-mapping of the entire file.
-
-3. __Core__: Detailed in the [Core section](#core). This format is consistent across all types of indexes.
-
-### Fragmented Storage
-
-The matrix BLOB can be stored separately and is not required to successfully open the file.
-
-### Core
-
-The core section of the index is serialized as a sequence of nodes, each representing a point in the index. This section immediately follows the `levels` block in the serialized format.
-
-#### Header
-
-The core section begins with a header containing the following fields:
-
-- `uint64_t size`: Number of nodes in the index.
-- `uint64_t connectivity`: Maximum number of edges for a node.
-- `uint64_t connectivity_base`: Base connectivity value.
-- `uint64_t max_level`: Maximum level in the multi-level graph.
-- `uint64_t entry_slot`: Entry slot for the graph.
-
-These fields are serialized in a contiguous block of bytes, in the order listed.
-
-#### Levels
-
-Following the header, the `levels` block contains a sequence of 1-byte integers. Each integer represents the level of a node in the index. The number of levels is equal to the `size` field in the header.
-
-#### Nodes
-
-After the `levels` block, the nodes are serialized. Each node is represented as a contiguous block of bytes. The size and format of these blocks are implementation-specific. Nodes are serialized in the same order as their corresponding levels in the `levels` block.

package/docs/format.rst

@@ -1,5 +0,0 @@
-========================
-Format
-========================
-
-.. mdinclude:: format.md

package/docs/golang/index.rst

@@ -1,6 +0,0 @@
-==============
-GoLang SDK
-==============
-
-
-.. mdinclude:: ../../golang/README.md

package/docs/index.rst

@@ -1,33 +0,0 @@
-==========
-Overview
-==========
-.. mdinclude:: ../README.md
-
-.. toctree:: 
-   :hidden:
-   :caption: �
-
-   cpp/index
-   python/index
-   rust/index
-   javascript/index
-   java/index
-   c/index
-   swift/index
-   csharp/index
-   golang/index
-   wolfram/index
-
-.. toctree:: 
-   :hidden:
-   :caption: �
-
-   contributing
-   benchmarks
-   format
-
-.. toctree:: 
-   :hidden:
-   :caption: �
-
-   genindex

package/docs/java/index.rst

@@ -1,11 +0,0 @@
-================
-Java SDK
-================
-
-
-.. mdinclude:: ../../java/README.md
-
-.. toctree::
-   :hidden:
-
-   reference

package/docs/java/reference.rst

@@ -1,7 +0,0 @@
-API Reference
-===============
-
-===============
-Index.java
-===============
-.. doxygenfile:: Index.java

package/docs/javascript/index.rst

@@ -1,11 +0,0 @@
-==============
-JavaScript SDK
-==============
-
-
-.. mdinclude:: ../../javascript/README.md
-
-.. toctree::
-   :hidden:
-
-   reference

package/docs/javascript/reference.rst

@@ -1,12 +0,0 @@
-API Reference
-===============
-
-==================
-usearch.Index
-==================
-
-.. js:autoclass:: Index
-   :members:
-
-.. js:autoclass:: Matches
-   :members:

package/docs/python/index.rst

@@ -1,11 +0,0 @@
-==============
-Python SDK
-==============
-
-
-.. mdinclude:: ../../python/README.md
-
-.. toctree::
-   :hidden:
-
-   reference

package/docs/python/reference.rst

@@ -1,42 +0,0 @@
-API Reference
-===============
-
-======
-Index
-======
-
-.. automodule:: usearch.index
-    :members:
-    :undoc-members:
-
-======
-IO
-======
-
-.. automodule:: usearch.io
-    :members:
-    :undoc-members:
-
-==========
-Evaluation
-==========
-
-.. automodule:: usearch.eval
-    :members:
-    :undoc-members:
-
-======
-Client
-======
-
-.. automodule:: usearch.client
-    :members:
-    :undoc-members:
-
-======
-Server
-======
-
-.. automodule:: usearch.server
-    :members:
-    :undoc-members:

package/docs/rust/index.rst

@@ -1,6 +0,0 @@
-==============
-Rust SDK
-==============
-
-
-.. mdinclude:: ../../rust/README.md

package/docs/swift/index.rst

@@ -1,6 +0,0 @@
-==============
-Swift SDK
-==============
-
-
-.. mdinclude:: ../../swift/README.md

package/docs/wolfram/index.rst

@@ -1,6 +0,0 @@
-=====================
-Wolfram SDK
-=====================
-
-
-.. mdinclude:: ../../wolfram/README.md

package/golang/README.md

@@ -1,95 +0,0 @@
-# USearch for GoLang
-
-## Installation
-
-### Linux
-
-Download and install from the Debian package from the latest release.
-Substitute `<release_tag>`, `<arch>`, and `<usearch_version>` with your settings.
-
-```sh
-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.
-
-```sh
-.\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.
-
-```sh
-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_c.so /usr/local/lib && sudo mv usearch.h /usr/local/include
-```
-
-## Quickstart
-
-1. Create a `go.mod` file:
-
-```
-module usearch_example
-
-go <go_version>
-```
-
-2. Create an `example.go`:
-
-```golang
-package main
-
-import (
-"fmt"
-usearch "github.com/unum-cloud/usearch/golang"
-)
-
-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:
-
-```sh
-go get github.com/unum-cloud/usearch/golang
-```
-
-4. Run:
-
-```sh
-go run example.go
-```

package/golang/go.mod

@@ -1,3 +0,0 @@
-module github.com/unum-cloud/usearch/golang
-
-go 1.19