From 07b1cca3ff6d1f796d95307beba1de28baa96c11 Mon Sep 17 00:00:00 2001 From: lc285652 Date: Tue, 15 Sep 2026 19:44:45 +0800 Subject: [PATCH 1/5] docs: add platform support page (en/zh) Add a Platform Support page to the Zvec docs that consolidates: - official language SDKs (Python, Node.js, Go, Rust, Java, Dart/Flutter) with install commands, repositories, and prebuilt platform coverage - CI-verified OS/architecture combinations and prebuilt artifact status, including musl Linux, macOS Intel, Android, iOS, and RISC-V - an index-by-platform availability matrix (Flat, IVF, HNSW, Vamana, sparse, RaBitQ, DiskANN, INVERT, FTS) Registered in the Introduction section of both en/zh sidebars. --- content/docs/en/db/meta.json | 1 + content/docs/en/db/platforms.mdx | 86 +++++++++++++++++++++++++++++++ content/docs/zh/db/meta.json | 1 + content/docs/zh/db/platforms.mdx | 88 ++++++++++++++++++++++++++++++++ 4 files changed, 176 insertions(+) create mode 100644 content/docs/en/db/platforms.mdx create mode 100644 content/docs/zh/db/platforms.mdx diff --git a/content/docs/en/db/meta.json b/content/docs/en/db/meta.json index 0f10cb212..72aff07b9 100644 --- a/content/docs/en/db/meta.json +++ b/content/docs/en/db/meta.json @@ -5,6 +5,7 @@ "---Introduction---", "index", "concepts", + "platforms", "[ExternalLink][API Reference](/en/api-reference/)", "---Guides---", "quickstart", diff --git a/content/docs/en/db/platforms.mdx b/content/docs/en/db/platforms.mdx new file mode 100644 index 000000000..f431d3b80 --- /dev/null +++ b/content/docs/en/db/platforms.mdx @@ -0,0 +1,86 @@ +--- +title: Platform Support +description: Official language SDKs, supported operating systems and CPU architectures, and per-platform index availability for Zvec. +icon: MonitorSmartphone +--- + + +import { Cpu, HardDrive, Rocket, SearchCode } from 'lucide-react'; + +## Language SDKs + +| SDK | Install | Repository | Prebuilt platform coverage | +| --- | --- | --- | --- | +| Python | `pip install zvec` (64-bit, 3.10–3.14) | [alibaba/zvec · `python/`](https://github.com/alibaba/zvec/tree/main/python) | manylinux x86_64 / ARM64, musllinux x86_64 / ARM64, macOS ARM64, Windows x64 | +| Node.js | `npm install @zvec/zvec` | [zvec-ai/zvec-node](https://github.com/zvec-ai/zvec-node) | Linux x86_64 / ARM64 (glibc and musl), macOS ARM64 / x64, Windows x64 | +| Go | `go get github.com/zvec-ai/zvec-go` | [zvec-ai/zvec-go](https://github.com/zvec-ai/zvec-go) | Linux x64 / ARM64, macOS ARM64, Windows x64 | +| Rust | `cargo add zvec-rust` | [zvec-ai/zvec-rust](https://github.com/zvec-ai/zvec-rust) | Linux x86_64 / ARM64, macOS ARM64, Windows x64 | +| Java | Maven Central `org.zvec:zvec-java` | [zvec-ai/zvec-java](https://github.com/zvec-ai/zvec-java) | Linux x86_64 / ARM64 (glibc 2.27 or newer), macOS ARM64, Windows x64 | +| Dart / Flutter | `flutter pub add zvec` | [zvec-ai/zvec-dart](https://github.com/zvec-ai/zvec-dart) | Android arm64-v8a, iOS arm64, macOS ARM64, Linux x64, Windows x64 | + +- **Python** publishes `musllinux` wheels for x86_64 and ARM64 alongside the `manylinux` ones, so Alpine-based images work out of the box. +- **Go** provides two backends: `CGO_ENABLED=1` uses cgo, `CGO_ENABLED=0` switches to runtime FFI, so environments without a C toolchain still work. +- **Rust** enables the `bundled` feature by default and downloads the matching prebuilt library from GitHub Releases — zero configuration. +- **Java** uses JavaCPP-generated JNI bindings; the default all-platform fat JAR already bundles the native library for every supported platform. Per-platform classifiers and a `nolib` variant are published too, for smaller artifacts or for bringing your own native library. +- **Dart / Flutter** bundles prebuilt libraries for all five platforms and packages the right one during `flutter build`. This is the main path for embedding Zvec in mobile apps. + +Tools built on the same C API: [Zvec Studio](https://github.com/zvec-ai/zvec-studio) (visual workbench), the [Zvec MCP Server](https://github.com/zvec-ai/zvec-mcp-server), and [Zvec-Grep](../../zvec-grep/) (`zg`, local-first workspace search for humans and agents). + +## Supported Platforms + +| Platform | Architectures | CI verification | Prebuilt artifacts | +| --- | --- | --- | --- | +| Linux (glibc) | x86_64, ARM64 | Full build and tests, plus a Clang compatibility matrix | ✅ | +| Linux (musl) | x86_64, ARM64 | Since v0.7.0 — covers Alpine and other musl distributions | ✅ | +| macOS | ARM64 (Apple Silicon), x86_64 (Intel) | ARM64 validated on macOS 15 and macOS 26; x86_64 built and tested on Intel runners | ✅ | +| Windows | x86_64 | Windows Server 2022 and 2025 | ✅ | +| Android | arm64-v8a | Unit tests actually run inside an x86_64 emulator | ✅ | +| iOS | arm64 | Simulator tests plus device builds | ✅ | +| RISC-V | riscv64 | Weekly full build and unit tests on native riscv64 runners | ❌ — build from source | + +## Index Availability + +| Index | Linux x86_64 | Linux ARM64 | macOS ARM64 | Windows x86_64 | Android arm64 | iOS arm64 | RISC-V | +| --- | :-: | :-: | :-: | :-: | :-: | :-: | :-: | +| [Flat](./concepts/vector-index/flat-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| [IVF](./concepts/vector-index/ivf-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| [HNSW](./concepts/vector-index/hnsw-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| [Vamana](./concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| Sparse vectors (Flat / HNSW) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| [RaBitQ](./concepts/vector-index/hnsw-rabitq-index/) (HNSW / IVF) | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | +| [DiskANN](./concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | +| [INVERT](./concepts/inverted-index/) (scalar) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| [FTS](./concepts/fts-index/) (full-text) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | + + + **RaBitQ** requires AVX2 and AVX-512, which is why it is limited to Linux x86_64 today. + + +## Related + + + } + /> + } + /> + } + /> + } + /> + diff --git a/content/docs/zh/db/meta.json b/content/docs/zh/db/meta.json index fd1a2d135..daa88928e 100644 --- a/content/docs/zh/db/meta.json +++ b/content/docs/zh/db/meta.json @@ -5,6 +5,7 @@ "---入门---", "index", "concepts", + "platforms", "[ExternalLink][API 参考](/zh/api-reference/)", "---使用指南---", "quickstart", diff --git a/content/docs/zh/db/platforms.mdx b/content/docs/zh/db/platforms.mdx new file mode 100644 index 000000000..34c93204f --- /dev/null +++ b/content/docs/zh/db/platforms.mdx @@ -0,0 +1,88 @@ +--- +title: 平台支持 +description: Zvec 官方支持的语言 SDK、操作系统与 CPU 架构，以及各索引在不同平台上的可用性矩阵。 +icon: MonitorSmartphone +--- + + +import { Cpu, HardDrive, Rocket, SearchCode } from 'lucide-react'; + +## 语言 SDK + +| SDK | 安装 | 代码仓库 | 预编译产物覆盖 | +| --- | --- | --- | --- | +| Python | `pip install zvec`（64 位，3.10–3.14） | [alibaba/zvec · `python/`](https://github.com/alibaba/zvec/tree/main/python) | manylinux x86_64 / ARM64、musllinux x86_64 / ARM64、macOS ARM64、Windows x64 | +| Node.js | `npm install @zvec/zvec` | [zvec-ai/zvec-node](https://github.com/zvec-ai/zvec-node) | Linux x86_64 / ARM64（glibc 与 musl）、macOS ARM64 / x64、Windows x64 | +| Go | `go get github.com/zvec-ai/zvec-go` | [zvec-ai/zvec-go](https://github.com/zvec-ai/zvec-go) | Linux x64 / ARM64、macOS ARM64、Windows x64 | +| Rust | `cargo add zvec-rust` | [zvec-ai/zvec-rust](https://github.com/zvec-ai/zvec-rust) | Linux x86_64 / ARM64、macOS ARM64、Windows x64 | +| Java | Maven Central `org.zvec:zvec-java` | [zvec-ai/zvec-java](https://github.com/zvec-ai/zvec-java) | Linux x86_64 / ARM64（glibc 2.27 及以上）、macOS ARM64、Windows x64 | +| Dart / Flutter | `flutter pub add zvec` | [zvec-ai/zvec-dart](https://github.com/zvec-ai/zvec-dart) | Android arm64-v8a、iOS arm64、macOS ARM64、Linux x64、Windows x64 | + +- **Python**：除 `manylinux` 外同时发布 x86_64 与 ARM64 的 `musllinux` wheel，Alpine 等 musl 环境开箱即用。 +- **Go**：提供 cgo 与 purego 双后端 —— `CGO_ENABLED=1` 走 cgo，`CGO_ENABLED=0` 自动切换到运行时 FFI，没有 C 编译器的环境照样能用。 +- **Rust**：默认开启 `bundled` feature，自动从 GitHub Releases 下载对应平台的预编译库，零配置上手。 +- **Java**：基于 JavaCPP 的 JNI binding，默认 all-platform fat JAR 已内置全部支持平台的预编译库；也提供按平台 classifier（`macosx-arm64` / `linux-x86_64` / `linux-arm64` / `windows-x86_64`）与 `nolib` 变体，方便按需裁剪或自带 native 库。 +- **Dart / Flutter**：内置五平台预编译库，`flutter build` 时自动下载并打包对应的 native 库，这是 Zvec 进入移动 App 最主要的通道。 + +同样构建在 C API 之上的生态工具：[Zvec Studio](https://github.com/zvec-ai/zvec-studio)（可视化管理工具）、[Zvec MCP Server](https://github.com/zvec-ai/zvec-mcp-server)，以及 [Zvec-Grep](../../zvec-grep/)（`zg`，面向人与 Agent 的本地工作区检索）。 + +## 支持的软硬件平台 + +| 平台 | 架构 | CI 验证 | 预编译产物 | +| --- | --- | --- | --- | +| Linux（glibc） | x86_64、ARM64 | 完整构建与测试，另有 Clang 编译器兼容矩阵 | ✅ | +| Linux（musl） | x86_64、ARM64 | 自 v0.7.0 起，覆盖 Alpine 等 musl 发行版 | ✅ | +| macOS | ARM64（Apple Silicon）、x86_64（Intel） | ARM64 在 macOS 15 与 macOS 26 双版本验证；x86_64 在 Intel runner 上构建并测试 | ✅ | +| Windows | x86_64 | Windows Server 2022 与 2025 | ✅ | +| Android | arm64-v8a | 在 x86_64 模拟器中实际运行单元测试 | ✅ | +| iOS | arm64 | 跑模拟器测试并产出真机构建 | ✅ | +| RISC-V | riscv64 | 每周在原生 riscv64 runner 上完整构建并运行单元测试 | ❌ —— 需源码构建 | + + +## 索引可用性矩阵 + +| 索引 | Linux x86_64 | Linux ARM64 | macOS ARM64 | Windows x86_64 | Android arm64 | iOS arm64 | RISC-V | +| --- | :-: | :-: | :-: | :-: | :-: | :-: | :-: | +| [Flat](./concepts/vector-index/flat-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| [IVF](./concepts/vector-index/ivf-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| [HNSW](./concepts/vector-index/hnsw-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| [Vamana](./concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| 稀疏向量（Flat / HNSW） | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| [RaBitQ](./concepts/vector-index/hnsw-rabitq-index/)（HNSW / IVF） | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | +| [DiskANN](./concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | +| [INVERT](./concepts/inverted-index/)（标量倒排） | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| [FTS](./concepts/fts-index/)（全文检索） | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | + + + **RaBitQ** 依赖 AVX2 与 AVX-512，因此目前仅支持 Linux x86_64。 + + + +## 相关阅读 + + + } + /> + } + /> + } + /> + } + /> + From 1ae2c92521adac13d1b757728992040f92dc94d2 Mon Sep 17 00:00:00 2001 From: lc285652 Date: Fri, 18 Sep 2026 10:17:03 +0800 Subject: [PATCH 2/5] docs: polish platform support page (en/zh) - Drop the per-SDK notes accordion and the ecosystem tools paragraph to reduce visual density - Fix relative links (./ -> ../) so the index matrix and related cards resolve correctly from the page URL - Point the RaBitQ row's HNSW / IVF labels at the HNSW-RaBitQ and IVF-RaBitQ concept pages --- content/docs/en/db/platforms.mdx | 37 ++++++++++++++------------------ content/docs/zh/db/platforms.mdx | 37 +++++++++++++------------------- 2 files changed, 31 insertions(+), 43 deletions(-) diff --git a/content/docs/en/db/platforms.mdx b/content/docs/en/db/platforms.mdx index f431d3b80..15f0ef6c9 100644 --- a/content/docs/en/db/platforms.mdx +++ b/content/docs/en/db/platforms.mdx @@ -4,7 +4,6 @@ description: Official language SDKs, supported operating systems and CPU archite icon: MonitorSmartphone --- - import { Cpu, HardDrive, Rocket, SearchCode } from 'lucide-react'; ## Language SDKs @@ -18,14 +17,6 @@ import { Cpu, HardDrive, Rocket, SearchCode } from 'lucide-react'; | Java | Maven Central `org.zvec:zvec-java` | [zvec-ai/zvec-java](https://github.com/zvec-ai/zvec-java) | Linux x86_64 / ARM64 (glibc 2.27 or newer), macOS ARM64, Windows x64 | | Dart / Flutter | `flutter pub add zvec` | [zvec-ai/zvec-dart](https://github.com/zvec-ai/zvec-dart) | Android arm64-v8a, iOS arm64, macOS ARM64, Linux x64, Windows x64 | -- **Python** publishes `musllinux` wheels for x86_64 and ARM64 alongside the `manylinux` ones, so Alpine-based images work out of the box. -- **Go** provides two backends: `CGO_ENABLED=1` uses cgo, `CGO_ENABLED=0` switches to runtime FFI, so environments without a C toolchain still work. -- **Rust** enables the `bundled` feature by default and downloads the matching prebuilt library from GitHub Releases — zero configuration. -- **Java** uses JavaCPP-generated JNI bindings; the default all-platform fat JAR already bundles the native library for every supported platform. Per-platform classifiers and a `nolib` variant are published too, for smaller artifacts or for bringing your own native library. -- **Dart / Flutter** bundles prebuilt libraries for all five platforms and packages the right one during `flutter build`. This is the main path for embedding Zvec in mobile apps. - -Tools built on the same C API: [Zvec Studio](https://github.com/zvec-ai/zvec-studio) (visual workbench), the [Zvec MCP Server](https://github.com/zvec-ai/zvec-mcp-server), and [Zvec-Grep](../../zvec-grep/) (`zg`, local-first workspace search for humans and agents). - ## Supported Platforms | Platform | Architectures | CI verification | Prebuilt artifacts | @@ -36,21 +27,25 @@ Tools built on the same C API: [Zvec Studio](https://github.com/zvec-ai/zvec-stu | Windows | x86_64 | Windows Server 2022 and 2025 | ✅ | | Android | arm64-v8a | Unit tests actually run inside an x86_64 emulator | ✅ | | iOS | arm64 | Simulator tests plus device builds | ✅ | -| RISC-V | riscv64 | Weekly full build and unit tests on native riscv64 runners | ❌ — build from source | +| RISC-V | riscv64 | Weekly full build and unit tests on native riscv64 runners | ❌ | + +*✅ = prebuilt artifacts published · ❌ = build from source.* ## Index Availability | Index | Linux x86_64 | Linux ARM64 | macOS ARM64 | Windows x86_64 | Android arm64 | iOS arm64 | RISC-V | | --- | :-: | :-: | :-: | :-: | :-: | :-: | :-: | -| [Flat](./concepts/vector-index/flat-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| [IVF](./concepts/vector-index/ivf-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| [HNSW](./concepts/vector-index/hnsw-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| [Vamana](./concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| [Flat](../concepts/vector-index/flat-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| [IVF](../concepts/vector-index/ivf-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| [HNSW](../concepts/vector-index/hnsw-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| [Vamana](../concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | Sparse vectors (Flat / HNSW) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| [RaBitQ](./concepts/vector-index/hnsw-rabitq-index/) (HNSW / IVF) | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | -| [DiskANN](./concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | -| [INVERT](./concepts/inverted-index/) (scalar) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| [FTS](./concepts/fts-index/) (full-text) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| RaBitQ ([HNSW](../concepts/vector-index/hnsw-rabitq-index/) / [IVF](../concepts/vector-index/ivf-rabitq-index/)) | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | +| [DiskANN](../concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | +| [INVERT](../concepts/inverted-index/) (scalar) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| [FTS](../concepts/fts-index/) (full-text) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | + +*✅ = available on that platform · ❌ = not available.* **RaBitQ** requires AVX2 and AVX-512, which is why it is limited to Linux x86_64 today. @@ -61,19 +56,19 @@ Tools built on the same C API: [Zvec Studio](https://github.com/zvec-ai/zvec-stu } /> } /> } /> diff --git a/content/docs/zh/db/platforms.mdx b/content/docs/zh/db/platforms.mdx index 34c93204f..32b7168ba 100644 --- a/content/docs/zh/db/platforms.mdx +++ b/content/docs/zh/db/platforms.mdx @@ -4,7 +4,6 @@ description: Zvec 官方支持的语言 SDK、操作系统与 CPU 架构，以 icon: MonitorSmartphone --- - import { Cpu, HardDrive, Rocket, SearchCode } from 'lucide-react'; ## 语言 SDK @@ -18,14 +17,6 @@ import { Cpu, HardDrive, Rocket, SearchCode } from 'lucide-react'; | Java | Maven Central `org.zvec:zvec-java` | [zvec-ai/zvec-java](https://github.com/zvec-ai/zvec-java) | Linux x86_64 / ARM64（glibc 2.27 及以上）、macOS ARM64、Windows x64 | | Dart / Flutter | `flutter pub add zvec` | [zvec-ai/zvec-dart](https://github.com/zvec-ai/zvec-dart) | Android arm64-v8a、iOS arm64、macOS ARM64、Linux x64、Windows x64 | -- **Python**：除 `manylinux` 外同时发布 x86_64 与 ARM64 的 `musllinux` wheel，Alpine 等 musl 环境开箱即用。 -- **Go**：提供 cgo 与 purego 双后端 —— `CGO_ENABLED=1` 走 cgo，`CGO_ENABLED=0` 自动切换到运行时 FFI，没有 C 编译器的环境照样能用。 -- **Rust**：默认开启 `bundled` feature，自动从 GitHub Releases 下载对应平台的预编译库，零配置上手。 -- **Java**：基于 JavaCPP 的 JNI binding，默认 all-platform fat JAR 已内置全部支持平台的预编译库；也提供按平台 classifier（`macosx-arm64` / `linux-x86_64` / `linux-arm64` / `windows-x86_64`）与 `nolib` 变体，方便按需裁剪或自带 native 库。 -- **Dart / Flutter**：内置五平台预编译库，`flutter build` 时自动下载并打包对应的 native 库，这是 Zvec 进入移动 App 最主要的通道。 - -同样构建在 C API 之上的生态工具：[Zvec Studio](https://github.com/zvec-ai/zvec-studio)（可视化管理工具）、[Zvec MCP Server](https://github.com/zvec-ai/zvec-mcp-server)，以及 [Zvec-Grep](../../zvec-grep/)（`zg`，面向人与 Agent 的本地工作区检索）。 - ## 支持的软硬件平台 | 平台 | 架构 | CI 验证 | 预编译产物 | @@ -36,46 +27,48 @@ import { Cpu, HardDrive, Rocket, SearchCode } from 'lucide-react'; | Windows | x86_64 | Windows Server 2022 与 2025 | ✅ | | Android | arm64-v8a | 在 x86_64 模拟器中实际运行单元测试 | ✅ | | iOS | arm64 | 跑模拟器测试并产出真机构建 | ✅ | -| RISC-V | riscv64 | 每周在原生 riscv64 runner 上完整构建并运行单元测试 | ❌ —— 需源码构建 | +| RISC-V | riscv64 | 每周在原生 riscv64 runner 上完整构建并运行单元测试 | ❌ | +*✅ = 提供预编译产物 · ❌ = 需源码构建。* ## 索引可用性矩阵 | 索引 | Linux x86_64 | Linux ARM64 | macOS ARM64 | Windows x86_64 | Android arm64 | iOS arm64 | RISC-V | | --- | :-: | :-: | :-: | :-: | :-: | :-: | :-: | -| [Flat](./concepts/vector-index/flat-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| [IVF](./concepts/vector-index/ivf-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| [HNSW](./concepts/vector-index/hnsw-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| [Vamana](./concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| [Flat](../concepts/vector-index/flat-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| [IVF](../concepts/vector-index/ivf-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| [HNSW](../concepts/vector-index/hnsw-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| [Vamana](../concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | 稀疏向量（Flat / HNSW） | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| [RaBitQ](./concepts/vector-index/hnsw-rabitq-index/)（HNSW / IVF） | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | -| [DiskANN](./concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | -| [INVERT](./concepts/inverted-index/)（标量倒排） | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| [FTS](./concepts/fts-index/)（全文检索） | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| RaBitQ（[HNSW](../concepts/vector-index/hnsw-rabitq-index/) / [IVF](../concepts/vector-index/ivf-rabitq-index/)） | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | +| [DiskANN](../concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | +| [INVERT](../concepts/inverted-index/)（标量倒排） | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| [FTS](../concepts/fts-index/)（全文检索） | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | + +*✅ = 该平台可用 · ❌ = 不支持。* **RaBitQ** 依赖 AVX2 与 AVX-512，因此目前仅支持 Linux x86_64。 - ## 相关阅读 } /> } /> } /> From 04d374edeafd3acfa5e22d2e3eb9c806b9113af3 Mon Sep 17 00:00:00 2001 From: lc285652 Date: Fri, 18 Sep 2026 10:43:08 +0800 Subject: [PATCH 3/5] docs: turn SDK section into per-SDK tabs (en/zh) External users usually arrive with a language in mind, so replace the wide SDK comparison table with fumadocs Tabs: each tab shows only the install command, prebuilt platform coverage, and repository link for that SDK, matching the DuckDB installer experience while staying static MDX. --- content/docs/en/db/platforms.mdx | 85 +++++++++++++++++++++++++++++--- content/docs/zh/db/platforms.mdx | 85 +++++++++++++++++++++++++++++--- 2 files changed, 154 insertions(+), 16 deletions(-) diff --git a/content/docs/en/db/platforms.mdx b/content/docs/en/db/platforms.mdx index 15f0ef6c9..0934b0383 100644 --- a/content/docs/en/db/platforms.mdx +++ b/content/docs/en/db/platforms.mdx @@ -5,17 +5,86 @@ icon: MonitorSmartphone --- import { Cpu, HardDrive, Rocket, SearchCode } from 'lucide-react'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; ## Language SDKs -| SDK | Install | Repository | Prebuilt platform coverage | -| --- | --- | --- | --- | -| Python | `pip install zvec` (64-bit, 3.10–3.14) | [alibaba/zvec · `python/`](https://github.com/alibaba/zvec/tree/main/python) | manylinux x86_64 / ARM64, musllinux x86_64 / ARM64, macOS ARM64, Windows x64 | -| Node.js | `npm install @zvec/zvec` | [zvec-ai/zvec-node](https://github.com/zvec-ai/zvec-node) | Linux x86_64 / ARM64 (glibc and musl), macOS ARM64 / x64, Windows x64 | -| Go | `go get github.com/zvec-ai/zvec-go` | [zvec-ai/zvec-go](https://github.com/zvec-ai/zvec-go) | Linux x64 / ARM64, macOS ARM64, Windows x64 | -| Rust | `cargo add zvec-rust` | [zvec-ai/zvec-rust](https://github.com/zvec-ai/zvec-rust) | Linux x86_64 / ARM64, macOS ARM64, Windows x64 | -| Java | Maven Central `org.zvec:zvec-java` | [zvec-ai/zvec-java](https://github.com/zvec-ai/zvec-java) | Linux x86_64 / ARM64 (glibc 2.27 or newer), macOS ARM64, Windows x64 | -| Dart / Flutter | `flutter pub add zvec` | [zvec-ai/zvec-dart](https://github.com/zvec-ai/zvec-dart) | Android arm64-v8a, iOS arm64, macOS ARM64, Linux x64, Windows x64 | +All SDKs share one stable C API boundary — pick your language to see the install command and prebuilt platform coverage. + + + + + +```bash +pip install zvec +``` + +- **Prebuilt coverage**: manylinux x86_64 / ARM64, musllinux x86_64 / ARM64, macOS ARM64, Windows x64 +- **Requirements**: 64-bit Python 3.10–3.14 +- **Repository**: [alibaba/zvec · `python/`](https://github.com/alibaba/zvec/tree/main/python) + + + + + +```bash +npm install @zvec/zvec +``` + +- **Prebuilt coverage**: Linux x86_64 / ARM64 (glibc and musl), macOS ARM64 / x64, Windows x64 +- **Repository**: [zvec-ai/zvec-node](https://github.com/zvec-ai/zvec-node) + + + + + +```bash +go get github.com/zvec-ai/zvec-go +``` + +- **Prebuilt coverage**: Linux x64 / ARM64, macOS ARM64, Windows x64 +- **Repository**: [zvec-ai/zvec-go](https://github.com/zvec-ai/zvec-go) + + + + + +```bash +cargo add zvec-rust +``` + +- **Prebuilt coverage**: Linux x86_64 / ARM64, macOS ARM64, Windows x64 +- **Repository**: [zvec-ai/zvec-rust](https://github.com/zvec-ai/zvec-rust) + + + + + +```xml + + org.zvec + zvec-java + +``` + +- **Prebuilt coverage**: Linux x86_64 / ARM64 (glibc 2.27 or newer), macOS ARM64, Windows x64 +- **Repository**: [zvec-ai/zvec-java](https://github.com/zvec-ai/zvec-java) + + + + + +```bash +flutter pub add zvec +``` + +- **Prebuilt coverage**: Android arm64-v8a, iOS arm64, macOS ARM64, Linux x64, Windows x64 +- **Repository**: [zvec-ai/zvec-dart](https://github.com/zvec-ai/zvec-dart) + + + + + ## Supported Platforms diff --git a/content/docs/zh/db/platforms.mdx b/content/docs/zh/db/platforms.mdx index 32b7168ba..cb1ccad8b 100644 --- a/content/docs/zh/db/platforms.mdx +++ b/content/docs/zh/db/platforms.mdx @@ -5,17 +5,86 @@ icon: MonitorSmartphone --- import { Cpu, HardDrive, Rocket, SearchCode } from 'lucide-react'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; ## 语言 SDK -| SDK | 安装 | 代码仓库 | 预编译产物覆盖 | -| --- | --- | --- | --- | -| Python | `pip install zvec`（64 位，3.10–3.14） | [alibaba/zvec · `python/`](https://github.com/alibaba/zvec/tree/main/python) | manylinux x86_64 / ARM64、musllinux x86_64 / ARM64、macOS ARM64、Windows x64 | -| Node.js | `npm install @zvec/zvec` | [zvec-ai/zvec-node](https://github.com/zvec-ai/zvec-node) | Linux x86_64 / ARM64（glibc 与 musl）、macOS ARM64 / x64、Windows x64 | -| Go | `go get github.com/zvec-ai/zvec-go` | [zvec-ai/zvec-go](https://github.com/zvec-ai/zvec-go) | Linux x64 / ARM64、macOS ARM64、Windows x64 | -| Rust | `cargo add zvec-rust` | [zvec-ai/zvec-rust](https://github.com/zvec-ai/zvec-rust) | Linux x86_64 / ARM64、macOS ARM64、Windows x64 | -| Java | Maven Central `org.zvec:zvec-java` | [zvec-ai/zvec-java](https://github.com/zvec-ai/zvec-java) | Linux x86_64 / ARM64（glibc 2.27 及以上）、macOS ARM64、Windows x64 | -| Dart / Flutter | `flutter pub add zvec` | [zvec-ai/zvec-dart](https://github.com/zvec-ai/zvec-dart) | Android arm64-v8a、iOS arm64、macOS ARM64、Linux x64、Windows x64 | +所有 SDK 共享同一条稳定的 C API 边界——选择你的语言，查看安装命令与预编译产物覆盖。 + + + + + +```bash +pip install zvec +``` + +- **预编译覆盖**：manylinux x86_64 / ARM64、musllinux x86_64 / ARM64、macOS ARM64、Windows x64 +- **版本要求**：64 位 Python 3.10–3.14 +- **代码仓库**：[alibaba/zvec · `python/`](https://github.com/alibaba/zvec/tree/main/python) + + + + + +```bash +npm install @zvec/zvec +``` + +- **预编译覆盖**：Linux x86_64 / ARM64（glibc 与 musl）、macOS ARM64 / x64、Windows x64 +- **代码仓库**：[zvec-ai/zvec-node](https://github.com/zvec-ai/zvec-node) + + + + + +```bash +go get github.com/zvec-ai/zvec-go +``` + +- **预编译覆盖**：Linux x64 / ARM64、macOS ARM64、Windows x64 +- **代码仓库**：[zvec-ai/zvec-go](https://github.com/zvec-ai/zvec-go) + + + + + +```bash +cargo add zvec-rust +``` + +- **预编译覆盖**：Linux x86_64 / ARM64、macOS ARM64、Windows x64 +- **代码仓库**：[zvec-ai/zvec-rust](https://github.com/zvec-ai/zvec-rust) + + + + + +```xml + + org.zvec + zvec-java + +``` + +- **预编译覆盖**：Linux x86_64 / ARM64（glibc 2.27 及以上）、macOS ARM64、Windows x64 +- **代码仓库**：[zvec-ai/zvec-java](https://github.com/zvec-ai/zvec-java) + + + + + +```bash +flutter pub add zvec +``` + +- **预编译覆盖**：Android arm64-v8a、iOS arm64、macOS ARM64、Linux x64、Windows x64 +- **代码仓库**：[zvec-ai/zvec-dart](https://github.com/zvec-ai/zvec-dart) + + + + + ## 支持的软硬件平台 From c68212756679d80b49401b1ea8eabc3585176204 Mon Sep 17 00:00:00 2001 From: lc285652 Date: Fri, 18 Sep 2026 10:53:36 +0800 Subject: [PATCH 4/5] docs: drop CI verification column from supported platforms table External readers care about whether prebuilt artifacts exist for their OS/arch; the CI details were internal-oriented density. The legend row still explains the check/cross marks, including RISC-V build-from-source. --- content/docs/en/db/platforms.mdx | 18 +++++++++--------- content/docs/zh/db/platforms.mdx | 18 +++++++++--------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/content/docs/en/db/platforms.mdx b/content/docs/en/db/platforms.mdx index 0934b0383..293615d82 100644 --- a/content/docs/en/db/platforms.mdx +++ b/content/docs/en/db/platforms.mdx @@ -88,15 +88,15 @@ flutter pub add zvec ## Supported Platforms -| Platform | Architectures | CI verification | Prebuilt artifacts | -| --- | --- | --- | --- | -| Linux (glibc) | x86_64, ARM64 | Full build and tests, plus a Clang compatibility matrix | ✅ | -| Linux (musl) | x86_64, ARM64 | Since v0.7.0 — covers Alpine and other musl distributions | ✅ | -| macOS | ARM64 (Apple Silicon), x86_64 (Intel) | ARM64 validated on macOS 15 and macOS 26; x86_64 built and tested on Intel runners | ✅ | -| Windows | x86_64 | Windows Server 2022 and 2025 | ✅ | -| Android | arm64-v8a | Unit tests actually run inside an x86_64 emulator | ✅ | -| iOS | arm64 | Simulator tests plus device builds | ✅ | -| RISC-V | riscv64 | Weekly full build and unit tests on native riscv64 runners | ❌ | +| Platform | Architectures | Prebuilt artifacts | +| --- | --- | --- | +| Linux (glibc) | x86_64, ARM64 | ✅ | +| Linux (musl) | x86_64, ARM64 | ✅ | +| macOS | ARM64 (Apple Silicon), x86_64 (Intel) | ✅ | +| Windows | x86_64 | ✅ | +| Android | arm64-v8a | ✅ | +| iOS | arm64 | ✅ | +| RISC-V | riscv64 | ❌ | *✅ = prebuilt artifacts published · ❌ = build from source.* diff --git a/content/docs/zh/db/platforms.mdx b/content/docs/zh/db/platforms.mdx index cb1ccad8b..5a7fcb918 100644 --- a/content/docs/zh/db/platforms.mdx +++ b/content/docs/zh/db/platforms.mdx @@ -88,15 +88,15 @@ flutter pub add zvec ## 支持的软硬件平台 -| 平台 | 架构 | CI 验证 | 预编译产物 | -| --- | --- | --- | --- | -| Linux（glibc） | x86_64、ARM64 | 完整构建与测试，另有 Clang 编译器兼容矩阵 | ✅ | -| Linux（musl） | x86_64、ARM64 | 自 v0.7.0 起，覆盖 Alpine 等 musl 发行版 | ✅ | -| macOS | ARM64（Apple Silicon）、x86_64（Intel） | ARM64 在 macOS 15 与 macOS 26 双版本验证；x86_64 在 Intel runner 上构建并测试 | ✅ | -| Windows | x86_64 | Windows Server 2022 与 2025 | ✅ | -| Android | arm64-v8a | 在 x86_64 模拟器中实际运行单元测试 | ✅ | -| iOS | arm64 | 跑模拟器测试并产出真机构建 | ✅ | -| RISC-V | riscv64 | 每周在原生 riscv64 runner 上完整构建并运行单元测试 | ❌ | +| 平台 | 架构 | 预编译产物 | +| --- | --- | --- | +| Linux（glibc） | x86_64、ARM64 | ✅ | +| Linux（musl） | x86_64、ARM64 | ✅ | +| macOS | ARM64（Apple Silicon）、x86_64（Intel） | ✅ | +| Windows | x86_64 | ✅ | +| Android | arm64-v8a | ✅ | +| iOS | arm64 | ✅ | +| RISC-V | riscv64 | ❌ | *✅ = 提供预编译产物 · ❌ = 需源码构建。* From 5cb1349c5fc8e5708510cfa804a1764fa982451a Mon Sep 17 00:00:00 2001 From: lc285652 Date: Wed, 23 Sep 2026 10:36:58 +0800 Subject: [PATCH 5/5] docs: address platform support review feedback (en/zh) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - per-SDK prebuilt coverage as bullet points per platform - repository entries shown as raw URLs - add C / C++ tab with prebuilt SDK archive install example - drop the ✅/❌ legend sentences; RISC-V row carries an inline build-from-source note instead - rename Android arm64 to arm64-v8a in the index matrix - collapse the index availability matrix behind an accordion so the default view stays language + install + platforms --- content/docs/en/db/platforms.mdx | 105 +++++++++++++++++++++---------- content/docs/zh/db/platforms.mdx | 105 +++++++++++++++++++++---------- 2 files changed, 146 insertions(+), 64 deletions(-) diff --git a/content/docs/en/db/platforms.mdx b/content/docs/en/db/platforms.mdx index 293615d82..92ccfef20 100644 --- a/content/docs/en/db/platforms.mdx +++ b/content/docs/en/db/platforms.mdx @@ -6,12 +6,13 @@ icon: MonitorSmartphone import { Cpu, HardDrive, Rocket, SearchCode } from 'lucide-react'; import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; ## Language SDKs All SDKs share one stable C API boundary — pick your language to see the install command and prebuilt platform coverage. - + @@ -19,9 +20,12 @@ All SDKs share one stable C API boundary — pick your language to see the insta pip install zvec ``` -- **Prebuilt coverage**: manylinux x86_64 / ARM64, musllinux x86_64 / ARM64, macOS ARM64, Windows x64 +- **Prebuilt coverage**: + - Linux x86_64 / ARM64 (glibc and musl) + - macOS ARM64 + - Windows x64 - **Requirements**: 64-bit Python 3.10–3.14 -- **Repository**: [alibaba/zvec · `python/`](https://github.com/alibaba/zvec/tree/main/python) +- **Repository**: [https://github.com/alibaba/zvec/tree/main/python](https://github.com/alibaba/zvec/tree/main/python) @@ -31,8 +35,11 @@ pip install zvec npm install @zvec/zvec ``` -- **Prebuilt coverage**: Linux x86_64 / ARM64 (glibc and musl), macOS ARM64 / x64, Windows x64 -- **Repository**: [zvec-ai/zvec-node](https://github.com/zvec-ai/zvec-node) +- **Prebuilt coverage**: + - Linux x86_64 / ARM64 (glibc and musl) + - macOS ARM64 / x64 + - Windows x64 +- **Repository**: [https://github.com/zvec-ai/zvec-node](https://github.com/zvec-ai/zvec-node) @@ -42,8 +49,11 @@ npm install @zvec/zvec go get github.com/zvec-ai/zvec-go ``` -- **Prebuilt coverage**: Linux x64 / ARM64, macOS ARM64, Windows x64 -- **Repository**: [zvec-ai/zvec-go](https://github.com/zvec-ai/zvec-go) +- **Prebuilt coverage**: + - Linux x64 / ARM64 + - macOS ARM64 + - Windows x64 +- **Repository**: [https://github.com/zvec-ai/zvec-go](https://github.com/zvec-ai/zvec-go) @@ -53,8 +63,11 @@ go get github.com/zvec-ai/zvec-go cargo add zvec-rust ``` -- **Prebuilt coverage**: Linux x86_64 / ARM64, macOS ARM64, Windows x64 -- **Repository**: [zvec-ai/zvec-rust](https://github.com/zvec-ai/zvec-rust) +- **Prebuilt coverage**: + - Linux x86_64 / ARM64 + - macOS ARM64 + - Windows x64 +- **Repository**: [https://github.com/zvec-ai/zvec-rust](https://github.com/zvec-ai/zvec-rust) @@ -67,8 +80,11 @@ cargo add zvec-rust ``` -- **Prebuilt coverage**: Linux x86_64 / ARM64 (glibc 2.27 or newer), macOS ARM64, Windows x64 -- **Repository**: [zvec-ai/zvec-java](https://github.com/zvec-ai/zvec-java) +- **Prebuilt coverage**: + - Linux x86_64 / ARM64 (glibc 2.27 or newer) + - macOS ARM64 + - Windows x64 +- **Repository**: [https://github.com/zvec-ai/zvec-java](https://github.com/zvec-ai/zvec-java) @@ -78,8 +94,30 @@ cargo add zvec-rust flutter pub add zvec ``` -- **Prebuilt coverage**: Android arm64-v8a, iOS arm64, macOS ARM64, Linux x64, Windows x64 -- **Repository**: [zvec-ai/zvec-dart](https://github.com/zvec-ai/zvec-dart) +- **Prebuilt coverage**: + - Android arm64-v8a + - iOS arm64 + - macOS ARM64 + - Linux x64 + - Windows x64 +- **Repository**: [https://github.com/zvec-ai/zvec-dart](https://github.com/zvec-ai/zvec-dart) + + + + + +```bash +# Pick the archive for your platform from the releases page +curl -LO https://github.com/alibaba/zvec/releases/latest/download/zvec-sdk-linux-amd64.tar.gz +``` + +- **Prebuilt coverage**: + - Linux x86_64 / ARM64 (glibc and musl) + - macOS ARM64 + - Windows x86_64 + - Android arm64-v8a + - iOS arm64 +- **Repository**: [https://github.com/alibaba/zvec](https://github.com/alibaba/zvec) @@ -96,29 +134,32 @@ flutter pub add zvec | Windows | x86_64 | ✅ | | Android | arm64-v8a | ✅ | | iOS | arm64 | ✅ | -| RISC-V | riscv64 | ❌ | +| RISC-V | riscv64 | ❌ (build from source) | -*✅ = prebuilt artifacts published · ❌ = build from source.* ## Index Availability -| Index | Linux x86_64 | Linux ARM64 | macOS ARM64 | Windows x86_64 | Android arm64 | iOS arm64 | RISC-V | -| --- | :-: | :-: | :-: | :-: | :-: | :-: | :-: | -| [Flat](../concepts/vector-index/flat-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| [IVF](../concepts/vector-index/ivf-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| [HNSW](../concepts/vector-index/hnsw-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| [Vamana](../concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| Sparse vectors (Flat / HNSW) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| RaBitQ ([HNSW](../concepts/vector-index/hnsw-rabitq-index/) / [IVF](../concepts/vector-index/ivf-rabitq-index/)) | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | -| [DiskANN](../concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | -| [INVERT](../concepts/inverted-index/) (scalar) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| [FTS](../concepts/fts-index/) (full-text) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | - -*✅ = available on that platform · ❌ = not available.* - - - **RaBitQ** requires AVX2 and AVX-512, which is why it is limited to Linux x86_64 today. - + + + + | Index | Linux x86_64 | Linux ARM64 | macOS ARM64 | Windows x86_64 | Android arm64-v8a | iOS arm64 | RISC-V | + | --- | :-: | :-: | :-: | :-: | :-: | :-: | :-: | + | [Flat](../concepts/vector-index/flat-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | + | [IVF](../concepts/vector-index/ivf-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | + | [HNSW](../concepts/vector-index/hnsw-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | + | [Vamana](../concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | + | Sparse vectors (Flat / HNSW) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | + | RaBitQ ([HNSW](../concepts/vector-index/hnsw-rabitq-index/) / [IVF](../concepts/vector-index/ivf-rabitq-index/)) | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | + | [DiskANN](../concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | + | [INVERT](../concepts/inverted-index/) (scalar) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | + | [FTS](../concepts/fts-index/) (full-text) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | + + + **RaBitQ** requires AVX2 and AVX-512, which is why it is limited to Linux x86_64 today. + + + + ## Related diff --git a/content/docs/zh/db/platforms.mdx b/content/docs/zh/db/platforms.mdx index 5a7fcb918..4e177cf7a 100644 --- a/content/docs/zh/db/platforms.mdx +++ b/content/docs/zh/db/platforms.mdx @@ -6,12 +6,13 @@ icon: MonitorSmartphone import { Cpu, HardDrive, Rocket, SearchCode } from 'lucide-react'; import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; +import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; ## 语言 SDK 所有 SDK 共享同一条稳定的 C API 边界——选择你的语言，查看安装命令与预编译产物覆盖。 - + @@ -19,9 +20,12 @@ import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; pip install zvec ``` -- **预编译覆盖**：manylinux x86_64 / ARM64、musllinux x86_64 / ARM64、macOS ARM64、Windows x64 +- **预编译覆盖**： + - Linux x86_64 / ARM64（glibc 与 musl） + - macOS ARM64 + - Windows x64 - **版本要求**：64 位 Python 3.10–3.14 -- **代码仓库**：[alibaba/zvec · `python/`](https://github.com/alibaba/zvec/tree/main/python) +- **代码仓库**：[https://github.com/alibaba/zvec/tree/main/python](https://github.com/alibaba/zvec/tree/main/python) @@ -31,8 +35,11 @@ pip install zvec npm install @zvec/zvec ``` -- **预编译覆盖**：Linux x86_64 / ARM64（glibc 与 musl）、macOS ARM64 / x64、Windows x64 -- **代码仓库**：[zvec-ai/zvec-node](https://github.com/zvec-ai/zvec-node) +- **预编译覆盖**： + - Linux x86_64 / ARM64（glibc 与 musl） + - macOS ARM64 / x64 + - Windows x64 +- **代码仓库**：[https://github.com/zvec-ai/zvec-node](https://github.com/zvec-ai/zvec-node) @@ -42,8 +49,11 @@ npm install @zvec/zvec go get github.com/zvec-ai/zvec-go ``` -- **预编译覆盖**：Linux x64 / ARM64、macOS ARM64、Windows x64 -- **代码仓库**：[zvec-ai/zvec-go](https://github.com/zvec-ai/zvec-go) +- **预编译覆盖**： + - Linux x64 / ARM64 + - macOS ARM64 + - Windows x64 +- **代码仓库**：[https://github.com/zvec-ai/zvec-go](https://github.com/zvec-ai/zvec-go) @@ -53,8 +63,11 @@ go get github.com/zvec-ai/zvec-go cargo add zvec-rust ``` -- **预编译覆盖**：Linux x86_64 / ARM64、macOS ARM64、Windows x64 -- **代码仓库**：[zvec-ai/zvec-rust](https://github.com/zvec-ai/zvec-rust) +- **预编译覆盖**： + - Linux x86_64 / ARM64 + - macOS ARM64 + - Windows x64 +- **代码仓库**：[https://github.com/zvec-ai/zvec-rust](https://github.com/zvec-ai/zvec-rust) @@ -67,8 +80,11 @@ cargo add zvec-rust ``` -- **预编译覆盖**：Linux x86_64 / ARM64（glibc 2.27 及以上）、macOS ARM64、Windows x64 -- **代码仓库**：[zvec-ai/zvec-java](https://github.com/zvec-ai/zvec-java) +- **预编译覆盖**： + - Linux x86_64 / ARM64（glibc 2.27 及以上） + - macOS ARM64 + - Windows x64 +- **代码仓库**：[https://github.com/zvec-ai/zvec-java](https://github.com/zvec-ai/zvec-java) @@ -78,8 +94,30 @@ cargo add zvec-rust flutter pub add zvec ``` -- **预编译覆盖**：Android arm64-v8a、iOS arm64、macOS ARM64、Linux x64、Windows x64 -- **代码仓库**：[zvec-ai/zvec-dart](https://github.com/zvec-ai/zvec-dart) +- **预编译覆盖**： + - Android arm64-v8a + - iOS arm64 + - macOS ARM64 + - Linux x64 + - Windows x64 +- **代码仓库**：[https://github.com/zvec-ai/zvec-dart](https://github.com/zvec-ai/zvec-dart) + + + + + +```bash +# 从 Releases 页选择对应平台的 SDK 压缩包 +curl -LO https://github.com/alibaba/zvec/releases/latest/download/zvec-sdk-linux-amd64.tar.gz +``` + +- **预编译覆盖**： + - Linux x86_64 / ARM64（glibc 与 musl） + - macOS ARM64 + - Windows x86_64 + - Android arm64-v8a + - iOS arm64 +- **代码仓库**：[https://github.com/alibaba/zvec](https://github.com/alibaba/zvec) @@ -96,29 +134,32 @@ flutter pub add zvec | Windows | x86_64 | ✅ | | Android | arm64-v8a | ✅ | | iOS | arm64 | ✅ | -| RISC-V | riscv64 | ❌ | +| RISC-V | riscv64 | ❌（需源码构建） | -*✅ = 提供预编译产物 · ❌ = 需源码构建。* ## 索引可用性矩阵 -| 索引 | Linux x86_64 | Linux ARM64 | macOS ARM64 | Windows x86_64 | Android arm64 | iOS arm64 | RISC-V | -| --- | :-: | :-: | :-: | :-: | :-: | :-: | :-: | -| [Flat](../concepts/vector-index/flat-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| [IVF](../concepts/vector-index/ivf-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| [HNSW](../concepts/vector-index/hnsw-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| [Vamana](../concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| 稀疏向量（Flat / HNSW） | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| RaBitQ（[HNSW](../concepts/vector-index/hnsw-rabitq-index/) / [IVF](../concepts/vector-index/ivf-rabitq-index/)） | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | -| [DiskANN](../concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | -| [INVERT](../concepts/inverted-index/)（标量倒排） | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | -| [FTS](../concepts/fts-index/)（全文检索） | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | - -*✅ = 该平台可用 · ❌ = 不支持。* - - - **RaBitQ** 依赖 AVX2 与 AVX-512，因此目前仅支持 Linux x86_64。 - + + + + | 索引 | Linux x86_64 | Linux ARM64 | macOS ARM64 | Windows x86_64 | Android arm64-v8a | iOS arm64 | RISC-V | + | --- | :-: | :-: | :-: | :-: | :-: | :-: | :-: | + | [Flat](../concepts/vector-index/flat-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | + | [IVF](../concepts/vector-index/ivf-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | + | [HNSW](../concepts/vector-index/hnsw-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | + | [Vamana](../concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | + | 稀疏向量（Flat / HNSW） | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | + | RaBitQ（[HNSW](../concepts/vector-index/hnsw-rabitq-index/) / [IVF](../concepts/vector-index/ivf-rabitq-index/)） | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | + | [DiskANN](../concepts/vector-index/diskann-index/) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | + | [INVERT](../concepts/inverted-index/)（标量倒排） | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | + | [FTS](../concepts/fts-index/)（全文检索） | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | + + + **RaBitQ** 依赖 AVX2 与 AVX-512，因此目前仅支持 Linux x86_64。 + + + + ## 相关阅读