From f594d2204f75d77136a58cb0200fa68190e7f081 Mon Sep 17 00:00:00 2001 From: zjbpaul1317 <151290297+zjbpaul1317@users.noreply.github.com> Date: Wed, 10 Jul 2024 22:00:41 +0800 Subject: [PATCH] Fix document errors (#1464) ### What problem does this PR solve? Fix document errors ### Type of change - [x] Documentation Update --- docs/references/CONTRIBUTING.md | 2 +- docs/references/benchmark.md | 4 ++-- docs/references/faq.md | 2 +- docs/references/pysdk_api_reference.md | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/references/CONTRIBUTING.md b/docs/references/CONTRIBUTING.md index 1c5af79b38..248479bc84 100644 --- a/docs/references/CONTRIBUTING.md +++ b/docs/references/CONTRIBUTING.md @@ -5,7 +5,7 @@ slug: /contribution_guidelines # Contribution Guidelines -Thanks for wanting to contribute to Infinity. This document offers guidlines and major considerations for submitting your contributions. +Thanks for wanting to contribute to Infinity. This document offers guidelines and major considerations for submitting your contributions. - To report a bug, file a [GitHub issue](https://github.com/infiniflow/infinity/issues/new/choose) with us. - For further questions, you can explore existing discussions or initiate a new one in [Discussions](https://github.com/orgs/infiniflow/discussions). diff --git a/docs/references/benchmark.md b/docs/references/benchmark.md index 053d0b423c..d9bdd8eea7 100644 --- a/docs/references/benchmark.md +++ b/docs/references/benchmark.md @@ -12,9 +12,9 @@ This document compares the following key specifications of Elasticsearch, Qdrant You need to watch resource (persisted index size, peak memory, peak cpu, system load etc.) manually. -Keep the environment clean to ensure that the database under test is able to use up all resource of the system. +Keep the environment clean to ensure that the database under test is able to use up all resources of the system. -Avoid to run multiple databases at the same time, as each one is a significant resource consumer. +Avoid running multiple databases at the same time, as each one is a significant resource consumer. Test environment: diff --git a/docs/references/faq.md b/docs/references/faq.md index f10206de38..9e37bbf6e5 100644 --- a/docs/references/faq.md +++ b/docs/references/faq.md @@ -17,7 +17,7 @@ RAG enables the retrieval of external data from a variety of sources, including Hybrid search combines text and semantic (vector) queries to find more accurate and relevant results. This technique combines multiple search algorithms, such as keyword search, natural language search, and semantic search, to enhance the accuracy of search results. -A hybrid search combines various search strategies, whilst a fused search goes a step further by taking over the decision-making process previously managed by the upper-level application. It merges the obtained results and returns the results by itself. +A hybrid search combines various search strategies, while a fused search goes a step further by taking over the decision-making process previously managed by the upper-level application. It merges the obtained results and returns the results by itself. ## What is an AI-native database? Is it just a paraphrase of vector database? diff --git a/docs/references/pysdk_api_reference.md b/docs/references/pysdk_api_reference.md index e8fc43e7d8..5250760ac3 100644 --- a/docs/references/pysdk_api_reference.md +++ b/docs/references/pysdk_api_reference.md @@ -37,7 +37,7 @@ Connect to the Infinity server and return an Infinity object. ## disconnect -**infinity.disconnet()** +**infinity.disconnect()** Disconnect the current Infinity object from the server. @@ -177,7 +177,7 @@ Create a table with a given name, defining each column in it. - **table_name : str(not empty)** Name of the table. - **columns_definition : dict[str, str]** -A dict object whose key value pair indicates name of the column and its datatype. Especially, a vector column should be declared as `"vector, \\, \\"` +A dict object whose key value pair indicates name of the column and its datatype. Especially, a vector column should be declared as `"vector, \\, \\"` - **conflict_type : ConflictType** enum type defined in the `infinity.common` package: - `Error` - `Ignore`