You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/vectorchord/getting-started/overview.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ docker run \
37
37
--name vectorchord-demo \
38
38
-e POSTGRES_PASSWORD=mysecretpassword \
39
39
-p 5432:5432 \
40
-
-d tensorchord/vchord-postgres:pg18-v1.1.0
40
+
-d tensorchord/vchord-postgres:pg18-v1.1.1
41
41
```
42
42
> In addition to the base image with the VectorChord extension, we provide an all-in-one image, `tensorchord/vchord-suite:pg18-latest`. This comprehensive image includes all official TensorChord extensions. 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).
- Description: The data type of a quantized vector that uses `uint8` for internal storage. It's based on extended RaBitQ.[^exrabitq]
42
+
- Textual representation: Unlike `vector`/`halfvec`, the textual representation of `rabitq8` is more complex. Suppose the dimension is $d$; it consists of a concatenation of an array of $4$ floating-point numbers enclosed in parentheses and an array of $d$ `uint8` integers enclosed in brackets. For example, `(2.999999, 160.63234, 647, 2.8498733)[255, 205, 187]`. Its interpretation is internal, but you can get the vector it represents by using `dequantize_to_vector(rabitq8)`/`dequantize_to_halfvec(rabitq8)`.
- Description: The data type of a quantized vector that uses `uint4` for internal storage. It's based on extended RaBitQ.[^exrabitq]
47
+
- Textual representation: Unlike `vector`/`halfvec`, the textual representation of `rabitq4` is more complex. Suppose the dimension is $d$; it consists of a concatenation of an array of $4$ floating-point numbers enclosed in parentheses and an array of $d$ `uint4` integers enclosed in brackets. For example, `(2.999999, 9.420722, 38, 2.8498733)[15, 12, 11]`. Its interpretation is internal, but you can get the vector it represents by using `dequantize_to_vector(rabitq4)`/`dequantize_to_halfvec(rabitq4)`.
- Description: Quantizes a vector to `rabitq8`. This function may produce different outputs for the same input with different versions of VectorChord or with different machines.
53
+
- Description: Quantize a vector to `rabitq8`. Note that this function may produce sightly different results for identical inputs with different versions of VectorChord or with different machines.
52
54
- Result: `rabitq8`, the quantized vector
53
55
- Arguments:
54
56
-`vector`, the vector to be quantized
55
57
- Example:
56
58
-`SELECT quantize_to_rabitq8('[1,1,1]'::vector)`
57
-
- Note: This function does not have a corresponding `CAST`. If you really need one, you can create it by`CREATE CAST (vector AS rabitq8) WITH FUNCTION quantize_to_rabitq8(vector) AS ASSIGNMENT`.
59
+
- Note: This function does not have a corresponding `CAST`. If needed, you can create one manually using`CREATE CAST (vector AS rabitq8) WITH FUNCTION quantize_to_rabitq8(vector) AS ASSIGNMENT`.
- Description: Quantizes a vector to `rabitq8`. This function may produce different outputs for the same input with different versions of VectorChord or with different machines.
63
+
- Description: Quantize a vector to `rabitq8`. Note that this function may produce sightly different results for identical inputs with different versions of VectorChord or with different machines.
62
64
- Result: `rabitq8`, the quantized vector
63
65
- Arguments:
64
66
-`halfvec`, the vector to be quantized
65
67
- Example:
66
68
-`SELECT quantize_to_rabitq8('[1,1,1]'::halfvec)`
67
-
- Note: This function does not have a corresponding `CAST`. If you really need one, you can create it by `CREATE CAST (halfvec AS rabitq8) WITH FUNCTION quantize_to_rabitq8(halfvec) AS ASSIGNMENT`.
69
+
- Note: This function does not have a corresponding `CAST`. If needed, you can create one manually using `CREATE CAST (halfvec AS rabitq8) WITH FUNCTION quantize_to_rabitq8(halfvec) AS ASSIGNMENT`.
- Description: Dequantize a quantized vector to `vector`. Note that this function may produce sightly different results for identical inputs with different versions of VectorChord or with different machines. The original vector cannot be precisely reconstructed using this function.
74
+
- Result: `vector`, the dequantized vector
75
+
- Arguments:
76
+
-`rabitq8`, the quantized vector to be dequantized
- Note: This function does not have a corresponding `CAST`. If needed, you can create one manually using `CREATE CAST (rabitq8 AS vector) WITH FUNCTION dequantize_to_vector(rabitq8) AS ASSIGNMENT`.
- Description: Dequantize a quantized vector to `halfvec`. Note that this function may produce sightly different results for identical inputs with different versions of VectorChord or with different machines. The original vector cannot be precisely reconstructed using this function.
84
+
- Result: `halfvec`, the dequantized vector
85
+
- Arguments:
86
+
-`rabitq8`, the quantized vector to be dequantized
- Note: This function does not have a corresponding `CAST`. If needed, you can create one manually using `CREATE CAST (rabitq8 AS halfvec) WITH FUNCTION dequantize_to_halfvec(rabitq8) AS ASSIGNMENT`.
- Description: Quantizes a vector to `rabitq4`. This function may produce different outputs for the same input with different versions of VectorChord or with different machines.
93
+
- Description: Quantize a vector to `rabitq4`. Note that this function may produce sightly different results for identical inputs with different versions of VectorChord or with different machines.
72
94
- Result: `rabitq4`, the quantized vector
73
95
- Arguments:
74
96
-`vector`, the vector to be quantized
75
97
- Example:
76
98
-`SELECT quantize_to_rabitq4('[1,1,1]'::vector)`
77
-
- Note: This function does not have a corresponding `CAST`. If you really need one, you can create it by`CREATE CAST (vector AS rabitq4) WITH FUNCTION quantize_to_rabitq4(vector) AS ASSIGNMENT`.
99
+
- Note: This function does not have a corresponding `CAST`. If needed, you can create one manually using`CREATE CAST (vector AS rabitq4) WITH FUNCTION quantize_to_rabitq4(vector) AS ASSIGNMENT`.
- Description: Quantizes a vector to `rabitq4`. This function may produce different outputs for the same input with different versions of VectorChord or with different machines.
103
+
- Description: Quantize a vector to `rabitq4`. Note that this function may produce sightly different results for identical inputs with different versions of VectorChord or with different machines.
82
104
- Result: `rabitq4`, the quantized vector
83
105
- Arguments:
84
106
-`halfvec`, the vector to be quantized
85
107
- Example:
86
108
-`SELECT quantize_to_rabitq4('[1,1,1]'::halfvec)`
87
-
- Note: This function does not have a corresponding `CAST`. If you really need one, you can create it by `CREATE CAST (halfvec AS rabitq4) WITH FUNCTION quantize_to_rabitq4(halfvec) AS ASSIGNMENT`.
109
+
- Note: This function does not have a corresponding `CAST`. If needed, you can create one manually using `CREATE CAST (halfvec AS rabitq4) WITH FUNCTION quantize_to_rabitq4(halfvec) AS ASSIGNMENT`.
- Description: Dequantize a quantized vector to `vector`. Note that this function may produce sightly different results for identical inputs with different versions of VectorChord or with different machines. The original vector cannot be precisely reconstructed using this function.
114
+
- Result: `vector`, the dequantized vector
115
+
- Arguments:
116
+
-`rabitq4`, the quantized vector to be dequantized
- Note: This function does not have a corresponding `CAST`. If needed, you can create one manually using `CREATE CAST (rabitq4 AS vector) WITH FUNCTION dequantize_to_vector(rabitq4) AS ASSIGNMENT`.
- Description: Dequantize a quantized vector to `halfvec`. Note that this function may produce sightly different results for identical inputs with different versions of VectorChord or with different machines. The original vector cannot be precisely reconstructed using this function.
124
+
- Result: `halfvec`, the dequantized vector
125
+
- Arguments:
126
+
-`rabitq4`, the quantized vector to be dequantized
- Note: This function does not have a corresponding `CAST`. If needed, you can create one manually using `CREATE CAST (rabitq4 AS halfvec) WITH FUNCTION dequantize_to_halfvec(rabitq4) AS ASSIGNMENT`.
0 commit comments