hyperstreamdb 0.1.8__tar.gz → 0.1.11__tar.gz

{hyperstreamdb-0.1.8 → hyperstreamdb-0.1.11}/.gitignore

@@ -103,3 +103,4 @@ groq_api_key.txt
 rag_db/
 news_db/
 
+.hypothesis/

{hyperstreamdb-0.1.8 → hyperstreamdb-0.1.11}/Cargo.lock

@@ -3755,7 +3755,7 @@ dependencies = [
 
 [[package]]
 name = "hyperstreamdb"
-version = "0.1.8"
+version = "0.1.11"
 dependencies = [
  "ahash 0.8.12",
  "anyhow",
@@ -3782,6 +3782,8 @@ dependencies = [
  "cust",
  "datafusion",
  "datafusion-expr-common",
+ "datafusion-functions",
+ "datafusion-functions-aggregate",
  "datafusion-functions-aggregate-common",
  "dirs",
  "env_logger",

{hyperstreamdb-0.1.8 → hyperstreamdb-0.1.11}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "hyperstreamdb"
-version = "0.1.8"
+version = "0.1.11"
 edition = "2021"
 license = "MIT AND Apache-2.0"
 description = "HyperStreamDB - Serverless Index-Streaming Database with Overlay Indexing and Vector Search"
@@ -114,6 +114,8 @@ once_cell = "1.19"
 async-trait = "0.1.89"
 datafusion = "52.0.0"
 datafusion-expr-common = "52.0.0"
+datafusion-functions = "52.0.0"
+datafusion-functions-aggregate = "52.0.0"
 datafusion-functions-aggregate-common = "52.0.0"
 async-stream = "0.3.6"
 smartcore = "0.3"  # For k-means clustering (IVF index)
@@ -158,7 +160,7 @@ features = ["invocation"]
 [dependencies.pyo3]
 version = "0.26.0"
 optional = true
-features = ["extension-module"]
+features = ["extension-module", "abi3-py310"]
 
 [dependencies.numpy]
 version = "0.26.0"

{hyperstreamdb-0.1.8 → hyperstreamdb-0.1.11}/PKG-INFO

@@ -1,15 +1,15 @@
 Metadata-Version: 2.4
 Name: hyperstreamdb
-Version: 0.1.8
+Version: 0.1.11
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Topic :: Database
@@ -19,7 +19,7 @@ Requires-Dist: numpy>=1.20.0
 Requires-Dist: mps ; extra == 'all-gpu'
 Requires-Dist: cuda ; extra == 'all-gpu'
 Requires-Dist: rocm ; extra == 'all-gpu'
-Requires-Dist: intel-gpu ; extra == 'all-gpu'
+Requires-Dist: intel ; extra == 'all-gpu'
 Requires-Dist: pytest>=7.0 ; extra == 'dev'
 Requires-Dist: pytest-asyncio>=0.21 ; extra == 'dev'
 Requires-Dist: maturin>=1.7 ; extra == 'dev'
@@ -27,8 +27,7 @@ Requires-Dist: maturin>=1.7 ; extra == 'src'
 Provides-Extra: all_gpu
 Provides-Extra: cuda
 Provides-Extra: dev
-Provides-Extra: intel_cpu
-Provides-Extra: intel_gpu
+Provides-Extra: intel
 Provides-Extra: mps
 Provides-Extra: rocm
 Provides-Extra: src
@@ -39,7 +38,7 @@ Keywords: database,vector,search,indexing,parquet,iceberg
 Home-Page: https://github.com/rla3rd/hyperstreamdb
 Author: HyperStream Team
 License: MIT AND Apache-2.0
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
 Project-URL: Homepage, https://github.com/rla3rd/hyperstreamdb
 Project-URL: Repository, https://github.com/rla3rd/hyperstreamdb
@@ -125,6 +124,10 @@ maturin develop
 
 # Or install from PyPI (coming soon)
 pip install hyperstreamdb
+
+# Windows Users
+# HyperStreamDB is optimized for Linux/POSIX environments. 
+# Windows users should use WSL2 (Windows Subsystem for Linux).
 ```
 
 ### GPU Acceleration (Optional)
@@ -342,10 +345,10 @@ distance = hdb.hamming_distance_packed(binary1, binary2)
 ```
 
 **Supported GPU Backends:**
-- **CUDA** - NVIDIA GPUs (Linux, Windows)
+- **CUDA** - NVIDIA GPUs (Linux, Windows via WSL2)
 - **ROCm** - AMD GPUs (Linux)
 - **Metal (MPS)** - Apple Silicon (macOS)
-- **OpenCL** - Intel GPUs (Linux, Windows)
+- **OpenCL** - Intel GPUs (Linux, Windows via WSL2)
 - **CPU** - Fallback for all platforms
 
 **Supported Distance Metrics:**
@@ -416,18 +419,28 @@ python tests/integration/test_nyc_taxi.py
 ```
 
   **Performance Targets:**
-  - **Scalar Ingest**: >100K rows/sec ✅
+  - **Scalar Ingest**: >10K rows/sec ✅
   - **Vector Ingest (768D)**: >4,000 rows/sec ✅ (April 2026)
   - **Query (indexed)**: <100ms p99 ⏱️
   - **Vector search**: <50ms for k=10 on 10M vectors ⏱️
   - **Compaction**: <5min for 10GB ⏱️
 
-  **Benchmarking Environment:**
+  **Benchmarking Environment: Lenovo T480**
   - **System**: Lenovo T480
   - **CPU**: Intel(R) Core(TM) i5-8350U CPU @ 1.70GHz
   - **RAM**: 64GB
   - **OS**: Linux
 
+  **Benchmarking Environment: Apple M4 Max**
+  - **System**: MacBook Pro (M4 Max, 16-core CPU, 40-core GPU)
+  - **Memory**: 128GB Unified Memory
+  - **OS**: macOS (Arm64)
+  - **Optimizations**: `target-cpu=native` (NEON SIMD)
+  - **Results (100K vectors, 768D)**:
+    - **Vector Ingest**: 16,707 rows/sec (CPU) ✅
+    - **Vector Search (k=10)**: 819ms (CPU / NEON) ✅
+    - **Vector Search (k=10)**: 860ms (MPS GPU) ⏱️
+
 ### Phase 2: Nessie Integration (Next)
 
 **Catalog Strategy:**

{hyperstreamdb-0.1.8 → hyperstreamdb-0.1.11}/README.md

@@ -79,6 +79,10 @@ maturin develop
 
 # Or install from PyPI (coming soon)
 pip install hyperstreamdb
+
+# Windows Users
+# HyperStreamDB is optimized for Linux/POSIX environments. 
+# Windows users should use WSL2 (Windows Subsystem for Linux).
 ```
 
 ### GPU Acceleration (Optional)
@@ -296,10 +300,10 @@ distance = hdb.hamming_distance_packed(binary1, binary2)
 ```
 
 **Supported GPU Backends:**
-- **CUDA** - NVIDIA GPUs (Linux, Windows)
+- **CUDA** - NVIDIA GPUs (Linux, Windows via WSL2)
 - **ROCm** - AMD GPUs (Linux)
 - **Metal (MPS)** - Apple Silicon (macOS)
-- **OpenCL** - Intel GPUs (Linux, Windows)
+- **OpenCL** - Intel GPUs (Linux, Windows via WSL2)
 - **CPU** - Fallback for all platforms
 
 **Supported Distance Metrics:**
@@ -370,18 +374,28 @@ python tests/integration/test_nyc_taxi.py
 ```
 
   **Performance Targets:**
-  - **Scalar Ingest**: >100K rows/sec ✅
+  - **Scalar Ingest**: >10K rows/sec ✅
   - **Vector Ingest (768D)**: >4,000 rows/sec ✅ (April 2026)
   - **Query (indexed)**: <100ms p99 ⏱️
   - **Vector search**: <50ms for k=10 on 10M vectors ⏱️
   - **Compaction**: <5min for 10GB ⏱️
 
-  **Benchmarking Environment:**
+  **Benchmarking Environment: Lenovo T480**
   - **System**: Lenovo T480
   - **CPU**: Intel(R) Core(TM) i5-8350U CPU @ 1.70GHz
   - **RAM**: 64GB
   - **OS**: Linux
 
+  **Benchmarking Environment: Apple M4 Max**
+  - **System**: MacBook Pro (M4 Max, 16-core CPU, 40-core GPU)
+  - **Memory**: 128GB Unified Memory
+  - **OS**: macOS (Arm64)
+  - **Optimizations**: `target-cpu=native` (NEON SIMD)
+  - **Results (100K vectors, 768D)**:
+    - **Vector Ingest**: 16,707 rows/sec (CPU) ✅
+    - **Vector Search (k=10)**: 819ms (CPU / NEON) ✅
+    - **Vector Search (k=10)**: 860ms (MPS GPU) ⏱️
+
 ### Phase 2: Nessie Integration (Next)
 
 **Catalog Strategy:**

hyperstreamdb-0.1.11/benchmark_results/BENCHMARK_REPORT.md

@@ -0,0 +1,50 @@
+# Competitive Benchmark Report - HyperStreamDB
+
+**Generated:** 2026-04-04 13:56:56.467083
+
+## Ingest Performance
+
+| System               | Operation   |   Dataset Size |   Latency (ms) |   Throughput (rows/sec) |   Storage (MB) | Hardware                             | Device   |
+|:---------------------|:------------|---------------:|---------------:|------------------------:|---------------:|:-------------------------------------|:---------|
+| HyperStreamDB        | ingest      |           1000 |       268.945  |                 3718.23 |        7.18574 | Generic Baseline                     | cpu      |
+| DuckDB (Raw Parquet) | ingest      |           1000 |        70.8115 |                14122    |        3.55513 | Generic Baseline                     | cpu      |
+| LanceDB              | ingest      |           1000 |        28.9528 |                34538.9  |        2.98259 | Generic Baseline                     | cpu      |
+| HyperStreamDB        | ingest      |           1000 |       801.391  |                 1247.83 |        7.11231 | AMD Ryzen 9 5900XT 16-Core Processor | cpu      |
+| HyperStreamDB        | ingest      |           1000 |       818.65   |                 1221.52 |        7.13006 | AMD Ryzen 9 5900XT 16-Core Processor | cpu      |
+| HyperStreamDB        | ingest      |           1000 |       820.246  |                 1219.15 |        7.11529 | AMD Ryzen 9 5900XT 16-Core Processor | cuda:0   |
+| HyperStreamDB        | ingest      |           1000 |       290.842  |                 3438.29 |        7.1134  | AMD Ryzen 9 5900XT 16-Core Processor | cpu      |
+| HyperStreamDB        | ingest      |           1000 |       412.61   |                 2423.59 |        7.12722 | AMD Ryzen 9 5900XT 16-Core Processor | cuda:0   |
+
+## Vector Search Performance
+
+| System        | Operation          |   Dataset Size |   Latency (ms) |   Throughput (rows/sec) |   Storage (MB) | Hardware                             | Device   |
+|:--------------|:-------------------|---------------:|---------------:|------------------------:|---------------:|:-------------------------------------|:---------|
+| HyperStreamDB | vector_search_k10  |           1000 |       28.3022  |                     nan |            nan | Generic Baseline                     | cpu      |
+| LanceDB       | vector_search_k10  |           1000 |        6.41737 |                     nan |            nan | Generic Baseline                     | cpu      |
+| HyperStreamDB | vector_search_k10  |           1000 |      109.424   |                     nan |            nan | AMD Ryzen 9 5900XT 16-Core Processor | cpu      |
+| HyperStreamDB | vector_search_k10  |           1000 |      109.012   |                     nan |            nan | AMD Ryzen 9 5900XT 16-Core Processor | cpu      |
+| HyperStreamDB | vector_search_k10  |           1000 |      108.445   |                     nan |            nan | AMD Ryzen 9 5900XT 16-Core Processor | cuda:0   |
+| HyperStreamDB | vector_search_k10  |           1000 |       16.1742  |                     nan |            nan | AMD Ryzen 9 5900XT 16-Core Processor | cpu      |
+| HyperStreamDB | vector_search_k10  |           1000 |       14.6868  |                     nan |            nan | AMD Ryzen 9 5900XT 16-Core Processor | cuda:0   |
+| HyperStreamDB | vector_search_k100 |           1000 |       25.9826  |                     nan |            nan | Generic Baseline                     | cpu      |
+| LanceDB       | vector_search_k100 |           1000 |        7.24833 |                     nan |            nan | Generic Baseline                     | cpu      |
+| HyperStreamDB | vector_search_k100 |           1000 |      148.144   |                     nan |            nan | AMD Ryzen 9 5900XT 16-Core Processor | cpu      |
+| HyperStreamDB | vector_search_k100 |           1000 |      148.415   |                     nan |            nan | AMD Ryzen 9 5900XT 16-Core Processor | cpu      |
+| HyperStreamDB | vector_search_k100 |           1000 |      152.582   |                     nan |            nan | AMD Ryzen 9 5900XT 16-Core Processor | cuda:0   |
+| HyperStreamDB | vector_search_k100 |           1000 |       19.9033  |                     nan |            nan | AMD Ryzen 9 5900XT 16-Core Processor | cpu      |
+| HyperStreamDB | vector_search_k100 |           1000 |       16.9979  |                     nan |            nan | AMD Ryzen 9 5900XT 16-Core Processor | cuda:0   |
+
+## Hybrid Query Performance
+
+## Key Findings
+
+### HyperStreamDB Advantages
+
+1. **Native Hybrid Queries**: Only system with scalar + vector in single query
+2. **Iceberg Compatibility**: Standard data lake format
+3. **Multi-Catalog Support**: Hive, Glue, Unity, REST, Nessie
+4. **100% Iceberg v3 Compliance**: All required features implemented
+
+### Competitive Position
+
+- Vector search: 10.0x slower than LanceDB

hyperstreamdb-0.1.11/benchmark_results/benchmark_results.csv

@@ -0,0 +1,24 @@
+System,Operation,Dataset Size,Latency (ms),Throughput (rows/sec),Storage (MB),Hardware,Device
+HyperStreamDB,ingest,1000,268.94545555114746,3718.2260542410327,7.185737609863281,Generic Baseline,cpu
+DuckDB (Raw Parquet),ingest,1000,70.81151008605957,14121.997946162524,3.555130958557129,Generic Baseline,cpu
+LanceDB,ingest,1000,28.952836990356445,34538.929650765414,2.9825878143310547,Generic Baseline,cpu
+HyperStreamDB,vector_search_k10,1000,28.3022403717041,,,Generic Baseline,cpu
+LanceDB,vector_search_k10,1000,6.417369842529297,,,Generic Baseline,cpu
+HyperStreamDB,vector_search_k100,1000,25.98259449005127,,,Generic Baseline,cpu
+LanceDB,vector_search_k100,1000,7.248330116271973,,,Generic Baseline,cpu
+DuckDB,scalar_query,1000,3.293037414550781,,,Generic Baseline,cpu
+HyperStreamDB,ingest,1000,801.3906478881836,1247.8308832717098,7.112313270568848,AMD Ryzen 9 5900XT 16-Core Processor,cpu
+HyperStreamDB,vector_search_k10,1000,109.423828125,,,AMD Ryzen 9 5900XT 16-Core Processor,cpu
+HyperStreamDB,vector_search_k100,1000,148.14441204071045,,,AMD Ryzen 9 5900XT 16-Core Processor,cpu
+HyperStreamDB,ingest,1000,818.6497688293457,1221.5235844138597,7.130064010620117,AMD Ryzen 9 5900XT 16-Core Processor,cpu
+HyperStreamDB,vector_search_k10,1000,109.01196002960204,,,AMD Ryzen 9 5900XT 16-Core Processor,cpu
+HyperStreamDB,vector_search_k100,1000,148.41535091400146,,,AMD Ryzen 9 5900XT 16-Core Processor,cpu
+HyperStreamDB,ingest,1000,820.2464580535889,1219.1457703736496,7.115290641784668,AMD Ryzen 9 5900XT 16-Core Processor,cuda:0
+HyperStreamDB,vector_search_k10,1000,108.44509601593018,,,AMD Ryzen 9 5900XT 16-Core Processor,cuda:0
+HyperStreamDB,vector_search_k100,1000,152.58185863494873,,,AMD Ryzen 9 5900XT 16-Core Processor,cuda:0
+HyperStreamDB,ingest,1000,290.84205627441406,3438.2922910450206,7.113402366638184,AMD Ryzen 9 5900XT 16-Core Processor,cpu
+HyperStreamDB,vector_search_k10,1000,16.17424488067627,,,AMD Ryzen 9 5900XT 16-Core Processor,cpu
+HyperStreamDB,vector_search_k100,1000,19.90334987640381,,,AMD Ryzen 9 5900XT 16-Core Processor,cpu
+HyperStreamDB,ingest,1000,412.6102924346924,2423.5944142335693,7.127219200134277,AMD Ryzen 9 5900XT 16-Core Processor,cuda:0
+HyperStreamDB,vector_search_k10,1000,14.686751365661621,,,AMD Ryzen 9 5900XT 16-Core Processor,cuda:0
+HyperStreamDB,vector_search_k100,1000,16.997885704040527,,,AMD Ryzen 9 5900XT 16-Core Processor,cuda:0

{hyperstreamdb-0.1.8 → hyperstreamdb-0.1.11}/build.rs

@@ -36,6 +36,7 @@ fn main() {
             "l1_distance",
             "hamming_distance",
             "jaccard_distance",
+            "kmeans_assignment",
         ];
 
         // Compile each kernel

{hyperstreamdb-0.1.8 → hyperstreamdb-0.1.11}/docs/COMPREHENSIVE_GUIDE.md

@@ -1,6 +1,6 @@
 # HyperStreamDB Comprehensive Guide
 
-**Version:** 0.1.8 (Alpha)  
+**Version:** 0.1.10 (Alpha)  
 **Last Updated:** 2026-04-03
 
 HyperStreamDB is a serverless, hybrid-search database optimized for high-performance vector and scalar queries directly on data lakes (S3, GCS, Azure, Local).
@@ -145,20 +145,56 @@ See [pgvector SQL Guide](PGVECTOR_SQL_GUIDE.md) for complete documentation.
 
 ### 3.2 Hardware Acceleration
 The indexing engine supports hardware acceleration for multiple backends:
-*   **CUDA**: NVIDIA GPUs (Linux/Windows)
+*   **CUDA**: NVIDIA GPUs (Linux, Windows via WSL2)
 *   **Metal**: Apple Silicon (MPS)
 *   **ROCm**: AMD GPUs
 *   **Intel**: AVX-512 optimizations
 
 Enable via `Cargo.toml` features or environment detection.
 
-### 3.3 Multi-Catalog Support
-HyperStreamDB supports enterprise catalog integrations:
-*   **Nessie**: Git-like versioning for data.
-*   **Unity Catalog**: Databricks integration.
-*   **AWS Glue**: Native AWS metadata.
-*   **Hive Metastore**: Legacy Hadoop compatibility.
-*   **REST**: Iceberg-compatible REST catalog.
+## 3.3 Multi-Catalog Support
+
+HyperStreamDB is designed to integrate seamlessly with standard data catalogs to provide discovery, cross-table atomicity, and consistent metadata across the enterprise. We support a variety of industry-standard protocols.
+
+Below is a detailed example using the Hive Metastore, followed by short-form examples for other supported catalogs. Full integration guides for each will be provided in future updates.
+
+### Hive Metastore (Detailed Example)
+
+Connecting to a Hive Metastore allows you to resolve table names to storage locations automatically.
+
+```python
+import hyperstreamdb as hdb
+
+# Load a table from Hive Metastore
+table = hdb.Table.from_hive(
+    address="thrift://localhost:9083", 
+    namespace="default", 
+    table="my_analytics_table"
+)
+
+# Any writes will now be atomically committed back to Hive
+df = table.to_pandas(filter="status = 'active'")
+```
+
+### AWS Glue, Nessie, and REST Catalogs
+
+HyperStreamDB also provides native support for cloud-modern catalogs. These can be configured similarly to the Hive example:
+
+```python
+# AWS Glue (Native AWS Integration)
+table = hdb.Table.from_glue(namespace="prod", table="users")
+
+# Project Nessie (Git-like Versioning)
+table = hdb.Table.from_nessie(nessie_url, namespace="dev", table="experiments")
+
+# Iceberg REST Catalog (Standard API)
+table = hdb.Table.from_rest(rest_url, namespace="marketing", table="campaigns")
+
+# Unity Catalog (Databricks Ecosystem)
+table = hdb.Table.from_unity(unity_url, namespace="main", table="gold_data")
+```
+
+For more details on advanced configurations and authentication (Kerberos, SASL, IAM), see the [Configuration Guide](./CONFIGURATION.md) or the [Catalog Usage Guide](./catalog_usage.md).
 
 ---
 

hyperstreamdb-0.1.11/docs/CONCURRENCY.md

@@ -0,0 +1,38 @@
+# Concurrency and Atomic Commits
+
+HyperStreamDB is designed for high-concurrency environments where multiple clients may be reading from and writing to the same table simultaneously.
+
+## Optimistic Concurrency Control (OCC)
+
+HyperStreamDB employs **Optimistic Concurrency Control** to ensure ACID compliance without the need for heavyweight central locks in most cases.
+
+### Snapshot Versioning
+Every table state is represented by a specific version of the manifest file (e.g., `_manifest/v100.json`). These files are immutable once written.
+
+### The Commit Protocol
+When a client (writer) wants to commit changes:
+1.  **Read Latest**: The client reads the current latest version (e.g., `v100`).
+2.  **Prepare**: The client calculates the new state (`v101`) based on the changes (e.g., added or removed segments).
+3.  **Atomic Swap**: The client attempts to write the new manifest file `v101.json` using an **atomic "create-if-not-exists"** primitive.
+
+### Conflict Resolution
+If another client successfully committed `v101.json` while the first client was preparing its changes:
+- The first client's write operation will fail with an `AlreadyExists` or conflict error.
+- HyperStreamDB automatically **retries** the commit (up to 100 times).
+- In each retry, the client re-reads the *new* latest version, merges its changes again, and attempts to commit the *next* version (e.g., `v102`).
+- A randomized **exponential backoff** is used between retries to reduce contention.
+
+## Catalog-Level Locking
+
+While OCC works perfectly on local file systems and some cloud storage providers (like Azure Blob or Google Cloud Storage with certain settings), some providers like **AWS S3** do not natively support atomic "create-if-not-exists" with strong consistency for all operations.
+
+In these cases, HyperStreamDB leverages **Iceberg-compatible catalogs** to provide the necessary atomicity:
+
+- **AWS Glue**: Uses the Glue Catalog's built-in versioning and optimistic locking.
+- **Nessie**: Provides Git-like branching and merging with cross-table atomic commits.
+- **Hive Metastore**: Uses a relational database backend (like PostgreSQL or MySQL) to provide transactionally safe updates to the `metadata_location` parameter.
+- **REST Catalog**: Delegates atomicity to a centralized REST server (e.g., Tabular, Polaris).
+
+## Read Isolation
+
+Readers in HyperStreamDB always see a **consistent snapshot** of the table. Once a reader loads a particular version (e.g., `v100`), it will continue to see that state even if newer versions are committed by other clients. This provides **Snapshot Isolation**, which is ideal for long-running analytical queries.

hyperstreamdb-0.1.11/docs/CONFIGURATION.md

@@ -0,0 +1,51 @@
+# Configuration Guide
+
+HyperStreamDB is designed to be highly configurable through environment variables and a centralized configuration file.
+
+## Environment Variables
+
+These variables control the core behavior of the system, including memory management, caching, and storage paths.
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `HYPERSTREAM_CACHE_GB` | Memory limit for the hybrid vector index (HNSW-IVF) in GB. | `2` |
+| `HYPERSTREAM_BLOCK_CACHE_GB` | Memory limit for the decoded RecordBatch block cache in GB. | `4` |
+| `HYPERSTREAM_DISK_CACHE_DIR` | Directory used for caching segmented index files on local disk. | `/tmp/hdb_cache` |
+| `HYPERSTREAM_WAL_DIR` | Directory for the Write-Ahead Log (WAL) used for fault tolerance. | `{table_uri}/_wal` |
+| `HYPERSTREAM_CONFIG` | Path to a centralized `hyperstream.toml` configuration file. | None |
+| `JAEGER_ENABLED` | Enable distributed tracing via Jaeger (requires `opentelemetry` feature). | `false` |
+
+## The hyperstream.toml File
+
+You can use a TOML file to manage complex configurations, especially for catalogs and multi-cloud storage.
+
+HyperStreamDB looks for this file in the following order:
+1. Environment variable `HYPERSTREAM_CONFIG`
+2. `./hyperstream.toml` (current directory)
+3. `~/.hyperstream/config.toml`
+
+### Example Configuration
+
+```toml
+[storage]
+type = "s3"
+bucket = "my-data-lake"
+region = "us-east-1"
+
+[cache]
+memory_limit_gb = 8
+disk_cache_enabled = true
+disk_cache_path = "/mnt/fast-ssd/hdb_cache"
+
+[catalog]
+type = "nessie"
+url = "http://nessie:19120/api/v2"
+ref = "main"
+```
+
+## Storage Credentials
+
+HyperStreamDB uses the standard `object-store` crate, which automatically picks up credentials from:
+- **AWS**: `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_REGION`, or IAM Roles.
+- **GCP**: `GOOGLE_APPLICATION_CREDENTIALS` (JSON key file path).
+- **Azure**: `AZURE_STORAGE_ACCOUNT`, `AZURE_STORAGE_KEY`.

{hyperstreamdb-0.1.8 → hyperstreamdb-0.1.11}/docs/GPU_SETUP_GUIDE.md

@@ -9,7 +9,7 @@ HyperStreamDB supports GPU acceleration for vector distance computations across
 - **NVIDIA CUDA** - For NVIDIA GPUs (GeForce, Quadro, Tesla)
 - **AMD ROCm** - For AMD Radeon GPUs
 - **Apple Metal (MPS)** - For Apple Silicon Macs
-- **Intel OpenCL** - For Intel integrated and discrete GPUs
+- **Intel OpenCL** - For Intel integrated and discrete GPUs (Linux, WSL2)
 
 GPU acceleration provides 10x+ speedup for batch distance operations on large vector databases (100,000+ vectors).
 
@@ -69,15 +69,16 @@ nvidia-smi
 nvcc --version
 ```
 
-### Installation on Windows
+### Installation on Windows (via WSL2)
 
-1. Download CUDA Toolkit from [NVIDIA website](https://developer.nvidia.com/cuda-downloads)
-2. Run the installer (cuda_12.3.0_windows.exe)
-3. Follow the installation wizard
-4. Verify installation:
-   ```cmd
+Windows users should use **WSL2** (Windows Subsystem for Linux) to run HyperStreamDB with GPU support.
+
+1. Install WSL2 and Ubuntu (e.g., `wsl --install -d Ubuntu-22.04`)
+2. Install NVIDIA Windows Driver (this provides the necessary kernel-mode interface for WSL2)
+3. Within the WSL2 Ubuntu environment, follow the **Linux installation** instructions above.
+4. Verify from within WSL:
+   ```bash
    nvidia-smi
-   nvcc --version
    ```
 
 ### Verification
@@ -236,7 +237,7 @@ print(f"Computed {len(distances)} distances on Apple GPU")
 - **GPU**: Intel Iris Xe or newer (integrated or discrete)
   - Recommended: Arc A-series discrete GPUs
 - **Driver**: Intel Graphics Driver with OpenCL support
-- **OS**: Linux or Windows
+- **OS**: Linux or WSL2 (Windows with WSL2)
 
 ### Supported GPUs
 
@@ -260,12 +261,9 @@ sudo apt-get install opencl-headers
 clinfo
 ```
 
-### Installation on Windows
+### Installation on Windows (via WSL2)
 
-1. Download latest Intel Graphics Driver from [Intel Download Center](https://www.intel.com/content/www/us/en/download-center/home.html)
-2. Run the installer
-3. OpenCL support is included in modern Intel drivers
-4. Verify with `clinfo` (install from [GitHub](https://github.com/Oblomov/clinfo))
+Windows users should install the Intel OpenCL runtime within their WSL2 distribution following the Linux installation steps above. 
 
 ### Verification