Skip to content

Commit 8612ef4

Browse files
committed
fix in comments
Signed-off-by: xieydd <[email protected]>
1 parent 470b761 commit 8612ef4

File tree

4 files changed

+14
-6
lines changed

4 files changed

+14
-6
lines changed

src/vectorchord/getting-started/vectorchord-suite.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,17 @@ The suite comprises three key PostgreSQL extensions working in concert:
1616

1717
2. [**VectorChord-bm25:**](https://github.com/tensorchord/VectorChord-bm25) This extension implements the sophisticated BM25 ranking algorithm directly inside PostgreSQL, leveraging efficient Block-WeakAnd algorithms. BM25 is a standard for relevance ranking based on keyword frequency and document characteristics.
1818

19-
3. [**pg\_**](https://github.com/tensorchord/pg_tokenizer.rs)[**tokenizer.rs**](http://tokenizer.rs)[**:**](https://github.com/tensorchord/pg_tokenizer.rs) Provides essential text tokenization capabilities needed for effective full-text search, enabling fine-grained control over how text is processed for full-text search.
19+
3. [**pg_tokenizer.rs:**](https://github.com/tensorchord/pg_tokenizer.rs) Provides essential text tokenization capabilities needed for effective full-text search, enabling fine-grained control over how text is processed for full-text search.
2020

2121

2222
By combining these extensions, you unlock powerful capabilities for building advanced RAG systems entirely within PostgreSQL.
2323

2424
## How to Use the VectorChord Suite
2525

2626
You can use the `tensorchord/vchord-suite` Docker image to run multiple extensions which are provided by TensorChord. The image is based on the Docker official PostgreSQL image and includes the following extensions:
27+
- `vchord`
28+
- `pg_tokenizer`
29+
- `vchord_bm25`
2730

2831
```powershell
2932
docker run \

src/vectorchord/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,21 @@
44

55
- [Overview](/vectorchord/getting-started/overview)
66
- [Installation](/vectorchord/getting-started/installation)
7+
- [VectorChord Suite](/vectorchord/getting-started/vectorchord-suite)
78

89
## Usage
910

1011
- [Indexing](/vectorchord/usage/indexing)
1112
- [Indexing with MaxSim Operators](/vectorchord/usage/indexing-with-maxsim-operators)
1213
- [Search](/vectorchord/usage/search)
13-
- [Advanced Features](/vectorchord/usage/advanced-features)
1414
- [Performance Tuning](/vectorchord/usage/performance-tuning)
15+
- [Advanced Features](/vectorchord/usage/advanced-features)
1516

1617
## Use Cases
1718

1819
- [Hybrid Search](/vectorchord/use-case/hybrid-search)
1920
- [ColBERT Rerank](/vectorchord/use-case/colbert-rerank)
21+
- [ColQwen2 & Modal](/vectorchord/use-case/colqwen2-modal)
2022

2123
## Admin
2224

src/vectorchord/usage/indexing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ The following parameters are available:
8282
- `build.internal.lists = []` means that the vector space is not partitioned.
8383
- `build.internal.lists = [4096]` means the vector space is divided into $4096$ cells.
8484
- `build.internal.lists = [4096, 262144]` means the vector space is divided into $4096$ cells, and those cells are further divided into $262144$ smaller cells.
85-
- Note: The index partitions the vector space into multiple Voronoi cells using centroids, iteratively creating a hierarchical space partition tree. Each leaf node in this tree represents a region with an associated list storing vectors in that region. During insertion, vectors are placed in lists corresponding to their appropriate leaf nodes. For queries, the index optimizes search by excluding lists whose leaf nodes are distant from the query vector, effectively pruning the search space. The `lists` option should be no less than $4 * \sqrt{N}$, where $N$ is the number of vectors in the table.
85+
- Note: The index partitions the vector space into multiple Voronoi cells using centroids, iteratively creating a hierarchical space partition tree. Each leaf node in this tree represents a region with an associated list storing vectors in that region. During insertion, vectors are placed in lists corresponding to their appropriate leaf nodes. For queries, the index optimizes search by excluding lists whose leaf nodes are distant from the query vector, effectively pruning the search space. If the length of `lists` is 1,the `lists` option should be no less than $4 * \sqrt{N}$, where $N$ is the number of vectors in the table.
8686

8787
#### `build.internal.spherical_centroids`
8888

src/vectorchord/usage/search.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,15 @@ SELECT 1 FROM items WHERE category_id = 1 ORDER BY embedding <#> '[0.5,0.5,0.5]'
2828
#### `vchordrq.probes`
2929

3030
- Description: This GUC parameter `vchordrq.probes` controls how the vector space assists in query pruning. The more probes, the more accurate the search, but also the slower it is.
31-
- Type: integer
32-
- Default: `empty`
31+
- Type: List of integers
32+
- Default: `[]`
3333
- Example:
3434
- `SET vchordrq.probes = 1` means that only one probe is used.
3535
- `SET vchordrq.probes = 10` means that ten probes are used.
36-
- Note: The default value is `empty`, which means that only one probe is used. This is the fastest search, but also the least accurate. If you want to improve the accuracy of the search, you can increase the number of probes. However, this will also slow down the search.
36+
- Note: The default value is an empty list. The length of this option must match the length of `lists`.
37+
- If `lists = []`, then probes must be an empty list.
38+
- If `lists = [11, 22]`, then probes can be 2,4 or 4,8, but it must not be an empty list, `3`, `7,8,9`, or `5,5,5,5`.
39+
3740

3841
#### `vchordrq.epsilon`
3942

0 commit comments

Comments
 (0)