Skip to content

Commit

Permalink
fix: br
Browse files Browse the repository at this point in the history
  • Loading branch information
zhanshuyou committed Aug 15, 2024
1 parent c2281d8 commit 4917695
Show file tree
Hide file tree
Showing 22 changed files with 118 additions and 118 deletions.
2 changes: 1 addition & 1 deletion site/en/about/comparison.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Although both serve similar functions as vector databases, the domain-specific t
| Deployment Modes | SaaS-only | Milvus Lite, On-prem Standalone & Cluster, Zilliz Cloud Saas & BYOC |
| Embedding Functions | Not available | Support with <a href="https://github.com/milvus-io/milvus-model">pymilvus[model]</a> |
| Data Types | String, Number, Bool, List of String | String, VarChar, Number (Int, Float, Double), Bool, Array, JSON, Float Vector, Binary Vector, BFloat16, Float16, Sparse Vector |
| Metric and Index Types | Cos, Dot, Euclidean<br>P-family, S-family | Cosine, IP (Dot), L2 (Euclidean), Hamming, Jaccard<br>FLAT, IVF_FLAT, IVF_SQ8, IVF_PQ, HNSW, SCANN, GPU Indexes |
| Metric and Index Types | Cos, Dot, Euclidean<br/>P-family, S-family | Cosine, IP (Dot), L2 (Euclidean), Hamming, Jaccard<br/>FLAT, IVF_FLAT, IVF_SQ8, IVF_PQ, HNSW, SCANN, GPU Indexes |
| Schema Design | Flexible mode | Flexible mode, Strict mode |
| Multiple Vector Fields | N/A | Multi-vector and hybrid search |
| Tools | Datasets, text utilities, spark connector | Attu, Birdwatcher, Backup, CLI, CDC, Spark and Kafka connectors |
Expand Down
32 changes: 16 additions & 16 deletions site/en/about/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,28 +22,28 @@ Welcome to the Milvus Roadmap! Join us on our continuous journey to enhance and
</thead>
<tbody>
<tr>
<td><strong>AI-developer Friendly</strong><br><i>A developer-friendly technology stack, enhanced with the latest AI innovations</i></td>
<td><strong>Multi-Vectors & Hybrid Search</strong><br><i>Framework for multiplex recall and fusion</i><br><br><strong>GPU Index Acceleration</strong><br><i>Support for higher QPS and faster index creation</i><br><br><strong>Model Library in PyMilvus</strong><br><i>Integrated embedding models for Milvus</i></td>
<td><strong>Sparse Vector (GA)</strong><br><i>Local feature extraction and keyword search</i><br><br><strong>Milvus Lite (GA)</strong><br><i>A lightweight, in-memory version of Milvus</i><br><br><strong>Embedding Models Gallery</strong><br><i>Support for image and multi-modal embeddings and reranker models in model libraries</i></td>
<td><strong>Original Data-In and Data-Out</strong><br><i>Support for Blob data types</i><br><br><strong>Data Clustering</strong><br><i>Data co-locality</i><br><br><strong>Scenario-oriented Vector Search</strong><br><i>e.g. Multi-target search & NN filtering</i><br><br><strong>Support Embedding & Reranker Endpoint</strong></td>
<td><strong>AI-developer Friendly</strong><br/><i>A developer-friendly technology stack, enhanced with the latest AI innovations</i></td>
<td><strong>Multi-Vectors & Hybrid Search</strong><br/><i>Framework for multiplex recall and fusion</i><br/><br/><strong>GPU Index Acceleration</strong><br/><i>Support for higher QPS and faster index creation</i><br/><br/><strong>Model Library in PyMilvus</strong><br/><i>Integrated embedding models for Milvus</i></td>
<td><strong>Sparse Vector (GA)</strong><br/><i>Local feature extraction and keyword search</i><br/><br/><strong>Milvus Lite (GA)</strong><br/><i>A lightweight, in-memory version of Milvus</i><br/><br/><strong>Embedding Models Gallery</strong><br/><i>Support for image and multi-modal embeddings and reranker models in model libraries</i></td>
<td><strong>Original Data-In and Data-Out</strong><br/><i>Support for Blob data types</i><br/><br/><strong>Data Clustering</strong><br/><i>Data co-locality</i><br/><br/><strong>Scenario-oriented Vector Search</strong><br/><i>e.g. Multi-target search & NN filtering</i><br/><br/><strong>Support Embedding & Reranker Endpoint</strong></td>
</tr>
<tr>
<td><strong>Rich Functionality</strong><br><i>Enhanced retrieval and data management features</i></td>
<td><strong>Support for FP16, BF16 Datatypes</strong><br><i>These ML datatypes can help reduce memory usage</i><br><br><strong>Grouping Search</strong><br><i>Aggregate split embeddings</i><br><br><strong>Fuzzy Match and Inverted Index</strong><br><i>Support for fuzzy matching and inverted indexing for scalar types like varchar and int</i></td>
<td><strong>Inverted Index for Array & JSON</strong><br><i>Indexing for array and partial support JSON</i><br><br><strong>Bitset Index</strong><br><i>Improved execution speed and future data aggregation</i><br><br><strong>Truncate Collection</strong><br><i>Allows data clearance while preserving metadata</i><br><br><strong>Support for NULL and Default Values</strong></td>
<td><strong>Support for More Datatypes</strong><br><i>e.g. Datetime, GIS</i><br><br><strong>Advanced Text Filtering</strong><br><i>e.g. Match Phrase</i><br><br><strong>Primary Key Deduplication</strong></td>
<td><strong>Rich Functionality</strong><br/><i>Enhanced retrieval and data management features</i></td>
<td><strong>Support for FP16, BF16 Datatypes</strong><br/><i>These ML datatypes can help reduce memory usage</i><br/><br/><strong>Grouping Search</strong><br/><i>Aggregate split embeddings</i><br/><br/><strong>Fuzzy Match and Inverted Index</strong><br/><i>Support for fuzzy matching and inverted indexing for scalar types like varchar and int</i></td>
<td><strong>Inverted Index for Array & JSON</strong><br/><i>Indexing for array and partial support JSON</i><br/><br/><strong>Bitset Index</strong><br/><i>Improved execution speed and future data aggregation</i><br/><br/><strong>Truncate Collection</strong><br/><i>Allows data clearance while preserving metadata</i><br/><br/><strong>Support for NULL and Default Values</strong></td>
<td><strong>Support for More Datatypes</strong><br/><i>e.g. Datetime, GIS</i><br/><br/><strong>Advanced Text Filtering</strong><br/><i>e.g. Match Phrase</i><br/><br/><strong>Primary Key Deduplication</strong></td>
</tr>
<tr>
<td><strong>Cost Efficiency & Architecture</strong><br><i>Advanced systems emphasizing stability, cost efficiency, scalability, and performance</i></td>
<td><strong>Support for More Collections/Partitions</strong><br><i>Handles over 10,000 collections in smaller clusters</i><br><br><strong>Mmap Optimization</strong><br><i>Balances reduced memory consumption with latency</i><br><br><strong>Bulk Insert Optimazation</strong><br><i>Simplifies importing large datasets</i></td>
<td><strong>Lazy Load</strong><br><i>Data is loaded on-demand through read operations</i><br><br><strong>Major Compaction</strong><br><i>Re-distributes data based on configuration to enhance read performance</i><br><br><strong>Mmap for Growing Data</strong><br><i>Mmap files for expanding data segments</i></td>
<td><strong>Memory Control</strong><br><i>Reduces out-of-memory issues and provides global memory management</i><br><br><strong>LogNode Introduction</strong><br><i>Ensures global consistency and addresses the single-point bottleneck in root coordination</i><br><br><strong>Storage Format V2</strong><br><i>Universal format design lays the groundwork for disk-based data access</i></td>
<td><strong>Cost Efficiency & Architecture</strong><br/><i>Advanced systems emphasizing stability, cost efficiency, scalability, and performance</i></td>
<td><strong>Support for More Collections/Partitions</strong><br/><i>Handles over 10,000 collections in smaller clusters</i><br/><br/><strong>Mmap Optimization</strong><br/><i>Balances reduced memory consumption with latency</i><br/><br/><strong>Bulk Insert Optimazation</strong><br/><i>Simplifies importing large datasets</i></td>
<td><strong>Lazy Load</strong><br/><i>Data is loaded on-demand through read operations</i><br/><br/><strong>Major Compaction</strong><br/><i>Re-distributes data based on configuration to enhance read performance</i><br/><br/><strong>Mmap for Growing Data</strong><br/><i>Mmap files for expanding data segments</i></td>
<td><strong>Memory Control</strong><br/><i>Reduces out-of-memory issues and provides global memory management</i><br/><br/><strong>LogNode Introduction</strong><br/><i>Ensures global consistency and addresses the single-point bottleneck in root coordination</i><br/><br/><strong>Storage Format V2</strong><br/><i>Universal format design lays the groundwork for disk-based data access</i></td>
</tr>
<tr>
<td><strong>Enterprise Ready</strong><br><i>Designed to meet the needs of enterprise production environments</i></td>
<td><strong>Milvus CDC</strong><br><i>Capability for data replication</i><br><br><strong>Accesslog Enhancement</strong><br><i>Detailed recording for audit and tracing</i></td>
<td><strong>New Resource Group</strong><br><i>Enhanced resource management</i><br><br><strong>Storage Hook</strong><br><i>Support for Bring Your Own Key (BYOK) encryption</i></td>
<td><strong>Dynamic Replica Number Adjustment</strong><br><i>Facilitates dynamic changes to the number of replicas</i><br><br><strong>Dynamic Schema Modification</strong><br><i>e.g., Add/delete fields, modify varchar lengths</i><br><br><strong>Rust and C# SDKs</strong></td>
<td><strong>Enterprise Ready</strong><br/><i>Designed to meet the needs of enterprise production environments</i></td>
<td><strong>Milvus CDC</strong><br/><i>Capability for data replication</i><br/><br/><strong>Accesslog Enhancement</strong><br/><i>Detailed recording for audit and tracing</i></td>
<td><strong>New Resource Group</strong><br/><i>Enhanced resource management</i><br/><br/><strong>Storage Hook</strong><br/><i>Support for Bring Your Own Key (BYOK) encryption</i></td>
<td><strong>Dynamic Replica Number Adjustment</strong><br/><i>Facilitates dynamic changes to the number of replicas</i><br/><br/><strong>Dynamic Schema Modification</strong><br/><i>e.g., Add/delete fields, modify varchar lengths</i><br/><br/><strong>Rust and C# SDKs</strong></td>
</tr>
</tbody>
</table>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ In addition to a single GPU device, you can also assign multiple GPU devices to
<ul>
<li>The release name should only contain letters, numbers and dashes. Dots are not allowed in the release name.</li>
<li>The default command line installs cluster version of Milvus while installing Milvus with Helm. Further setting is needed while installing Milvus standalone.</li>
<li>According to the <a href="https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-25">deprecated API migration guide of Kuberenetes</a>, the <b>policy/v1beta1</b> API version of PodDisruptionBudget is not longer served as of v1.25. You are suggested to migrate manifests and API clients to use the <b>policy/v1</b> API version instead. <br>As a workaround for users who still use the <b>policy/v1beta1</b> API version of PodDisruptionBudget on Kuberenetes v1.25 and later, you can instead run the following command to install Milvus:<br>
<li>According to the <a href="https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-25">deprecated API migration guide of Kuberenetes</a>, the <b>policy/v1beta1</b> API version of PodDisruptionBudget is not longer served as of v1.25. You are suggested to migrate manifests and API clients to use the <b>policy/v1</b> API version instead. <br/>As a workaround for users who still use the <b>policy/v1beta1</b> API version of PodDisruptionBudget on Kuberenetes v1.25 and later, you can instead run the following command to install Milvus:<br/>
<code>helm install my-release milvus/milvus --set pulsar.bookkeeper.pdb.usePolicy=false,pulsar.broker.pdb.usePolicy=false,pulsar.proxy.pdb.usePolicy=false,pulsar.zookeeper.pdb.usePolicy=false</code></li>
<li>See <a href="https://artifacthub.io/packages/helm/milvus/milvus">Milvus Helm Chart</a> and <a href="https://helm.sh/docs/">Helm</a> for more information.</li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion site/en/getstarted/run-milvus-k8s/install_cluster-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ The command above deploys a Milvus cluster with its components and dependencies
<ul>
<li>The release name should only contain letters, numbers and dashes. Dots are not allowed in the release name.</li>
<li>The default command line installs cluster version of Milvus while installing Milvus with Helm. Further setting is needed while installing Milvus standalone.</li>
<li>According to the <a href="https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-25">deprecated API migration guide of Kubernetes</a>, the <b>policy/v1beta1</b> API version of PodDisruptionBudget is no longer served as of v1.25. You are suggested to migrate manifests and API clients to use the <b>policy/v1</b> API version instead. <br>As a workaround for users who still use the <b>policy/v1beta1</b> API version of PodDisruptionBudget on Kubernetes v1.25 and later, you can instead run the following command to install Milvus:<br>
<li>According to the <a href="https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-25">deprecated API migration guide of Kubernetes</a>, the <b>policy/v1beta1</b> API version of PodDisruptionBudget is no longer served as of v1.25. You are suggested to migrate manifests and API clients to use the <b>policy/v1</b> API version instead. <br/>As a workaround for users who still use the <b>policy/v1beta1</b> API version of PodDisruptionBudget on Kubernetes v1.25 and later, you can instead run the following command to install Milvus:<br/>
<code>helm install my-release milvus/milvus --set pulsar.bookkeeper.pdb.usePolicy=false,pulsar.broker.pdb.usePolicy=false,pulsar.proxy.pdb.usePolicy=false,pulsar.zookeeper.pdb.usePolicy=false</code></li>
<li>See <a href="https://artifacthub.io/packages/helm/milvus/milvus">Milvus Helm Chart</a> and <a href="https://helm.sh/docs/">Helm</a> for more information.</li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion site/en/migrate/es2m.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ The following table describes the parameters in the example config file. For a f

| Parameter | Description |
| --- | --- |
| `target.mode` | Storage location for dumped files. Valid values:<br>- `local`: Store dumped files on local disks.<br>- `remote`: Store dumped files on object storage. |
| `target.mode` | Storage location for dumped files. Valid values:<br/>- `local`: Store dumped files on local disks.<br/>- `remote`: Store dumped files on object storage. |
| `target.remote.outputDir` | Output directory path in the cloud storage bucket. |
| `target.remote.cloud` | Cloud storage service provider. Example values: `aws`, `gcp`, `azure`. |
| `target.remote.region` | Cloud storage region. It can be any value if you use local MinIO. |
Expand Down
4 changes: 2 additions & 2 deletions site/en/migrate/f2m.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ The following table describes the parameters in the example config file. For a f

| Parameter | Description |
| --- | --- |
| `source.mode` | Specifies where the source files are read from. Valid values:<br>- `local`: reads files from a local disk.<br>- `remote`: reads files from remote storage. |
| `source.mode` | Specifies where the source files are read from. Valid values:<br/>- `local`: reads files from a local disk.<br/>- `remote`: reads files from remote storage. |
| `source.local.faissFile` | The directory path where the source files are located. For example, `/db/faiss.index`. |

- `target`
Expand All @@ -98,7 +98,7 @@ The following table describes the parameters in the example config file. For a f
| `target.create.collection.shardsNums` | Number of shards to be created in the collection. For more information on shards, refer to [Terminology](https://milvus.io/docs/glossary.md#Shard). |
| `target.create.collection.dim` | Dimension of the vector field. |
| `target.create.collection.metricType` | Metric type used to measure similarities between vectors. For more information, refer to [Terminology](https://milvus.io/docs/glossary.md#Metric-type). |
| `target.mode` | Storage location for dumped files. Valid values:<br>- `local`: Store dumped files on local disks.<br>- `remote`: Store dumped files on object storage. |
| `target.mode` | Storage location for dumped files. Valid values:<br/>- `local`: Store dumped files on local disks.<br/>- `remote`: Store dumped files on object storage. |
| `target.remote.outputDir` | Output directory path in the cloud storage bucket. |
| `target.remote.cloud` | Cloud storage service provider. Example values: `aws`, `gcp`, `azure`. |
| `target.remote.endpoint` | Endpoint of Milvus 2.x storage. |
Expand Down
4 changes: 2 additions & 2 deletions site/en/migrate/m2m.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,14 +114,14 @@ The following table describes the parameters in the example config file. For a f

| Parameter | Description |
| --- | --- |
| `source.mode` | Specifies where the source files are read from. Valid values:<br>- `local`: reads files from a local disk.<br>- `remote`: reads files from remote storage. |
| `source.mode` | Specifies where the source files are read from. Valid values:<br/>- `local`: reads files from a local disk.<br/>- `remote`: reads files from remote storage. |
| `source.local.tablesDir` | The directory path where the source files are located. For example, `/db/tables/`. |

- `target`

| Parameter | Description |
| --- | --- |
| `target.mode` | Storage location for dumped files. Valid values:<br>- `local`: Store dumped files on local disks.<br>- `remote`: Store dumped files on object storage. |
| `target.mode` | Storage location for dumped files. Valid values:<br/>- `local`: Store dumped files on local disks.<br/>- `remote`: Store dumped files on object storage. |
| `target.remote.outputDir` | Output directory path in the cloud storage bucket. |
| `target.remote.ak` | Access key for Milvus 2.x storage. |
| `target.remote.sk` | Secret key for Milvus 2.x storage. |
Expand Down
8 changes: 4 additions & 4 deletions site/en/reference/disk_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,10 @@ DiskIndex:

| Parameter | Description | Value Range | Default Value |
| --- | --- | --- | --- |
| `MaxDegree` | Maximum degree of the Vamana graph. <br> A larger value offers a higher recall rate but increases the size of and time to build the index. | [1, 512] | 56 |
| `SearchListSize` | Size of the candidate list. <br> A larger value increases the time spent on building the index but offers a higher recall rate. <br> Set it to a value smaller than `MaxDegree` unless you need to reduce the index-building time. | [1, int32_max] | 100 |
| `PQCodeBugetGBRatio` | Size limit on the PQ code. <br> A larger value offers a higher recall rate but increases memory usage. | (0.0, 0.25] | 0.125 |
| `SearchCacheBudgetGBRatio` | Ratio of cached node numbers to raw data. <br> A larger value improves index-building performance with increased memory usage. | [0.0, 0.3) | 0.10 |
| `MaxDegree` | Maximum degree of the Vamana graph. <br/> A larger value offers a higher recall rate but increases the size of and time to build the index. | [1, 512] | 56 |
| `SearchListSize` | Size of the candidate list. <br/> A larger value increases the time spent on building the index but offers a higher recall rate. <br/> Set it to a value smaller than `MaxDegree` unless you need to reduce the index-building time. | [1, int32_max] | 100 |
| `PQCodeBugetGBRatio` | Size limit on the PQ code. <br/> A larger value offers a higher recall rate but increases memory usage. | (0.0, 0.25] | 0.125 |
| `SearchCacheBudgetGBRatio` | Ratio of cached node numbers to raw data. <br/> A larger value improves index-building performance with increased memory usage. | [0.0, 0.3) | 0.10 |
| `BeamWidthRatio` | Ratio between the maximum number of IO requests per search iteration and CPU number. | [1, max(128 / CPU number, 16)] | 4.0 |

## Troubleshooting
Expand Down
Loading

0 comments on commit 4917695

Please sign in to comment.