Skip to content

Commit dd535d0

Browse files
committed
Implement feedback
1 parent 4e1d905 commit dd535d0

File tree

11 files changed

+51
-23
lines changed

11 files changed

+51
-23
lines changed

docs/deploy/configuration/monitoring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ When using multi-tenancy, we suggest setting the `PROMETHEUS_MONITORING_GROUP` [
6060

6161
:::info Versioning & breaking changes
6262

63-
Be aware that metrics do not follow the semantic versioning guidelines of other Weaviate features. Weaviate's main APIs are stable and breaking changes are extremely rare. Metrics, however, have shorter feature lifecycles. It can sometimes be necessary to introduce an incompatible change or entirely remove a metric, for example, because the cost of observing a specific metric in production has grown too high. As a result, it is possible that a Weaviate minor release contains a breaking change for the Monitoring system. If so, it will be clearly highlighted in the release notes.
63+
Be aware that metrics do not follow the semantic versioning guidelines of other Weaviate features. Weaviate's main APIs are stable and breaking changes are extremely rare. Metrics, however, have shorter feature lifecycles. It can sometimes be necessary to introduce an incompatible change or entirely remove a metric, for example, because the cost of observing a specific metric in production has grown too high. As a result, it is possible that a Weaviate minor release contains a breaking change for the Monitoring system. If so, it will be clearly highlighted in the [release notes](https://github.com/weaviate/weaviate/releases).
6464

6565
:::
6666

docs/weaviate/concepts/vector-quantization.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -122,10 +122,17 @@ When SQ is enabled, Weaviate boosts recall by over-fetching compressed results.
122122

123123
### 8-bit RQ
124124

125-
:::info Added in `v1.32` and `v1.34`
125+
:::info Added in `v1.32`
126126

127-
**8-bit Rotational quantization (RQ)** for the HNSW vector index was added in **`v1.32`**.<br/>
128-
**8-bit Rotational quantization (RQ)** for the flat vector index was added in **`v1.34`** as a **preview** and should not be used in production.<br/>
127+
**8-bit Rotational quantization (RQ)** for the **HNSW vector index** was added in **`v1.32`**.
128+
129+
:::
130+
131+
:::caution Preview
132+
133+
**8-bit Rotational quantization (RQ)** for the **flat vector index** was added in **`v1.34`** as a **preview**.<br/><br/>
134+
This means that the feature is still under development and may change in future releases, including potential breaking changes.
135+
**We do not recommend using this feature in production environments at this time.**
129136

130137
:::
131138

@@ -137,10 +144,17 @@ When SQ is enabled, Weaviate boosts recall by over-fetching compressed results.
137144

138145
### 1-bit RQ
139146

140-
:::info Added in `v1.33` and `v1.34`
147+
:::info Added in `v1.33`
148+
149+
**1-bit Rotational quantization (RQ)** for the **HNSW vector index** was added in **`v1.33`**.
150+
151+
:::
152+
153+
:::caution Preview
141154

142-
**1-bit Rotational quantization (RQ)** for the HNSW vector index was added in **`v1.33`**.<br/>
143-
**1-bit Rotational quantization (RQ)** for the flat vector index was added in **`v1.34`** as a **preview** and should not be used in production.<br/>
155+
**1-bit Rotational quantization (RQ)** for the **flat vector index** was added in **`v1.34`** as a **preview**.<br/><br/>
156+
This means that the feature is still under development and may change in future releases, including potential breaking changes.
157+
**We do not recommend using this feature in production environments at this time.**
144158

145159
:::
146160

docs/weaviate/configuration/compression/rq-compression.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,17 @@ import CompressionByDefault from '/\_includes/compression-by-default.mdx';
2323

2424
## 8-bit RQ
2525

26-
:::info Added in `v1.32` and `v1.34`
26+
:::info Added in `v1.32`
2727

28-
**8-bit Rotational quantization (RQ)** for the HNSW vector index was added in **`v1.32`**.<br/>
29-
**8-bit Rotational quantization (RQ)** for the flat vector index was added in **`v1.34`** as a **preview** and should not be used in production.<br/>
28+
**8-bit Rotational quantization (RQ)** for the **HNSW vector index** was added in **`v1.32`**.
29+
30+
:::
31+
32+
:::caution Preview
33+
34+
**8-bit Rotational quantization (RQ)** for the **flat vector index** was added in **`v1.34`** as a **preview**.<br/><br/>
35+
This means that the feature is still under development and may change in future releases, including potential breaking changes.
36+
**We do not recommend using this feature in production environments at this time.**
3037

3138
:::
3239

@@ -112,10 +119,17 @@ RQ can also be enabled for an existing collection by updating the collection def
112119

113120
## 1-bit RQ
114121

115-
:::info Added in `v1.33` and `v1.34`
122+
:::info Added in `v1.32`
123+
124+
**1-bit Rotational quantization (RQ)** for the **HNSW vector index** was added in **`v1.33`**.
125+
126+
:::
127+
128+
:::caution Preview
116129

117-
**1-bit Rotational quantization (RQ)** for the HNSW vector index was added in **`v1.33`**.<br/>
118-
**1-bit Rotational quantization (RQ)** for the flat vector index was added in **`v1.34`** as a **preview** and should not be used in production.<br/>
130+
**1-bit Rotational quantization (RQ)** for the **flat vector index** was added in **`v1.34`** as a **preview**.<br/><br/>
131+
This means that the feature is still under development and may change in future releases, including potential breaking changes.
132+
**We do not recommend using this feature in production environments at this time.**
119133

120134
:::
121135

tests/docker-compose-anon-2.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ services:
88
- '8080'
99
- --scheme
1010
- http
11-
image: cr.weaviate.io/semitechnologies/weaviate:1.34.0-rc.0
11+
image: cr.weaviate.io/semitechnologies/weaviate:1.34.0-rc.1
1212
ports:
1313
- 8090:8080
1414
- 50061:50051

tests/docker-compose-anon-bind.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ services:
88
- '8080'
99
- --scheme
1010
- http
11-
image: cr.weaviate.io/semitechnologies/weaviate:1.34.0-rc.0
11+
image: cr.weaviate.io/semitechnologies/weaviate:1.34.0-rc.1
1212
ports:
1313
- 8380:8080
1414
- 50351:50051

tests/docker-compose-anon-clip.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ services:
88
- '8080'
99
- --scheme
1010
- http
11-
image: cr.weaviate.io/semitechnologies/weaviate:1.34.0-rc.0
11+
image: cr.weaviate.io/semitechnologies/weaviate:1.34.0-rc.1
1212
ports:
1313
- 8280:8080
1414
- 50251:50051

tests/docker-compose-anon-offload.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ services:
88
- '8080'
99
- --scheme
1010
- http
11-
image: cr.weaviate.io/semitechnologies/weaviate:1.34.0-rc.0
11+
image: cr.weaviate.io/semitechnologies/weaviate:1.34.0-rc.1
1212
ports:
1313
- 8080:8080
1414
- 50051:50051

tests/docker-compose-anon.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ services:
88
- '8080'
99
- --scheme
1010
- http
11-
image: cr.weaviate.io/semitechnologies/weaviate:1.34.0-rc.0
11+
image: cr.weaviate.io/semitechnologies/weaviate:1.34.0-rc.1
1212
ports:
1313
- 8080:8080
1414
- 50051:50051

tests/docker-compose-rbac.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ services:
77
- '8080'
88
- --scheme
99
- http
10-
image: cr.weaviate.io/semitechnologies/weaviate:1.34.0-rc.0
10+
image: cr.weaviate.io/semitechnologies/weaviate:1.34.0-rc.1
1111
ports:
1212
- 8580:8080
1313
- 50551:50051

tests/docker-compose-three-nodes.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ services:
88
- '8080'
99
- --scheme
1010
- http
11-
image: cr.weaviate.io/semitechnologies/weaviate:1.34.0-rc.0
11+
image: cr.weaviate.io/semitechnologies/weaviate:1.34.0-rc.1
1212
restart: on-failure:0
1313
ports:
1414
- "8180:8080"
@@ -35,7 +35,7 @@ services:
3535
- '8080'
3636
- --scheme
3737
- http
38-
image: cr.weaviate.io/semitechnologies/weaviate:1.34.0-rc.0
38+
image: cr.weaviate.io/semitechnologies/weaviate:1.34.0-rc.1
3939
restart: on-failure:0
4040
ports:
4141
- "8181:8080"
@@ -63,7 +63,7 @@ services:
6363
- '8080'
6464
- --scheme
6565
- http
66-
image: cr.weaviate.io/semitechnologies/weaviate:1.34.0-rc.0
66+
image: cr.weaviate.io/semitechnologies/weaviate:1.34.0-rc.1
6767
restart: on-failure:0
6868
ports:
6969
- "8182:8080"

0 commit comments

Comments
 (0)