From dd2832686e100bb7aec510cc403d0959a8326a8d Mon Sep 17 00:00:00 2001 From: Jin Hai Date: Fri, 31 May 2024 20:59:20 +0800 Subject: [PATCH] Update Documents (#1268) ### What problem does this PR solve? _Briefly describe what this PR aims to solve. Include background context that will help reviewers understand the purpose of the PR._ ### Type of change - [x] Documentation Update --------- Signed-off-by: Jin Hai --- README.md | 35 +++++++++++++++------------ docs/getstarted/quickstart.md | 7 +----- docs/references/faq.md | 2 +- docs/references/http_api_reference.md | 2 +- 4 files changed, 22 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 6965da203c..77da3b1015 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,10 @@

- Roadmap 2024 | + Document | + Benchmark | Twitter | - Discord | - YouTube | + Discord

@@ -19,6 +19,7 @@ Infinity is a cutting-edge AI-native database that provides a wide range of sear - [Key Features](#-key-features) - [Get Started](#-get-started) +- [Document](#-document) - [Roadmap](#-roadmap) - [Community](#-community) @@ -29,10 +30,10 @@ Infinity comes with high performance, flexibility, ease-of-use, and many feature ### ⚡️ Incredibly fast -- Achieves 0.1 milliseconds query latency on million-scale vector datasets. -- Up to 15K QPS on million-scale vector datasets. +- Achieves 0.1 milliseconds query latency and 15K+ QPS on million-scale vector datasets. +- Achieves 1 millisecond latency and 12K+ QPS in full-text search on 33M documents. -> See the [Benchmark report](./docs/references/benchmark.md) for more information. +> See the [Benchmark report](https://infiniflow.org/docs/dev/benchmark) for more information. ### 🔮 Fused search @@ -45,7 +46,7 @@ Supports a wide range of data types including strings, numerics, vectors, and mo ### 🎁 Ease-of-use -- Intuitive Python API. See the [Python API](docs/references/pysdk_api_reference.md) +- Intuitive Python API. See the [Python API](https://infiniflow.org/docs/dev/python_api_reference) - A single-binary architecture with no dependencies, making deployment a breeze. ## 🎮 Get Started @@ -77,7 +78,7 @@ sudo systemctl start infinity ``` #### 🛠️ Build from Source -See [Build from Source](docs/getstarted/build_from_source.md). +See [Build from Source](https://infiniflow.org/docs/dev/build_from_source). ### Install Infinity's Python client @@ -118,12 +119,7 @@ db = infinity_obj.get_database("default_db") # Drop my_table if it already exists db.drop_table("my_table", ConflictType.Ignore) # Create a table named "my_table" -table = db.create_table( - "my_table", { - "num": {"type": "integer"}, - "body": {"type": "varchar"}, - "vec": {"type": "vector, 4, float"} - }) +table = db.create_table("my_table", {"num": {"type": "integer"}, "body": {"type": "varchar"}, "vec": {"type": "vector, 4, float"}}) ``` @@ -142,8 +138,15 @@ res = table.output(["*"]).knn("vec", [3.0, 2.8, 2.7, 3.1], "float", "ip", 2).to_ print(res) ``` -> 💡 For more information about the Python API, see the [Python API Reference](docs/references/pysdk_api_reference.md). +> 💡 For more information about the Python API, see the [Python API Reference](https://infiniflow.org/docs/dev/python_api_reference). +## Document + +- [Quickstart](https://infiniflow.org/docs/dev/) +- [Python API](https://infiniflow.org/docs/dev/python_api_reference) +- [HTTP API](https://infiniflow.org/docs/dev/http_api_reference) +- [Reference](https://ragflow.io/docs/dev/category/references) +- [FAQ](https://ragflow.io/docs/dev/faq) ## 📜 Roadmap @@ -154,4 +157,4 @@ See the [Infinity Roadmap 2024](https://github.com/infiniflow/infinity/issues/33 - [Discord](https://discord.gg/jEfRUwEYEV) - [Twitter](https://twitter.com/infiniflowai) - [GitHub Discussions](https://github.com/infiniflow/infinity/discussions) -- [YouTube](https://www.youtube.com/@InfiniFlow-AI) + diff --git a/docs/getstarted/quickstart.md b/docs/getstarted/quickstart.md index 7acea18bf1..fad2826963 100644 --- a/docs/getstarted/quickstart.md +++ b/docs/getstarted/quickstart.md @@ -76,12 +76,7 @@ db = infinity_obj.get_database("default_db") # Drop my_table if it already exists db.drop_table("my_table", ConflictType.Ignore) # Create a table named "my_table" -table = db.create_table( - "my_table", { - "num": {"type": "integer"}, - "body": {"type": "varchar"}, - "vec": {"type": "vector, 4, float"} - }) +table = db.create_table("my_table", {"num": {"type": "integer"}, "body": {"type": "varchar"}, "vec": {"type": "vector, 4, float"}}) ``` ## Insert two records diff --git a/docs/references/faq.md b/docs/references/faq.md index 589bd1c111..f10206de38 100644 --- a/docs/references/faq.md +++ b/docs/references/faq.md @@ -3,7 +3,7 @@ sidebar_position: 2 slug: /FAQ --- -## Extensive Reading: Frequently Asked Questions +# Frequently asked questions ## What is Retrieval-Augmented Generation? diff --git a/docs/references/http_api_reference.md b/docs/references/http_api_reference.md index a4c809770a..a26c8d76d3 100644 --- a/docs/references/http_api_reference.md +++ b/docs/references/http_api_reference.md @@ -1,6 +1,6 @@ --- sidebar_position: 3 -slug: /html_api_reference +slug: /http_api_reference --- # HTTP API Reference