From 6501f1230ad9581b7f8edd681fb2175f3708c5f9 Mon Sep 17 00:00:00 2001 From: wehub-resource-sync Date: Mon, 13 Jul 2026 10:45:39 +0000 Subject: [PATCH] docs: make Chinese README the default --- README.md | 120 +++++++++++++++++++++++++++--------------------------- 1 file changed, 61 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index ed27ba2..82039e9 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ + +> [!NOTE] +> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。 +> [English](./README.en.md) · [原始项目](https://github.com/alibaba/zvec) · [上游 README](https://github.com/alibaba/zvec/blob/HEAD/README.md) +> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。 +

- English | 中文 + English | 中文

@@ -10,12 +16,12 @@

- Code Coverage + 代码覆盖率 Main - License - PyPI Release - Python Versions - npm Release + 许可证 + PyPI 版本 + Python 版本 + npm 版本

@@ -23,115 +29,111 @@

- 🚀 Quickstart | - 🏠 Home | - 📚 Docs | - 📊 Benchmarks | + 🚀 快速开始 | + 🏠 主页 | + 📚 文档 | + 📊 性能报告 | 🔎 DeepWiki | 🎮 Discord | 🐦 X (Twitter)

-**Zvec** is an open-source, in-process vector database — lightweight, lightning-fast, and designed to embed directly into applications. Battle-tested within Alibaba Group, it delivers production-grade, low-latency and scalable similarity search with minimal setup. +**Zvec** 是一款开源的嵌入式(进程内)向量数据库 — 轻量、极速，可直接嵌入应用程序。以极简的配置提供生产级、低延迟、可扩展的向量检索能力。 -> [!Important] -> 🚀 **v0.5.0 (June 12, 2026)** +> [!IMPORTANT] +> 🚀 **v0.5.0（2026 年 6 月 12 日）** > -> - **Full-Text Search (FTS)**: Native full-text search — attach an FTS index to any string field and query it with natural-language or structured expressions, no external search engine required. -> - **Hybrid Retrieval**: Combine full-text and vector search in a single `MultiQuery` across dense vectors, sparse vectors, scalar filters, and text. -> - **DiskANN Index**: New on-disk index that keeps the bulk of the index on disk, drastically cutting memory usage for large-scale datasets. -> - **Ecosystem & Platforms**: New official [Go](https://github.com/zvec-ai/zvec-go) / [Rust](https://github.com/zvec-ai/zvec-rust) SDKs, the [Zvec Studio](https://github.com/zvec-ai/zvec-studio) visual tool, and RISC-V support. +> - **全文检索（FTS）**：原生全文检索能力——可为任意字符串字段挂载 FTS 索引，使用自然语言或结构化表达式检索，无需外接搜索引擎。 +> - **混合检索**：在单次 `MultiQuery` 中融合全文与向量检索，跨稠密向量、稀疏向量、标量过滤与文本。 +> - **DiskANN 索引**：全新磁盘索引，将索引主体存于磁盘，大幅降低大规模数据集的内存占用。 +> - **生态与平台**：全新官方 [Go](https://github.com/zvec-ai/zvec-go) / [Rust](https://github.com/zvec-ai/zvec-rust) SDK、可视化工具 [Zvec Studio](https://github.com/zvec-ai/zvec-studio)，以及 RISC-V 架构支持。 > -> 👉 [Read the Release Notes](https://github.com/alibaba/zvec/releases/tag/v0.5.0) | [View Roadmap 📍](https://github.com/alibaba/zvec/issues/309) +> 👉 [查看更新日志](https://github.com/alibaba/zvec/releases/tag/v0.5.0) | [查看路线图 📍](https://github.com/alibaba/zvec/issues/309) -## 💫 Features +## 💫 核心特性 -- **Blazing Fast**: Searches billions of vectors in milliseconds. -- **Simple, Just Works**: [Install](#-installation) and start searching in seconds. Pure local, no servers, no config, no fuss. -- **Dense + Sparse Vectors**: Support dense and sparse embeddings, multi-vector queries, and a rich selection of [vector index types](https://zvec.org/en/docs/db/concepts/vector-index/#vector-index-types) that scale from memory to disk. -- **Full-Text Search (FTS)**: Native keyword-based full-text search — query string fields with natural-language or structured expressions. -- **Hybrid Search**: Fuse vector similarity, full-text search, and structured filters in a single query for precise results. -- **Durable Storage**: Write-ahead logging (WAL) guarantees persistence — data is never lost, even on process crash or power failure. -- **Concurrent Access**: Multiple processes can read the same collection simultaneously; writes are single-process exclusive. -- **Runs Anywhere**: As an in-process library, Zvec runs wherever your code runs — notebooks, servers, CLI tools, or even edge devices. +- **极致性能**：毫秒级响应，轻松检索数十亿级向量。 +- **开箱即用**：[安装](#-安装)后即刻开始搜索，纯本地运行，无需服务器、无需配置、零门槛。 +- **稠密 + 稀疏向量**：支持稠密向量、稀疏向量与多向量查询，以及从内存到磁盘、丰富多样的[向量索引类型](https://zvec.org/zh/docs/db/concepts/vector-index/#向量索引类型)。 +- **全文检索（FTS）**：原生的基于关键词的全文检索——使用自然语言或结构化表达式检索字符串字段。 +- **混合检索**：在单次查询中融合向量语义、全文检索与标量过滤，获得精确结果。 +- **持久化存储**：WAL 预写日志保障数据持久性 — 即使进程崩溃或意外断电，数据也不会丢失。 +- **并发访问**：支持多进程同时读取同一个 Collection；写入为单进程独占模式。 +- **进程内运行**：无需单独部署服务，纯进程内运行。Notebook、高性能服务器、CLI 工具、边缘设备 — 随处可用。 -## 📦 Installation +## 📦 安装 -Zvec offers official SDKs across multiple languages: +Zvec 提供多语言官方 SDK： -- **[Python](https://pypi.org/project/zvec/)**: `pip install zvec` (requires Python 3.10–3.14) -- **[Node.js](https://www.npmjs.com/package/@zvec/zvec)**: `npm install @zvec/zvec` -- **[Go](https://github.com/zvec-ai/zvec-go)**: High-performance Go bindings. -- **[Rust](https://github.com/zvec-ai/zvec-rust)**: High-performance Rust bindings. -- **[Dart/Flutter](https://pub.dev/packages/zvec)**: `flutter pub add zvec` +- **[Python](https://pypi.org/project/zvec/)**：`pip install zvec`（需 64 位 Python 3.10–3.14） +- **[Node.js](https://www.npmjs.com/package/@zvec/zvec)**：`npm install @zvec/zvec` +- **[Go](https://github.com/zvec-ai/zvec-go)**：高性能的 Go 绑定。 +- **[Rust](https://github.com/zvec-ai/zvec-rust)**：高性能的 Rust 绑定。 +- **[Dart/Flutter](https://pub.dev/packages/zvec)**：`flutter pub add zvec` -Prefer a visual tool? Try **[Zvec Studio](https://github.com/zvec-ai/zvec-studio)** to browse data and debug queries — no code required. +想要图形界面？试试 **[Zvec Studio](https://github.com/zvec-ai/zvec-studio)**，零代码浏览数据与调试查询。 -### ✅ Supported Platforms +### ✅ 支持的平台 - Linux (x86_64, ARM64) - macOS (ARM64) - Windows (x86_64) -### 🛠️ Building from Source +### 🛠️ 源码构建 -If you prefer to build Zvec from source, please check the [Building from Source](https://zvec.org/en/docs/db/build/) guide. +如需从源码构建 Zvec，请参考[源码构建指南](https://zvec.org/zh/docs/db/build/)。 -## ⚡ One-Minute Example +## ⚡ 一分钟上手 ```python import zvec -# Define collection schema +# 定义 collection schema schema = zvec.CollectionSchema( name="example", vectors=zvec.VectorSchema("embedding", zvec.DataType.VECTOR_FP32, 4), ) -# Create collection +# 创建 collection collection = zvec.create_and_open(path="./zvec_example", schema=schema) -# Insert documents +# 插入 documents collection.insert([ zvec.Doc(id="doc_1", vectors={"embedding": [0.1, 0.2, 0.3, 0.4]}), zvec.Doc(id="doc_2", vectors={"embedding": [0.2, 0.3, 0.4, 0.1]}), ]) -# Search by vector similarity +# 向量相似度检索 results = collection.query( zvec.Query(field_name="embedding", vector=[0.4, 0.3, 0.3, 0.1]), topk=10 ) -# Results: list of {'id': str, 'score': float, ...}, sorted by relevance +# 查询结果：按相关性排序的 {'id': str, 'score': float, ...} 列表 print(results) ``` -## 📈 Performance at Scale +## 📈 极致性能 -Zvec delivers exceptional speed and efficiency, making it ideal for demanding production workloads. +Zvec 提供极致的速度和效率，能够轻松应对高要求的生产环境负载。 -Zvec Performance Benchmarks +Zvec 性能基准测试 -For detailed benchmark methodology, configurations, and complete results, please see our [Benchmarks documentation](https://zvec.org/en/docs/db/benchmarks/). +有关具体的测试方法、配置及完整结果，请参阅[性能报告](https://zvec.org/zh/docs/db/benchmarks/)。 -## 🤝 Join Our Community +## 🤝 加入社区
-
- -| 💬 DingTalk | 📱 WeChat | 🎮 Discord | X (Twitter) | +| 💬 钉钉群 | 📱 微信群 | 🎮 Discord | X (Twitter) | | :---: | :---: | :---: | :---: | -| DingTalk QR Code | WeChat QR Code | [![Discord](https://img.shields.io/badge/Discord-Join%20Server-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/rKddFBBu9z) | [![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/ZvecAI)]() | -| Scan to join | Scan to join | Click to join | Click to follow | +| 钉钉二维码 | 微信二维码 | [![Discord](https://img.shields.io/badge/Discord-Join%20Server-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/rKddFBBu9z) | [![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/ZvecAI)]() | +| 扫码加入 | 扫码加入 | 点击加入 | 点击关注 |
-
+## ❤️ 参与贡献 -## ❤️ Contributing +非常欢迎来自社区的每一份贡献！无论是修复 Bug、新增功能，还是完善文档，都将让 Zvec 变得更好。 -We welcome and appreciate contributions from the community! Whether you're fixing a bug, adding a feature, or improving documentation, your help makes Zvec better for everyone. - -Check out our [Contributing Guide](./CONTRIBUTING.md) to get started! +请查阅我们的[贡献指南](./CONTRIBUTING.md)开始参与！