88
99[ Official Site] [ official-site-link ] · [ Blog] [ blog-link ] · [ Docs] [ docs-link ] · [ Feedback] [ github-issues-link ] · [ Contact Us] [ email-link ]
1010
11- <!-- TODO: Add GHCR when 0.3.0 is ready -->
1211
1312[ ![ ] [ github-release-shield ]] [ github-release-link ]
1413[ ![ ] [ docker-release-shield ]] [ docker-release-link ]
1514[ ![ ] [ docker-pulls-shield ]] [ docker-pulls-link ]
15+ [ ![ ] [ ghcr-release-shield ]] [ ghcr-release-link ]
16+ [ ![ ] [ github-downloads-shield ]] [ github-downloads-link ]
1617[ ![ ] [ discord-shield ]] [ discord-link ]
1718[ ![ ] [ X-shield ]] [ X-link ]
1819[ ![ ] [ cloud-shield ]] [ cloud-link ]
20+ [ ![ ] [ deepwiki-shield ]] [ deepwiki-link ]
1921[ ![ ] [ license-1-shield ]] [ license-1-link ]
2022[ ![ ] [ license-2-shield ]] [ license-2-link ]
2123</div >
@@ -65,7 +67,7 @@ docker run \
6567 --name vectorchord-demo \
6668 -e POSTGRES_PASSWORD=mysecretpassword \
6769 -p 5432:5432 \
68- -d ghcr.io/tensorchord/vchord-postgres:pg17-v0.3.0
70+ -d ghcr.io/tensorchord/vchord-postgres:pg17-v0.4.2
6971```
7072> [ !NOTE]
7173> In addition to the base image with the VectorChord extension, we provide an all-in-one image, ` tensorchord/vchord-suite:pg17-latest ` . This comprehensive image includes all official TensorChord extensions, including ` VectorChord ` , ` VectorChord-bm25 ` and ` pg_tokenizer.rs ` . Developers should select an image tag that is compatible with their extension's version, as indicated in [ the support matrix] ( https://github.com/tensorchord/VectorChord-images?tab=readme-ov-file#support-matrix ) .
@@ -101,16 +103,6 @@ lists = []
101103$$);
102104```
103105
104- > [ !NOTE]
105- > The ` lists ` option should be configured based on the number of vectors. Below is a table to assist with your selection.
106-
107- | vectors Range | List Calculation Formula | Example Result |
108- | ------------- | ------------------------------ | ---------------- |
109- | <128k | list = 1 | 1 |
110- | ≥128k and <2M | list = (2 * vectors) / 1000 | 256-4000 |
111- | ≥2M and <100M | list ∈ [ 4√vectors, 8√vectors] | 4000-80000 |
112- | ≥100M | list ∈ [ 8√vectors, 16√vectors] | 80000-160000 |
113-
114106And then perform a vector search using ` SELECT ... ORDER BY ... LIMIT ... ` .
115107
116108``` SQL
@@ -124,6 +116,19 @@ For more usage, please read:
124116* [ Performance Tuning] ( https://docs.vectorchord.ai/vectorchord/usage/performance-tuning.html )
125117* [ Advanced Features] ( https://docs.vectorchord.ai/vectorchord/usage/advanced-features.html )
126118
119+ > [ !NOTE]
120+ > The partition parameter, ` lists ` , should be configured based on the number of rows. The following table provides guidance for this selection. When searching, remember to set [ ` vchordrq.probes ` ] ( https://docs.vectorchord.ai/vectorchord/usage/search.html#vchordrq-probes ) based on the value of lists.
121+
122+
123+
124+ | Number of Rows $N$ | Recommended Number of Partitions $L$ | Example ` lists ` |
125+ | -------------------------------------- | ------------------------------------ | --------------- |
126+ | $N \in [ 0, 10^5)$ | N/A | ` [] ` |
127+ | $N \in [ 10^5, 2 \times 10^6)$ | $L = \frac{N}{500}$ | ` [2000] ` |
128+ | $N \in [ 2 \times 10^6, 5 \times 10^7)$ | $L \in [ 4 \sqrt{N}, 8 \sqrt{N}] $ | ` [10000] ` |
129+ | $N \in [ 5 \times 10^7, \infty)$ | $L \in [ 8 \sqrt{N}, 16\sqrt{N}] $ | ` [80000] ` |
130+
131+
127132## License
128133
129134This software is licensed under a dual license model:
@@ -141,19 +146,26 @@ You may choose either license based on your needs. We welcome any commercial col
141146[license-2-shield]: https://img.shields.io/badge/License-ELv2-green?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgd2lkdGg9IjI0IiBoZWlnaHQ9IjI0IiBmaWxsPSIjZmZmZmZmIj48cGF0aCBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik0xMi43NSAyLjc1YS43NS43NSAwIDAwLTEuNSAwVjQuNUg5LjI3NmExLjc1IDEuNzUgMCAwMC0uOTg1LjMwM0w2LjU5NiA1Ljk1N0EuMjUuMjUgMCAwMTYuNDU1IDZIMi4zNTNhLjc1Ljc1IDAgMTAwIDEuNUgzLjkzTC41NjMgMTUuMThhLjc2Mi43NjIgMCAwMC4yMS44OGMuMDguMDY0LjE2MS4xMjUuMzA5LjIyMS4xODYuMTIxLjQ1Mi4yNzguNzkyLjQzMy42OC4zMTEgMS42NjIuNjIgMi44NzYuNjJhNi45MTkgNi45MTkgMCAwMDIuODc2LS42MmMuMzQtLjE1NS42MDYtLjMxMi43OTItLjQzMy4xNS0uMDk3LjIzLS4xNTguMzEtLjIyM2EuNzUuNzUgMCAwMC4yMDktLjg3OEw1LjU2OSA3LjVoLjg4NmMuMzUxIDAgLjY5NC0uMTA2Ljk4NC0uMzAzbDEuNjk2LTEuMTU0QS4yNS4yNSAwIDAxOS4yNzUgNmgxLjk3NXYxNC41SDYuNzYzYS43NS43NSAwIDAwMCAxLjVoMTAuNDc0YS43NS43NSAwIDAwMC0xLjVIMTIuNzVWNmgxLjk3NGMuMDUgMCAuMS4wMTUuMTQuMDQzbDEuNjk3IDEuMTU0Yy4yOS4xOTcuNjMzLjMwMy45ODQuMzAzaC44ODZsLTMuMzY4IDcuNjhhLjc1Ljc1IDAgMDAuMjMuODk2Yy4wMTIuMDA5IDAgMCAuMDAyIDBhMy4xNTQgMy4xNTQgMCAwMC4zMS4yMDZjLjE4NS4xMTIuNDUuMjU2Ljc5LjRhNy4zNDMgNy4zNDMgMCAwMDIuODU1LjU2OCA3LjM0MyA3LjM0MyAwIDAwMi44NTYtLjU2OWMuMzM4LS4xNDMuNjA0LS4yODcuNzktLjM5OWEzLjUgMy41IDAgMDAuMzEtLjIwNi43NS43NSAwIDAwLjIzLS44OTZMMjAuMDcgNy41aDEuNTc4YS43NS43NSAwIDAwMC0xLjVoLTQuMTAyYS4yNS4yNSAwIDAxLS4xNC0uMDQzbC0xLjY5Ny0xLjE1NGExLjc1IDEuNzUgMCAwMC0uOTg0LS4zMDNIMTIuNzVWMi43NXpNMi4xOTMgMTUuMTk4YTUuNDE4IDUuNDE4IDAgMDAyLjU1Ny42MzUgNS40MTggNS40MTggMCAwMDIuNTU3LS42MzVMNC43NSA5LjM2OGwtMi41NTcgNS44M3ptMTQuNTEtLjAyNGMuMDgyLjA0LjE3NC4wODMuMjc1LjEyNi41My4yMjMgMS4zMDUuNDUgMi4yNzIuNDVhNS44NDYgNS44NDYgMCAwMDIuNTQ3LS41NzZMMTkuMjUgOS4zNjdsLTIuNTQ3IDUuODA3eiI+PC9wYXRoPjwvc3ZnPgo=
142147
143148[ docker-release-link ] : https://hub.docker.com/r/tensorchord/vchord-postgres
144- [ docker-release-shield ] : https://img.shields.io/docker/v/tensorchord/vchord-postgres?color=369eff&label=docker&labelColor=black&logo=docker&logoColor=white&style=flat&sort=semver
149+ [ docker-release-shield ] : https://img.shields.io/docker/v/tensorchord/vchord-postgres?color=369eff&label=docker&labelColor=black&logo=docker&logoColor=white&style=flat
145150[ github-release-link ] : https://github.com/tensorchord/VectorChord/releases
146151[ github-release-shield ] : https://img.shields.io/github/v/release/tensorchord/VectorChord?color=369eff&labelColor=black&logo=github&style=flat
152+ [ ghcr-release-link ] : https://github.com/orgs/tensorchord/packages/container/package/vchord-postgres
153+ <!-- GHCR badge is not supported by shields.io yet, use docker badge instead -->
154+ [ ghcr-release-shield ] : https://img.shields.io/docker/v/tensorchord/vchord-postgres?color=369eff&label=GHCR&labelColor=black&logo=github&logoColor=white&style=flat
147155[ docker-pulls-link ] : https://hub.docker.com/r/tensorchord/vchord-postgres
148156[ docker-pulls-shield ] : https://img.shields.io/docker/pulls/tensorchord/vchord-postgres?color=45cc11&labelColor=black&style=flat&sort=semver
149157[ previous-docker-pulls-link ] : https://hub.docker.com/r/tensorchord/pgvecto-rs
150158[ previous-docker-pulls-shield ] : https://img.shields.io/docker/pulls/tensorchord/pgvecto-rs?color=45cc11&labelColor=black&style=flat&sort=semver
159+ [ github-downloads-link ] : https://github.com/tensorchord/VectorChord/releases
160+ [ github-downloads-shield ] : https://img.shields.io/github/downloads/tensorchord/VectorChord/total?color=45cc11&labelColor=black&style=flat&sort=semver
151161[ discord-link ] : https://discord.gg/KqswhpVgdU
152162[ discord-shield ] : https://img.shields.io/discord/974584200327991326?&logoColor=white&color=5865F2&style=flat&logo=discord&cacheSeconds=60
153- [ X-link ] : https://twitter .com/TensorChord
154- [ X-shield ] : https://img.shields.io/twitter /follow/tensorchord? style=flat&logo=X&cacheSeconds=60
163+ [ X-link ] : https://x .com/TensorChord
164+ [ X-shield ] : https://img.shields.io/badge /follow-%40tensorchord-1DA1F2?logo=x& style=flat&logoColor=white&color=1da1f2
155165[ cloud-link ] : https://cloud.vectorchord.ai/
156166[cloud-shield]: https://img.shields.io/badge/VectorChord_Cloud-Try_For_Free-F2B263.svg?labelColor=DAFDBA&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxMzMiIGhlaWdodD0iMTMyIiBmaWxsPSJub25lIj48cGF0aCBmaWxsPSIjRTZEQjNEIiBkPSJNNDguNCAzNy41YzAtMSAwLTEuNS0uMi0xLjhhMSAxIDAgMCAwLS44LS40Yy0uMyAwLS43LjMtMS42IDFMMjcuNiA1MC4xYy0xLjIuOC0xLjcgMS4zLTIuMiAxLjhhNSA1IDAgMCAwLS44IDEuNmMtLjIuNy0uMiAxLjQtLjIgMi45djM3LjNjMCAxLjIgMCAxLjguMyAyIC4yLjMuNS41LjguNC40IDAgLjgtLjQgMS42LTEuM2wxOS0xOC42IDEuNS0xLjhjLjMtLjQuNS0xIC42LTEuNC4yLS42LjItMS4yLjItMi40VjM3LjVaTTM1LjIgMTA1LjNjLS44LjgtMS4yIDEuMy0xLjIgMS42IDAgLjQgMCAuNy4zLjkuMy4yLjkuMiAyIC4yaDM3YzEuMyAwIDIgMCAyLjUtLjJhNSA1IDAgMCAwIDEuNS0uNmMuNi0uNCAxLS45IDEuOS0xLjhMOTYuNiA4NmMuNy0uOSAxLjEtMS4zIDEuMS0xLjZhMSAxIDAgMCAwLS4zLS44Yy0uMy0uMy0uOS0uMy0yLS4zaC0zNWMtMS4yIDAtMS44IDAtMi40LjJhNSA1IDAgMCAwLTEuNC42Yy0uNS4zLTEgLjctMS44IDEuNmwtMTkuNiAxOS42Wk05Ni4zIDcwLjFjMSAwIDEuNCAwIDEuNy0uMi40LS4xLjYtLjQuOC0uN2wuMS0xLjdWMzUuM2wtLjEtMS44Yy0uMi0uMy0uNC0uNS0uOC0uNy0uMy0uMi0uOC0uMi0xLjctLjJINjQuMWMtMSAwLTEuNCAwLTEuNy4yLS40LjItLjYuNC0uOC43bC0uMSAxLjh2MzIuMmwuMSAxLjdjLjIuMy40LjYuOC43LjMuMi44LjIgMS43LjJoMzIuMloiLz48cGF0aCBmaWxsPSIjMTAxNTA5IiBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik00My4yIDIxLjVjLTEuMyAwLTIgMC0yLjMtLjMtLjMtLjMtLjUtLjYtLjUtMSAwLS41LjQtMSAxLjEtMi4xTDUzLjEgMi4zYy42LS44LjktMS4yIDEuMi0xLjNoMWMuNC4xLjcuNSAxLjIgMS4zbDExLjYgMTUuOGMuOCAxIDEuMiAxLjYgMS4yIDIgMCAuNS0uMi44LS41IDEtLjQuNC0xIC40LTIuNC40SDU5Yy0uMy4yLS41LjQtLjYuNy0uMi4zLS4yLjYtLjIgMS40VjY4YzAgMS45IDAgMi44LjQgMy41LjMuNi44IDEuMSAxLjQgMS41LjcuMyAxLjcuMyAzLjUuM2g0NGwxLjMtLjFjLjMtLjEuNS0uMy42LS42bC4xLTEuNFY2NWMwLTEuMyAwLTIgLjMtMi4zLjItLjMuNi0uNSAxLS41czEgLjMgMiAxTDEzMCA3NWMuOC42IDEuMy45IDEuNCAxLjJ2MWMtLjEuNC0uNi43LTEuNCAxLjNsLTE3LjMgMTEuN2MtMSAuOC0xLjYgMS4xLTIgMS4xLS40IDAtLjgtLjItMS0uNS0uMy0uNC0uMy0xLS4zLTIuM1Y4MmwtLjEtMS40Yy0uMS0uMi0uMy0uNC0uNi0uNS0uMy0uMi0uNi0uMi0xLjQtLjJINjAuNWMtMS42IDAtMi40IDAtMy4xLjItLjcuMi0xLjMuNC0yIC44bC0yLjMgMi0yOC42IDI4LjNjLS41LjUtLjguOC0uOSAxLjF2LjhjLjEuMy40LjYuOSAxLjFsMy43IDMuN2MuOCAxIDEuMyAxLjMgMS4zIDEuOCAwIC40IDAgLjctLjMgMS0uMy4zLS45LjUtMiAuOGwtMjAgNC43Yy0xLjEuMi0xLjcuMy0yIC4yLS40LS4xLS43LS40LS44LS44LS4xLS4zIDAtMSAuMy0ybDUtMTkuOWMuMy0xLjEuNC0xLjcuOC0yIC4zLS4zLjctLjQgMS0uMy41IDAgLjkuNSAxLjggMS40bDMuNiAzLjcgMSAuOWguOWMuMy0uMS42LS40IDEtLjlsMjguNi0yOC4yYzEuMi0xLjEgMS43LTEuNyAyLjEtMi4zLjQtLjYuNy0xLjMuOC0yIC4yLS43LjItMS41LjItMy4yVjIzLjZsLS4xLTEuNGMtLjEtLjMtLjMtLjUtLjYtLjZsLTEuNC0uMWgtNi4yWiIgY2xpcC1ydWxlPSJldmVub2RkIi8+PC9zdmc+
167+ [ deepwiki-link ] : https://deepwiki.com/tensorchord/VectorChord
168+ [ deepwiki-shield ] : https://deepwiki.com/badge.svg
157169[ blog-link ] : https://blog.vectorchord.ai/
158170[ official-site-link ] : https://vectorchord.ai/
159171[ github-issues-link ] : https://github.com/tensorchord/VectorChord/issues
0 commit comments