Skip to content

Commit

Permalink
Fix document errors (#1464)
Browse files Browse the repository at this point in the history
### What problem does this PR solve?

Fix document errors 

### Type of change

- [x] Documentation Update
  • Loading branch information
zjbpaul1317 authored Jul 10, 2024
1 parent b1b2e5e commit f594d22
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/references/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
4 changes: 2 additions & 2 deletions docs/references/benchmark.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/references/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down
4 changes: 2 additions & 2 deletions docs/references/pysdk_api_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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, \<dimision>\, \<datatype>\"`
A dict object whose key value pair indicates name of the column and its datatype. Especially, a vector column should be declared as `"vector, \<dimension>\, \<datatype>\"`
- **conflict_type : ConflictType** enum type defined in the `infinity.common` package:
- `Error`
- `Ignore`
Expand Down

0 comments on commit f594d22

Please sign in to comment.