diff --git a/site/en/guides/get_started/example_code.md b/site/en/guides/get_started/example_code.md index d70635a74..73528244e 100644 --- a/site/en/guides/get_started/example_code.md +++ b/site/en/guides/get_started/example_code.md @@ -14,7 +14,7 @@ After the Milvus server is successfully started, you can use this example progra ```shell # Install Milvus Python SDK - $ pip3 install pymilvus==0.2.12 + $ pip3 install pymilvus=={{var.milvus_python_sdk_version}} ``` > Note: To learn more about Milvus Python SDK, go to [Milvus Python SDK Readme](https://github.com/milvus-io/pymilvus/blob/master/README.md). @@ -23,10 +23,10 @@ After the Milvus server is successfully started, you can use this example progra ```shell # Download Python example - $ wget https://raw.githubusercontent.com/milvus-io/pymilvus/0.2.12/examples/example.py + $ wget https://raw.githubusercontent.com/milvus-io/pymilvus/{{var.milvus_python_sdk_version}}/examples/example.py ``` - > Note: If you cannot use `wget` to download the example code, you can also create `example.py` and copy the [example code](https://github.com/milvus-io/pymilvus/blob/0.9.1/examples/example.py). + > Note: If you cannot use `wget` to download the example code, you can also create `example.py` and copy the [example code](https://github.com/milvus-io/pymilvus/blob/{{var.milvus_python_sdk_version}}/examples/example.py). 4. Run the example code. diff --git a/site/en/guides/get_started/install_milvus/cpu_milvus_docker.md b/site/en/guides/get_started/install_milvus/cpu_milvus_docker.md index d5e7ab8c9..8924e7aa8 100644 --- a/site/en/guides/get_started/install_milvus/cpu_milvus_docker.md +++ b/site/en/guides/get_started/install_milvus/cpu_milvus_docker.md @@ -51,7 +51,7 @@ If you do not see the server listed, start the **Docker** daemon. Pull the CPU-only image: ```shell -$ docker pull milvusdb/milvus:0.9.1-cpu-d052920-e04ed5 +$ docker pull milvusdb/milvus:{{var.cpu_milvus_docker_image_version}} ``` > Note: If the pulling speed is too slow or the pulling process constantly fails, refer to [Operational FAQ](../../../faq/operational_faq.md) for possible solutions. @@ -61,23 +61,23 @@ $ docker pull milvusdb/milvus:0.9.1-cpu-d052920-e04ed5 ```shell $ mkdir -p /home/$USER/milvus/conf $ cd /home/$USER/milvus/conf -$ wget https://raw.githubusercontent.com/milvus-io/milvus/v0.9.1/core/conf/demo/server_config.yaml +$ wget https://raw.githubusercontent.com/milvus-io/milvus/v{{var.release_version}}/core/conf/demo/server_config.yaml ``` -> Note: In case you encounter problems downloading configuration files using `wget` command, you can also create `server_config.yaml` under `/home/$USER/milvus/conf`, then copy and paste the content from [server config file](https://github.com/milvus-io/milvus/blob/v0.9.1/core/conf/demo/server_config.yaml). +> Note: In case you encounter problems downloading configuration files using `wget` command, you can also create `server_config.yaml` under `/home/$USER/milvus/conf`, then copy and paste the content from [server config file](https://github.com/milvus-io/milvus/blob/v{{var.release_version}}/core/conf/demo/server_config.yaml). #### Step 4 Start Docker container ```shell -$ docker run -d --name milvus_cpu_0.9.1 \ +$ docker run -d --name milvus_cpu_{{var.release_version}} \ -p 19530:19530 \ -p 19121:19121 \ -v /home/$USER/milvus/db:/var/lib/milvus/db \ -v /home/$USER/milvus/conf:/var/lib/milvus/conf \ -v /home/$USER/milvus/logs:/var/lib/milvus/logs \ -v /home/$USER/milvus/wal:/var/lib/milvus/wal \ -milvusdb/milvus:0.9.1-cpu-d052920-e04ed5 +milvusdb/milvus:{{var.cpu_milvus_docker_image_version}} ``` The `docker run` options used in the above command are defined as follows: @@ -107,19 +107,19 @@ $ docker logs The procedures of installing Milvus on Windows are similar to the steps on Ubuntu/CentOS, except for **Step 3** and **Step 4**. -For Step 3, instead of using `wget` to obtain the files, it is suggested to create a `milvus` file containing `db`, `conf`, `logs`, and `wal` folders in a location you find appropriate, for example on the C drive, and copy the the content from [server config file](https://github.com/milvus-io/milvus/blob/v0.9.1/core/conf/demo/server_config.yaml) to `server_config.yaml` that you created under `C:\milvus\conf`. +For Step 3, instead of using `wget` to obtain the files, it is suggested to create a `milvus` file containing `db`, `conf`, `logs`, and `wal` folders in a location you find appropriate, for example on the C drive, and copy the the content from [server config file](https://github.com/milvus-io/milvus/blob/v{{var.release_version}}/core/conf/demo/server_config.yaml) to `server_config.yaml` that you created under `C:\milvus\conf`. For Step 4, start the docker by mapping Milvus files to the right path. The following command is run in Windows Command shell: ```shell -$ docker run -d --name milvus_cpu_0.9.1 \ +$ docker run -d --name milvus_cpu_{{var.release_version}} \ -p 19530:19530 \ -p 19121:19121 \ -v C:\milvus\db:/var/lib/milvus/db \ -v C:\milvus\conf:/var/lib/milvus/conf \ -v C:\milvus\logs:/var/lib/milvus/logs \ -v C:\milvus\wal:/var/lib/milvus/wal \ -milvusdb/milvus:0.9.1-cpu-d052920-e04ed5 +milvusdb/milvus:{{var.cpu_milvus_docker_image_version}} ``` ## Install Milvus on macOS @@ -131,20 +131,20 @@ For Step 3, the path has some minor differences: ```shell $ mkdir -p /Users/$USER/milvus/conf $ cd /Users/$USER/milvus/conf -$ wget https://raw.githubusercontent.com/milvus-io/milvus/v0.9.1/core/conf/demo/server_config.yaml +$ wget https://raw.githubusercontent.com/milvus-io/milvus/v{{var.release_version}}/core/conf/demo/server_config.yaml ``` For Step 4, start the docker by mapping Milvus files to the right path: ```shell -$ docker run -d --name milvus_cpu_0.9.1 \ +$ docker run -d --name milvus_cpu_{{var.release_version}} \ -p 19530:19530 \ -p 19121:19121 \ -v /Users/$USER/milvus/db:/var/lib/milvus/db \ -v /Users/$USER/milvus/conf:/var/lib/milvus/conf \ -v /Users/$USER/milvus/logs:/var/lib/milvus/logs \ -v /Users/$USER/milvus/wal:/var/lib/milvus/wal \ -milvusdb/milvus:0.9.1-cpu-d052920-e04ed5 +milvusdb/milvus:{{var.cpu_milvus_docker_image_version}} ``` ## What's next diff --git a/site/en/guides/get_started/install_milvus/gpu_milvus_docker.md b/site/en/guides/get_started/install_milvus/gpu_milvus_docker.md index 604121295..7151c9f13 100644 --- a/site/en/guides/get_started/install_milvus/gpu_milvus_docker.md +++ b/site/en/guides/get_started/install_milvus/gpu_milvus_docker.md @@ -48,7 +48,7 @@ If you do not see the server listed, start the **Docker** daemon. Pull the GPU-enabled image: ```shell -$ docker pull milvusdb/milvus:0.9.1-gpu-d052920-e04ed5 +$ docker pull milvusdb/milvus:{{var.gpu_milvus_docker_image_version}} ``` > Note: If the pulling speed is too slow or the pulling process constantly fails, refer to [Operational FAQ](../../../faq/operational_faq.md) for possible solutions. @@ -58,10 +58,10 @@ $ docker pull milvusdb/milvus:0.9.1-gpu-d052920-e04ed5 ```shell $ mkdir -p /home/$USER/milvus/conf $ cd /home/$USER/milvus/conf -$ wget https://raw.githubusercontent.com/milvus-io/milvus/v0.9.1/core/conf/demo/server_config.yaml +$ wget https://raw.githubusercontent.com/milvus-io/milvus/v{{var.release_version}}/core/conf/demo/server_config.yaml ``` -> Note: In case you encounter problems downloading configuration files using `wget` command, you can also create the `server_config.yaml` file under `/home/$USER/milvus/conf`, then copy and paste the content from [server config file](https://github.com/milvus-io/milvus/blob/v0.9.1/core/conf/demo/server_config.yaml). +> Note: In case you encounter problems downloading configuration files using `wget` command, you can also create the `server_config.yaml` file under `/home/$USER/milvus/conf`, then copy and paste the content from [server config file](https://github.com/milvus-io/milvus/blob/v{{var.release_version}}/core/conf/demo/server_config.yaml). ## Step 4 Start Docker container @@ -69,14 +69,14 @@ $ wget https://raw.githubusercontent.com/milvus-io/milvus/v0.9.1/core/conf/demo/ Before starting the Docker container, you must set `enable` to `true` in `gpu_resource_config` section of `server_config.yaml`. ```shell -$ docker run -d --name milvus_gpu_0.9.1 --gpus all \ +$ docker run -d --name milvus_gpu_{{var.release_version}} --gpus all \ -p 19530:19530 \ -p 19121:19121 \ -v /home/$USER/milvus/db:/var/lib/milvus/db \ -v /home/$USER/milvus/conf:/var/lib/milvus/conf \ -v /home/$USER/milvus/logs:/var/lib/milvus/logs \ -v /home/$USER/milvus/wal:/var/lib/milvus/wal \ -milvusdb/milvus:0.9.1-gpu-d052920-e04ed5 +milvusdb/milvus:{{var.gpu_milvus_docker_image_version}} ``` The `docker run` options used in the above command are defined as follows: @@ -115,6 +115,6 @@ $ docker logs - Build a [monitoring and alerting system](../../monitor.md) to check real-time application performance - Tune Milvus performance through [configuration](../../../reference/milvus_config.md) -- If you want to run Milvus on machines without GPU: +- If you want to run Milvus on machines without an Nvidia GPU: - [Install CPU-only Milvus](cpu_milvus_docker.md) diff --git a/site/en/guides/monitor.md b/site/en/guides/monitor.md index 49b182b49..8e9bcc8f1 100644 --- a/site/en/guides/monitor.md +++ b/site/en/guides/monitor.md @@ -75,10 +75,10 @@ Milvus generates detailed time series metrics. This page shows you how to pull t ### Configure Prometheus -1. Go to the Prometheus root directory, and download starter [Prometheus configuration file](https://github.com/milvus-io/docs/blob/v0.9.1/assets/monitoring/prometheus.yml) for Milvus. +1. Go to the Prometheus root directory, and download starter [Prometheus configuration file](https://github.com/milvus-io/docs/blob/v{{var.release_version}}/assets/monitoring/prometheus.yml) for Milvus. ```shell - $ wget https://raw.githubusercontent.com/milvus-io/docs/v0.9.1/assets/monitoring/prometheus.yml \ -O prometheus.yml + $ wget https://raw.githubusercontent.com/milvus-io/docs/v{{var.release_version}}/assets/monitoring/prometheus.yml \ -O prometheus.yml ``` @@ -86,10 +86,10 @@ Milvus generates detailed time series metrics. This page shows you how to pull t > Note: If you use distributed cluster, you must expand the `targets` field to include `localhost: ` for each additional node in the cluster. -3. Download starter [alerting rules](https://github.com/milvus-io/docs/blob/v0.9.1/assets/monitoring/alert_rules.yml) for Milvus to the Prometheus root directory. +3. Download starter [alerting rules](https://github.com/milvus-io/docs/blob/v{{var.release_version}}/assets/monitoring/alert_rules.yml) for Milvus to the Prometheus root directory. ```shell - wget -P rules https://raw.githubusercontent.com/milvus-io/docs/v0.9.1/assets/monitoring/alert_rules.yml + wget -P rules https://raw.githubusercontent.com/milvus-io/docs/v{{var.release_version}}/assets/monitoring/alert_rules.yml ``` @@ -128,10 +128,10 @@ Refer to [https://github.com/prometheus/pushgateway](https://github.com/promethe | URL | `http://:9090` | | Access | Browser | -5. Download the starter [Grafana dashboard](https://github.com/milvus-io/docs/blob/v0.9.1/assets/monitoring/dashboard.json) for Milvus: +5. Download the starter [Grafana dashboard](https://github.com/milvus-io/docs/blob/v{{var.release_version}}/assets/monitoring/dashboard.json) for Milvus: ```shell - $ wget https://raw.githubusercontent.com/milvus-io/docs/v0.9.1/assets/monitoring/dashboard.json + $ wget https://raw.githubusercontent.com/milvus-io/docs/v{{var.release_version}}/assets/monitoring/dashboard.json ``` diff --git a/site/en/milvus_admin/release_notes_admin.md b/site/en/milvus_admin/release_notes_admin.md index 1516f7bb3..9835082ae 100644 --- a/site/en/milvus_admin/release_notes_admin.md +++ b/site/en/milvus_admin/release_notes_admin.md @@ -21,7 +21,7 @@ Milvus Admin is the GUI client of Milvus. You can use Milvus Admin to perform op **Features** - Makes some UI changes to improve user experience. -- Displays connection infomation on top of the web page. +- Displays connection information on top of the web page. - Displays the connected Milvus version on the web page. - Compatible with the Milvus 0.9.0 APIs - Supports setting `auto_flush_interval` from `Advanced Setting` > `PERFORMANCE TUNNING` > `Auto Flush Interval`. diff --git a/site/en/variables.json b/site/en/variables.json index fa918053c..a12242b21 100644 --- a/site/en/variables.json +++ b/site/en/variables.json @@ -1,3 +1,8 @@ { - "a": 123 + "release_version": "0.9.1", + "cpu_milvus_docker_image_version": "0.9.1-cpu-d052920-e04ed5", + "gpu_milvus_docker_image_version": "0.9.1-gpu-d052920-e04ed5", + "milvus_python_sdk_version": "0.2.12", + "milvus_java_sdk_version": "0.8.1" + } \ No newline at end of file diff --git a/site/zh-CN/Tips.json b/site/zh-CN/Tips.json new file mode 100644 index 000000000..9c38168c6 --- /dev/null +++ b/site/zh-CN/Tips.json @@ -0,0 +1,3 @@ +{ + "collection": "asdasd" +} \ No newline at end of file diff --git a/site/zh-CN/Variables.json b/site/zh-CN/Variables.json new file mode 100644 index 000000000..a12242b21 --- /dev/null +++ b/site/zh-CN/Variables.json @@ -0,0 +1,8 @@ +{ + "release_version": "0.9.1", + "cpu_milvus_docker_image_version": "0.9.1-cpu-d052920-e04ed5", + "gpu_milvus_docker_image_version": "0.9.1-gpu-d052920-e04ed5", + "milvus_python_sdk_version": "0.2.12", + "milvus_java_sdk_version": "0.8.1" + +} \ No newline at end of file diff --git a/site/zh-CN/aboutmilvus/overview.md b/site/zh-CN/aboutmilvus/overview.md index c58be9652..3acb4a060 100644 --- a/site/zh-CN/aboutmilvus/overview.md +++ b/site/zh-CN/aboutmilvus/overview.md @@ -14,19 +14,19 @@ Milvus 是一款开源的特征向量相似度搜索引擎,具有使用方便 - 全面的相似度指标 - Milvus 支持各种常用的相似度计算指标,包括欧氏距离、内积、汉明距离和杰卡德距离等。您可以根据应用需求来选择最有效的向量相似度计算方式。 + Milvus 支持各种常用的相似度计算指标,包括欧氏距离、内积、汉明距离和杰卡德距离等。你可以根据应用需求来选择最有效的向量相似度计算方式。 - 业界领先的性能 - Milvus 基于高度优化的 Approximate Nearest Neighbor Search (ANNS) 索引库构建,包括 faiss、 annoy、和 hnswlib 等。您可以针对不同使用场景选择不同的索引类型。 + Milvus 基于高度优化的 Approximate Nearest Neighbor Search (ANNS) 索引库构建,包括 faiss、 annoy、和 hnswlib 等。你可以针对不同使用场景选择不同的索引类型。 - 动态数据管理 - 您可以随时对数据进行插入、删除、搜索、更新等操作而无需受到静态数据带来的困扰。 + 你可以随时对数据进行插入、删除、搜索、更新等操作而无需受到静态数据带来的困扰。 - 近实时搜索 - 在插入或更新数据之后,您可以几乎立刻对插入或更新过的数据进行搜索。Milvus 负责保证搜索结果的准确率和数据一致性。 + 在插入或更新数据之后,你可以几乎立刻对插入或更新过的数据进行搜索。Milvus 负责保证搜索结果的准确率和数据一致性。 - 高成本效益 @@ -34,15 +34,15 @@ Milvus 是一款开源的特征向量相似度搜索引擎,具有使用方便 - 支持多种数据类型和高级搜索(即将上线) - Milvus 的数据记录中的字段支持多种数据类型。您还可以对一个或多个字段使用高级搜索,例如过滤、排序和聚合。 + Milvus 的数据记录中的字段支持多种数据类型。你还可以对一个或多个字段使用高级搜索,例如过滤、排序和聚合。 - 高扩展性和可靠性 - 您可以在分布式环境中部署 Milvus。如果要对集群扩容或者增加可靠性,您只需增加节点。 + 你可以在分布式环境中部署 Milvus。如果要对集群扩容或者增加可靠性,你只需增加节点。 - 云原生 - 您可以轻松在公有云、私有云、或混合云上运行 Milvus。 + 你可以轻松在公有云、私有云、或混合云上运行 Milvus。 - 简单易用 @@ -53,7 +53,7 @@ Milvus 是一款开源的特征向量相似度搜索引擎,具有使用方便 ![Milvus 架构](../../../assets/milvus_arch.png) -## 接下来您可以 +## 接下来你可以 - 了解 [特征向量](vector.md), [向量数据库](vector_db.md) 的发展现状和 [向量检索算法](index_method.md) - 几分钟轻易搞定 [Milvus 安装](../guides/get_started/install_milvus/install_milvus.md) diff --git a/site/zh-CN/contribute/contribute.md b/site/zh-CN/contribute/contribute.md index 1c7381434..b4d28e50f 100644 --- a/site/zh-CN/contribute/contribute.md +++ b/site/zh-CN/contribute/contribute.md @@ -12,12 +12,12 @@ sidebar_label: Contribute 想要给 Milvus 贡献代码,请按照以下步骤进行: -1. 浏览现有的 issues 并找到您感兴趣的领域,或创建一个新的 issue 描述您的想法和改动。如果您是第一次提交贡献,我们建议您先从[带 `good first issues` 标签的 issues](https://github.com/milvus-io/milvus/labels/good%20first%20issue) 入手。 -2. 相关仓库的负责人会及时回复您的 issue。 -3. 如果您的更改建议被接受,请克隆主仓库(master)并开始您的工作。 +1. 浏览现有的 issues 并找到你感兴趣的领域,或创建一个新的 issue 描述你的想法和改动。如果你是第一次提交贡献,我们建议你先从[带 `good first issues` 标签的 issues](https://github.com/milvus-io/milvus/labels/good%20first%20issue) 入手。 +2. 相关仓库的负责人会及时回复你的 issue。 +3. 如果你的更改建议被接受,请克隆主仓库(master)并开始你的工作。 4. 确保更改通过所有测试之后,便可以提交 pull request 到主仓库。 -收到您提交的 pull request 之后,我们会及时 review 并回复,如果 pull request 通过批准且被合并,恭喜您,您已经成为 Milvus 贡献者! +收到你提交的 pull request 之后,我们会及时 review 并回复,如果 pull request 通过批准且被合并,恭喜你,你已经成为 Milvus 贡献者! ## 改进文档 diff --git a/site/zh-CN/faq/operational_faq.md b/site/zh-CN/faq/operational_faq.md index 7bd32ab47..cd547d614 100644 --- a/site/zh-CN/faq/operational_faq.md +++ b/site/zh-CN/faq/operational_faq.md @@ -38,7 +38,7 @@ sidebar_label: Operational FAQ #### 如果在安装 Milvus 时,从 dockerhub 拉取镜像总是失败怎么办? -某些地区的用户可能无法快速访问 dockerhub。如果拉取镜像失败,您可以从本地的镜像源拉取镜像。比如中国镜像源的网址为 `registry.docker-cn.com`。您可以在 `/etc/docker/daemon.json` 文件的 `registry-mirrors` 组添加 `"https://registry.docker-cn.com"`命令,这样就可以默认从中国镜像源拉取镜像了。 +某些地区的用户可能无法快速访问 dockerhub。如果拉取镜像失败,你可以从本地的镜像源拉取镜像。比如中国镜像源的网址为 `registry.docker-cn.com`。你可以在 `/etc/docker/daemon.json` 文件的 `registry-mirrors` 组添加 `"https://registry.docker-cn.com"`命令,这样就可以默认从中国镜像源拉取镜像了。 ```json { @@ -50,15 +50,15 @@ sidebar_label: Operational FAQ 原因可能有多种,但最可能的是环境因素,比如版本不匹配或者依赖关系缺失等。请参考 [从源码安装 Milvus](https://github.com/milvus-io/milvus/blob/master/INSTALL.md) 获取详细信息。 -建议您使用带有 Milvus 编译环境的 docker 镜像进行源码编译。关于详细流程请参考 [在 Docker 容器中编译运行 Milvus](https://www.milvus.io/cn/blogs/2019-11-25-docker-compilation.md)。 +建议你使用带有 Milvus 编译环境的 docker 镜像进行源码编译。关于详细流程请参考 [在 Docker 容器中编译运行 Milvus](https://www.milvus.io/cn/blogs/2019-11-25-docker-compilation.md)。 #### Milvus 对 collection 和 分区的数量有限制吗? -有。如果您使用 SQLite 作为元数据管理服务,则 Collection 和分区总数不能超过50000。如果您需要更多的 collection 和分区,请[使用 MySQL](../reference/data_manage.md)。 +有。如果你使用 SQLite 作为元数据管理服务,则 Collection 和分区总数不能超过50000。如果你需要更多的 collection 和分区,请[使用 MySQL](../reference/data_manage.md)。 #### 为什么 Milvus 返回 config check error 的错误? -您的 Milvus 服务端配置文件版本不正确。Milvus 0.7.0 仅支持 0.2 版本的配置文件 (`server_config.yaml`)。 +你的 Milvus 服务端配置文件版本不正确。Milvus 0.7.0 仅支持 0.2 版本的配置文件 (`server_config.yaml`)。 #### Milvus 支持对向量的插入、删除、更改和查询操作吗? @@ -73,13 +73,13 @@ sidebar_label: Operational FAQ #### 为什么欧氏距离和内积在计算向量相似度时的结果不一致? -如果欧氏距离和内积返回不一致的结果,您可能需要检查数据是否已经归一化。如果没有,请先对数据进行归一化。 +如果欧氏距离和内积返回不一致的结果,你可能需要检查数据是否已经归一化。如果没有,请先对数据进行归一化。 理论上可以证明,对于未归一化的数据,欧氏距离和内积的结果是不一致的。关于详细推导过程可参考 [数据归一化](https://github.com/milvus-io/bootcamp/blob/master/getting_started/data_preparation/data_normalization.md)。 #### 为什么在导入数据时 Milvus 显示 "no space left on device" 的错误? -您可能没有为导入数据预留足够的磁盘空间。例如,为1亿单精度向量构建 `FLAT` 或 `IVFLAT` 索引,需要预留约 200 GB 空间。对于 `IVF_SQ8` 索引,需要预留约 50 GB。 +你可能没有为导入数据预留足够的磁盘空间。例如,为1亿单精度向量构建 `FLAT` 或 `IVFLAT` 索引,需要预留约 200 GB 空间。对于 `IVF_SQ8` 索引,需要预留约 50 GB。 #### 为什么数据是二维数组时, Milvus Python SDK 依然返回 "Vectors should be 2-dim array" 的错误? @@ -120,15 +120,15 @@ $ docker logs #### 为什么我的 Milvus 在启动时返回 “Illegal instruction”? -如果您的 CPU 不支持 avx2 指令集,则 Milvus 无法正常启动。您可以通过 `cat /proc/cpuinfo` 查看 CPU 支持的指令集。 +如果你的 CPU 不支持 avx2 指令集,则 Milvus 无法正常启动。你可以通过 `cat /proc/cpuinfo` 查看 CPU 支持的指令集。 #### 为什么在 Mac OS 或者 Windows 上运行 Milvus 时显示 `cpu_cache_capacity` 太大? -您需要检查 macOS 或者 Windows 为 docker engine 分配的内存值。如果分配的内存值小于或等于 `cpu_cache_capacity`,尽管您的主机内存可能足够,但 Milvus 仍然无法正常运行。 +你需要检查 macOS 或者 Windows 为 docker engine 分配的内存值。如果分配的内存值小于或等于 `cpu_cache_capacity`,尽管你的主机内存可能足够,但 Milvus 仍然无法正常运行。 #### 为什么我的日志文件时间与系统时间不一致? -Docker 镜像内部的日志文件默认使用 UTC 时区。如果您宿主机的时区不是 UTC 时区,就会出现日志文件时间与系统时间不一致的情况。建议您查看宿主机上挂载的日志文件,这样可以保证宿主机上的日志文件和系统时间是一致的。 +Docker 镜像内部的日志文件默认使用 UTC 时区。如果你宿主机的时区不是 UTC 时区,就会出现日志文件时间与系统时间不一致的情况。建议你查看宿主机上挂载的日志文件,这样可以保证宿主机上的日志文件和系统时间是一致的。 #### 为什么我启用多进程程序失败了? @@ -143,11 +143,11 @@ Milvus 在运行过程中,能够实现多进程操作,但在实现时需满 如果 `nlist` 和 K 比较大,而 `nprobe` 又足够小时,有可能出现 `nprobe` 文件中的所有向量总数小于 K。当你搜索 top K 向量时,就会出现搜索结果小于 K 条向量的情况。 -想要避免这种情况,您可以尝试将 `nprobe` 设置为更大值,或是把 `nlist` 和 K 设置小一点。 +想要避免这种情况,你可以尝试将 `nprobe` 设置为更大值,或是把 `nlist` 和 K 设置小一点。 #### 在插入数据时我应该多久构建一次索引? -您应该避免频繁构建索引,因为这样会导致大量小索引文件的生成,从而影响检索效率。 +你应该避免频繁构建索引,因为这样会导致大量小索引文件的生成,从而影响检索效率。 #### Milvus 中的数据是如何存储的? @@ -167,7 +167,7 @@ Milvus 在运行过程中,能够实现多进程操作,但在实现时需满 - AVX2 - AVX512 -但是,您的 CPU 必须支持 AVX2 才能保证 Milvus 正常工作。 +但是,你的 CPU 必须支持 AVX2 才能保证 Milvus 正常工作。 #### 相关阅读 diff --git a/site/zh-CN/faq/performance_faq.md b/site/zh-CN/faq/performance_faq.md index 39a67aeef..6616c7e1f 100644 --- a/site/zh-CN/faq/performance_faq.md +++ b/site/zh-CN/faq/performance_faq.md @@ -16,7 +16,7 @@ sidebar_label: 性能常见问题 #### 为什么重启 Milvus 服务端之后,第一次搜索时间非常长? -您需要在 `server_config.yaml` 中开启 `preload_table`。在内存允许的情况下尽可能多地加载 collection。这样在每次重启服务端之后,数据都会先载入到 Milvus 中,可以解决第一次搜索耗时很长的问题。 +你需要在 `server_config.yaml` 中开启 `preload_table`。在内存允许的情况下尽可能多地加载 collection。这样在每次重启服务端之后,数据都会先载入到 Milvus 中,可以解决第一次搜索耗时很长的问题。 #### 为什么插入数据的速度很慢? @@ -32,7 +32,7 @@ sidebar_label: 性能常见问题 #### 为什么 GPU 一直空闲? -将 `gpu_search_threshold` 的值调整为您期望开启 GPU 搜索的批量查询的 nq 数(向量条数)。不建议在搜索量较小时使用 GPU 搜索。 +将 `gpu_search_threshold` 的值调整为你期望开启 GPU 搜索的批量查询的 nq 数(向量条数)。不建议在搜索量较小时使用 GPU 搜索。 #### 为什么我的数据插入后不可以马上被搜索到? diff --git a/site/zh-CN/faq/product_faq.md b/site/zh-CN/faq/product_faq.md index 85dceeef7..56f6f1340 100644 --- a/site/zh-CN/faq/product_faq.md +++ b/site/zh-CN/faq/product_faq.md @@ -30,7 +30,7 @@ sidebar_label: Product FAQ #### Milvus 0.7.0 支持旧版本的数据文件吗? -不支持。Milvus 0.7.0 无法直接使用旧版本的数据文件。您需要重新导入数据。 +不支持。Milvus 0.7.0 无法直接使用旧版本的数据文件。你需要重新导入数据。 #### Milvus 0.7.0 支持旧版本的服务端配置文件吗? @@ -46,7 +46,7 @@ Milvus 是一款开源的、针对海量特征向量的相似性搜索引擎。 #### Milvus 适合什么时候使用 ? -如果您想要可靠的海量向量相似性检索,以及亿级数据搜索的毫秒级响应,那 Milvus 将是您不二的选择。Milvus 一键安装、配置简易、运行可靠,保证数据准确性的同时,提供超高速的搜索响应。 +如果你想要可靠的海量向量相似性检索,以及亿级数据搜索的毫秒级响应,那 Milvus 将是你不二的选择。Milvus 一键安装、配置简易、运行可靠,保证数据准确性的同时,提供超高速的搜索响应。 Milvus 单行读取速度约 0.6 毫秒,单行写入速度在 0.03 毫秒左右。支持多种索引方式,优化了查询性能。Milvus 提供结构化和非结构化数据的混合查询方案。 @@ -58,7 +58,7 @@ Milvus 提供多种[客户端](../reference/sdk.md)。同时还支持所有基 Milvus 安装简单,仅需下载相关 docker 镜像文件。易用性强,通过 API 接口即可完成向量插入、删除、检索等操作。若要了解更多,请看 [安装 Milvus](../guides/get_started/install_milvus/install_milvus.md). -想要开启您的第一次向量搜索?请阅读 [运行示例程序](../guides/get_started/example_code.md). +想要开启你的第一次向量搜索?请阅读 [运行示例程序](../guides/get_started/example_code.md). #### Milvus 具备高可用特性吗? @@ -82,7 +82,7 @@ Milvus 提供了集群分片中间件 Mishards,可以实现集群分片部署 #### 数据存储在哪里? -向量数据导入 Milvus 后,将自动存储在您的本地磁盘。元数据可以存储在 MySQL 或 SQLite 上。 +向量数据导入 Milvus 后,将自动存储在你的本地磁盘。元数据可以存储在 MySQL 或 SQLite 上。 #### Milvus 与其他向量检索工具对比如何? @@ -90,11 +90,11 @@ Milvus 提供了集群分片中间件 Mishards,可以实现集群分片部署 #### Milvus 是一款端到端产品吗? -暂时还不是。Milvus 只能接受向量作为输入并通过查询输出向量。您无法使用 Milvus 从非结构化数据中提取向量。 +暂时还不是。Milvus 只能接受向量作为输入并通过查询输出向量。你无法使用 Milvus 从非结构化数据中提取向量。 #### 仍有问题没有得到解答? -如果您仍有其它问题,您可以: +如果你仍有其它问题,你可以: - 在 GitHub 上访问 [Milvus](https://github.com/milvus-io/milvus/issues) , 提问,分享交流,帮助其它用户 - 阅读 [操作常见问题](operational_faq.md),了解关于 Milvus 操作的常见问题 diff --git a/site/zh-CN/guides/get_started/example_code.md b/site/zh-CN/guides/get_started/example_code.md index 231263ff1..ea127c228 100644 --- a/site/zh-CN/guides/get_started/example_code.md +++ b/site/zh-CN/guides/get_started/example_code.md @@ -5,7 +5,7 @@ sidebar_label: Try an Example Program --- # 运行示例程序 -在 Milvus 服务端成功启动之后,您可以运行一个 Python 示例程序。这个示例程序将创建一个向量数据表,向其中插入10条向量,然后运行向量相似度查询。 +在 Milvus 服务端成功启动之后,你可以运行一个 Python 示例程序。这个示例程序将创建一个向量数据表,向其中插入 10 条向量,然后运行向量相似度查询。 1. 请确保系统已经安装了 [Python 3.5](https://www.python.org/downloads/) 和 [pip](https://pip.pypa.io/en/stable/installing/)。 @@ -13,7 +13,7 @@ sidebar_label: Try an Example Program ```shell # Install Milvus Python SDK - $ pip3 install pymilvus==0.2.12 + $ pip3 install pymilvus=={{var.milvus_python_sdk_version}} ``` > 提示:如果需要进一步了解 Milvus Python SDK,请参考 [Milvus Python SDK Readme](https://github.com/milvus-io/pymilvus/blob/master/README.md)。 @@ -22,10 +22,10 @@ sidebar_label: Try an Example Program ```shell # Download Python example - $ wget https://raw.githubusercontent.com/milvus-io/pymilvus/0.2.12/examples/example.py + $ wget https://raw.githubusercontent.com/milvus-io/pymilvus/{{var.milvus_python_sdk_version}}/examples/example.py ``` - > 注意:万一您遇到无法通过 `wget` 命令正常下载示例代码的情况,您也可以创建 `example.py` 文件并复制粘贴[示例代码](https://github.com/milvus-io/pymilvus/blob/0.9.1/examples/example.py)的内容。 + > 注意:万一你遇到无法通过 `wget` 命令正常下载示例代码的情况,你也可以创建 `example.py` 文件并复制粘贴[示例代码](https://github.com/milvus-io/pymilvus/blob/{{var.milvus_python_sdk_version}}/examples/example.py)的内容。 4. 运行示例代码。 @@ -40,9 +40,9 @@ sidebar_label: Try an Example Program Query result is correct. ``` - 恭喜您!您已经成功完成了在 Milvus 上的第一次向量相似度查询。 + 恭喜你!你已经成功完成了在 Milvus 上的第一次向量相似度查询。 -## 接下来您可以 +## 接下来你可以 - 了解更多 Milvus [基础操作](../milvus_operation.md) - [体验 Milvus 在线训练营](https://github.com/milvus-io/bootcamp),发现更多解决方案 diff --git a/site/zh-CN/guides/get_started/install_milvus/cpu_milvus_docker.md b/site/zh-CN/guides/get_started/install_milvus/cpu_milvus_docker.md index de4dfe6bc..1068af0d7 100644 --- a/site/zh-CN/guides/get_started/install_milvus/cpu_milvus_docker.md +++ b/site/zh-CN/guides/get_started/install_milvus/cpu_milvus_docker.md @@ -28,9 +28,9 @@ sidebar_label: Install CPU-only Milvus on Docker #### Milvus Docker 要求 -- 如果使用 Ubuntu 或 CentOS 安装 Milvus,请在您的宿主机上 [安装 Docker](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/) 19.03 或更高版本。 -- 如果在 Windows 上安装 Milvus,请安装 [Docker Desktop](https://docs.docker.com/docker-for-windows/install/),并进入 **Settings > Advanced** 调整相关配置。请确保‘可用内存’大于您在 `server_config.yaml` 文件中设置的`insert_buffer_size` 和 `cpu_cache_capacity` 之和。 -- 如果在 macOS 上安装 Milvus,请安装 [Docker Desktop for Mac](https://docs.docker.com/docker-for-mac/install/),并进入 **Preferences > Advanced** 调整相关配置。请确保‘可用内存’大于您在 `server_config.yaml` 文件中设置的`insert_buffer_size` 和 `cpu_cache_capacity` 之和。 +- 如果使用 Ubuntu 或 CentOS 安装 Milvus,请在你的宿主机上 [安装 Docker](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/) 19.03 或更高版本。 +- 如果在 Windows 上安装 Milvus,请安装 [Docker Desktop](https://docs.docker.com/docker-for-windows/install/),并进入 **Settings > Advanced** 调整相关配置。请确保‘可用内存’大于你在 `server_config.yaml` 文件中设置的`insert_buffer_size` 和 `cpu_cache_capacity` 之和。 +- 如果在 macOS 上安装 Milvus,请安装 [Docker Desktop for Mac](https://docs.docker.com/docker-for-mac/install/),并进入 **Preferences > Advanced** 调整相关配置。请确保‘可用内存’大于你在 `server_config.yaml` 文件中设置的`insert_buffer_size` 和 `cpu_cache_capacity` 之和。 ## 在 Ubuntu/CentOS 上安装 Milvus @@ -51,32 +51,32 @@ $ docker info 拉取仅需 CPU 的镜像: ```shell -$ docker pull milvusdb/milvus:0.9.1-cpu-d052920-e04ed5 +$ docker pull milvusdb/milvus:{{var.cpu_milvus_docker_image_version}} ``` -> 注意:如果您在拉取镜像时速度过慢或一直失败,请参考[操作常见问题](../../../faq/operational_faq.md)中提供的解决办法。 +> 注意:如果你在拉取镜像时速度过慢或一直失败,请参考[操作常见问题](../../../faq/operational_faq.md)中提供的解决办法。 #### 第三步 下载配置文件 ```shell $ mkdir -p /home/$USER/milvus/conf $ cd /home/$USER/milvus/conf -$ wget https://raw.githubusercontent.com/milvus-io/milvus/v0.9.1/core/conf/demo/server_config.yaml +$ wget https://raw.githubusercontent.com/milvus-io/milvus/v{{var.release_version}}/core/conf/demo/server_config.yaml ``` -> 注意:万一您遇到无法通过 `wget` 命令正常下载配置文件的情况,您也可以在 `/home/$USER/milvus/conf` 路径下创建 `server_config.yaml` 文件,然后复制粘贴 [server config 文件](https://github.com/milvus-io/milvus/blob/v0.9.1/core/conf/demo/server_config.yaml) 的内容。 +> 注意:万一你遇到无法通过 `wget` 命令正常下载配置文件的情况,你也可以在 `/home/$USER/milvus/conf` 路径下创建 `server_config.yaml` 文件,然后复制粘贴 [server config 文件](https://github.com/milvus-io/milvus/blob/v{{var.release_version}}/core/conf/demo/server_config.yaml) 的内容。 #### 第四步 启动 Milvus Docker 容器 ```shell -$ docker run -d --name milvus_cpu_0.9.1 \ +$ docker run -d --name milvus_cpu_{{var.release_version}} \ -p 19530:19530 \ -p 19121:19121 \ -v /home/$USER/milvus/db:/var/lib/milvus/db \ -v /home/$USER/milvus/conf:/var/lib/milvus/conf \ -v /home/$USER/milvus/logs:/var/lib/milvus/logs \ -v /home/$USER/milvus/wal:/var/lib/milvus/wal \ -milvusdb/milvus:0.9.1-cpu-d052920-e04ed5 +milvusdb/milvus:{{var.cpu_milvus_docker_image_version}} ``` 上述命令中用到的 `docker run` 参数定义如下: @@ -92,7 +92,7 @@ milvusdb/milvus:0.9.1-cpu-d052920-e04ed5 $ docker ps ``` -如果 Milvus 服务没有正常启动,您可以执行以下命令查询错误日志。 +如果 Milvus 服务没有正常启动,你可以执行以下命令查询错误日志。 ```shell # 获得运行 Milvus 的 container ID。 @@ -105,19 +105,19 @@ $ docker logs 在 Windows 上安装 Milvus 的步骤和在 Ubuntu/CentOS 上几乎一样,只不过 **第三步** 和 **第四步** 略有不同。 -在第三步中,不同于使用 `wget` 来获取配置文件,使用 Windows 安装时,建议在 C 盘,或其它合适的位置创建 `milvus` 文件夹,下面包含 `db`,`conf`,`logs` 和 `wal` 等文件夹,然后复制 [server config 文件](https://github.com/milvus-io/milvus/blob/v0.9.1/core/conf/demo/server_config.yaml) 的内容到您在 `C:\milvus\conf` 路径下创建的`server_config.yaml` 文件中。 +在第三步中,不同于使用 `wget` 来获取配置文件,使用 Windows 安装时,建议在 C 盘,或其它合适的位置创建 `milvus` 文件夹,下面包含 `db`,`conf`,`logs` 和 `wal` 等文件夹,然后复制 [server config 文件](https://github.com/milvus-io/milvus/blob/v{{var.release_version}}/core/conf/demo/server_config.yaml) 的内容到你在 `C:\milvus\conf` 路径下创建的`server_config.yaml` 文件中。 -第四步,启动 Docker 容器,将 Milvus 文件映射到您本地的文件路径。下面的命令是在命令提示符中运行的: +第四步,启动 Docker 容器,将 Milvus 文件映射到你本地的文件路径。下面的命令是在命令提示符中运行的: ```shell -$ docker run -d --name milvus_cpu_0.9.1 \ +$ docker run -d --name milvus_cpu_{{var.release_version}} \ -p 19530:19530 \ -p 19121:19121 \ -v C:\milvus\db:/var/lib/milvus/db \ -v C:\milvus\conf:/var/lib/milvus/conf \ -v C:\milvus\logs:/var/lib/milvus/logs \ -v C:\milvus\wal:/var/lib/milvus/wal \ -milvusdb/milvus:0.9.1-cpu-d052920-e04ed5 +milvusdb/milvus:{{var.cpu_milvus_docker_image_version}} ``` ## 在 macOS 上安装 Milvus @@ -129,35 +129,35 @@ milvusdb/milvus:0.9.1-cpu-d052920-e04ed5 ```shell $ mkdir -p /Users/$USER/milvus/conf $ cd /Users/$USER/milvus/conf -$ wget https://raw.githubusercontent.com/milvus-io/milvus/v0.9.1/core/conf/demo/server_config.yaml +$ wget https://raw.githubusercontent.com/milvus-io/milvus/v{{var.release_version}}/core/conf/demo/server_config.yaml ``` -第四步,启动 Docker 容器,将 Milvus 文件映射到您本地的文件路径: +第四步,启动 Docker 容器,将 Milvus 文件映射到你本地的文件路径: ```shell -$ docker run -d --name milvus_cpu_0.9.1 \ +$ docker run -d --name milvus_cpu_{{var.release_version}} \ -p 19530:19530 \ -p 19121:19121 \ -v /Users/$USER/milvus/db:/var/lib/milvus/db \ -v /Users/$USER/milvus/conf:/var/lib/milvus/conf \ -v /Users/$USER/milvus/logs:/var/lib/milvus/logs \ -v /Users/$USER/milvus/wal:/var/lib/milvus/wal \ -milvusdb/milvus:0.9.1-cpu-d052920-e04ed5 +milvusdb/milvus:{{var.cpu_milvus_docker_image_version}} ``` -## 接下来您可以 +## 接下来你可以 -- 如果您刚开始了解 Milvus: +- 如果你刚开始了解 Milvus: - [运行示例程序](../example_code.md) - [了解更多 Milvus 操作](../../milvus_operation.md) - [体验 Milvus 在线训练营](https://github.com/milvus-io/bootcamp) -- 如果您已准备好在生产环境中部署 Milvus: +- 如果你已准备好在生产环境中部署 Milvus: - 创建 [监控与报警系统](../../monitor.md) 实时查看系统表现 - [设置 Milvus 参数](../../../reference/milvus_config.md) -- 如果您想使用针对大数据集搜索的 GPU 加速版 Milvus: +- 如果你想使用针对大数据集搜索的 GPU 加速版 Milvus: - [安装支持 GPU 加速版 Milvus](gpu_milvus_docker.md) diff --git a/site/zh-CN/guides/get_started/install_milvus/gpu_milvus_docker.md b/site/zh-CN/guides/get_started/install_milvus/gpu_milvus_docker.md index 2737008aa..bf8e7822b 100644 --- a/site/zh-CN/guides/get_started/install_milvus/gpu_milvus_docker.md +++ b/site/zh-CN/guides/get_started/install_milvus/gpu_milvus_docker.md @@ -27,7 +27,7 @@ sidebar_label: Install GPU-enabled Milvus on Docker #### Milvus Docker 要求 -- 在您的宿主机上安装 [Docker](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/) 19.03 或更高版本。 +- 在你的宿主机上安装 [Docker](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/) 19.03 或更高版本。 - 安装 NVIDIA driver 418 或更高版本。 - 安装 [NVIDIA Docker](https://github.com/NVIDIA/nvidia-docker)。 @@ -48,37 +48,37 @@ $ docker info 拉取支持 GPU 的镜像: ```shell -$ docker pull milvusdb/milvus:0.9.1-gpu-d052920-e04ed5 +$ docker pull milvusdb/milvus:{{var.gpu_milvus_docker_image_version}} ``` -> 注意:如果您在拉取镜像时速度过慢或一直失败,请参考 [操作常见问题](../../../faq/operational_faq.md) 中提供的解决办法。 +> 注意:如果你在拉取镜像时速度过慢或一直失败,请参考 [操作常见问题](../../../faq/operational_faq.md) 中提供的解决办法。 ## 第三步 下载并修改配置文件 -您可以使用以下方法下载配置文件: +你可以使用以下方法下载配置文件: ```shell $ mkdir -p /home/$USER/milvus/conf $ cd /home/$USER/milvus/conf -$ wget https://raw.githubusercontent.com/milvus-io/milvus/v0.9.1/core/conf/demo/server_config.yaml +$ wget https://raw.githubusercontent.com/milvus-io/milvus/v{{var.release_version}}/core/conf/demo/server_config.yaml ``` -> 注意:万一您遇到无法通过 `wget` 命令正常下载配置文件的情况,您也可以在 `/home/$USER/milvus/conf` 路径下创建 `server_config.yaml` 文件,然后复制粘贴 [server config 文件](https://github.com/milvus-io/milvus/blob/v0.9.1/core/conf/demo/server_config.yaml) 的内容。 +> 注意:万一你遇到无法通过 `wget` 命令正常下载配置文件的情况,你也可以在 `/home/$USER/milvus/conf` 路径下创建 `server_config.yaml` 文件,然后复制粘贴 [server config 文件](https://github.com/milvus-io/milvus/blob/v{{var.release_version}}/core/conf/demo/server_config.yaml) 的内容。 -配置文件下载完成后,您需要将 `server_config.yaml` 中的 `gpu_resource_config` 部分的 `enable` 参数设置为 `true`。 +配置文件下载完成后,你需要将 `server_config.yaml` 中的 `gpu_resource_config` 部分的 `enable` 参数设置为 `true`。 ## 第四步 启动 Milvus Docker 容器 ```shell -$ docker run -d --name milvus_gpu_0.9.1 --gpus all \ +$ docker run -d --name milvus_gpu_{{var.release_version}} --gpus all \ -p 19530:19530 \ -p 19121:19121 \ -v /home/$USER/milvus/db:/var/lib/milvus/db \ -v /home/$USER/milvus/conf:/var/lib/milvus/conf \ -v /home/$USER/milvus/logs:/var/lib/milvus/logs \ -v /home/$USER/milvus/wal:/var/lib/milvus/wal \ -milvusdb/milvus:0.9.1-gpu-d052920-e04ed5 +milvusdb/milvus:{{var.gpu_milvus_docker_image_version}} ``` 上述命令中用到的 `docker run` 参数定义如下: @@ -95,7 +95,7 @@ milvusdb/milvus:0.9.1-gpu-d052920-e04ed5 $ docker ps ``` -如果 Milvus 服务没有正常启动,您可以执行以下命令查询错误日志。 +如果 Milvus 服务没有正常启动,你可以执行以下命令查询错误日志。 ```shell # 获得运行 Milvus 的 container ID。 @@ -104,20 +104,20 @@ $ docker ps -a $ docker logs ``` -## 接下来您可以 +## 接下来你可以 -- 如果您刚开始了解 Milvus: +- 如果你刚开始了解 Milvus: - [运行示例程序](../example_code.md) - [了解更多 Milvus 操作](../../milvus_operation.md) - [体验 Milvus 在线训练营](https://github.com/milvus-io/bootcamp) -- 如果您已准备好在生产环境中部署 Milvus: +- 如果你已准备好在生产环境中部署 Milvus: - 创建 [监控与报警系统](../../monitor.md) 实时查看系统表现 - [设置 Milvus 参数](../../../reference/milvus_config.md) -- 如果您想在仅有 CPU 的环境下使用 Milvus: +- 如果你想在仅有 CPU 的环境下使用 Milvus: - [安装仅需 CPU 的 Milvus](cpu_milvus_docker.md) diff --git a/site/zh-CN/guides/get_started/install_milvus/install_milvus.md b/site/zh-CN/guides/get_started/install_milvus/install_milvus.md index 7aee8735e..8bef4620b 100644 --- a/site/zh-CN/guides/get_started/install_milvus/install_milvus.md +++ b/site/zh-CN/guides/get_started/install_milvus/install_milvus.md @@ -18,7 +18,7 @@ Milvus 中的向量搜索包含但不限于这两个独立的部分:创建索 ### 离线传输 Docker 镜像和配置文件 -如果您的主机由于网络限制无法在线获得 Docker 镜像和配置文件,请从其他主机在线获取并使用以下方法离线传输。关于如何获取 Docker 镜像请参考具体安装步骤。在这里假设您的镜像标签是 `milvusdb/milvus`。 +如果你的主机由于网络限制无法在线获得 Docker 镜像和配置文件,请从其他主机在线获取并使用以下方法离线传输。关于如何获取 Docker 镜像请参考具体安装步骤。在这里假设你的镜像标签是 `milvusdb/milvus`。 #### 离线传输 Docker 镜像 @@ -36,21 +36,21 @@ Milvus 中的向量搜索包含但不限于这两个独立的部分:创建索 #### 离线传输配置文件 -您可以下载配置文件并使用合适的方式传输。关于如何下载配置文件请参考具体安装步骤。 +你可以下载配置文件并使用合适的方式传输。关于如何下载配置文件请参考具体安装步骤。 ## 从源代码编译 请参考[从源代码编译 Milvus](https://github.com/milvus-io/milvus/blob/master/INSTALL.md)了解如何从源代码编译。 -## 接下来您可以 +## 接下来你可以 -- 如果您刚开始了解 Milvus: +- 如果你刚开始了解 Milvus: - [运行示例程序](../example_code.md) - [了解更多 Milvus 操作](../../milvus_operation.md) - [体验 Milvus 在线训练营](https://github.com/milvus-io/bootcamp) -- 如果您已准备好在生产环境中部署 Milvus: +- 如果你已准备好在生产环境中部署 Milvus: - [配置 Milvus 以用于生产环境](../../../reference/performance_tuning.md) - 创建 [监控与报警系统](../../monitor.md) 实时监控系统性能 diff --git a/site/zh-CN/guides/index.md b/site/zh-CN/guides/index.md index 59cc28e77..44c7581fd 100644 --- a/site/zh-CN/guides/index.md +++ b/site/zh-CN/guides/index.md @@ -94,6 +94,6 @@ sidebar_label: Index Types ## 如何选择索引 -若要为您的使用场景选择合适的索引,请参阅 [如何选择索引类型](https://milvus.io/cn/blogs/2019-12-03-select-index.md)。 +若要为你的使用场景选择合适的索引,请参阅 [如何选择索引类型](https://milvus.io/cn/blogs/2019-12-03-select-index.md)。 关于索引和向量距离计算方法的选择,请访问 [距离计算方式](metric.md)。 diff --git a/site/zh-CN/guides/milvus_operation.md b/site/zh-CN/guides/milvus_operation.md index e0220728f..82b29d750 100644 --- a/site/zh-CN/guides/milvus_operation.md +++ b/site/zh-CN/guides/milvus_operation.md @@ -6,11 +6,11 @@ sidebar_label: Learn Milvus Operations # Milvus 基本操作 -该页面将向您展示如何使用 [Python SDK](https://github.com/milvus-io/pymilvus) 运行 Milvus 基本操作。关于详细的 API 参考信息,请参考 [Python API 文档](https://github.com/milvus-io/pymilvus)。 +该页面将向你展示如何使用 [Python SDK](https://github.com/milvus-io/pymilvus) 运行 Milvus 基本操作。关于详细的 API 参考信息,请参考 [Python API 文档](https://github.com/milvus-io/pymilvus)。 -您也可以使用其它客户端,例如 [Java](https://github.com/milvus-io/milvus-sdk-java), [C++](https://github.com/milvus-io/milvus/tree/master/sdk), [Go](https://github.com/milvus-io/milvus-sdk-go), 或 [RESTful](https://github.com/milvus-io/milvus/tree/master/core/src/server/web_impl). +你也可以使用其它客户端,例如 [Java](https://github.com/milvus-io/milvus-sdk-java), [C++](https://github.com/milvus-io/milvus/tree/master/sdk), [Go](https://github.com/milvus-io/milvus-sdk-go), 或 [RESTful](https://github.com/milvus-io/milvus/tree/master/core/src/server/web_impl). -> 注意:建议您使用[资源评估工具](https://milvus.io/tools/sizing)来估算数据所需的硬件资源。 +> 注意:建议你使用[资源评估工具](https://milvus.io/tools/sizing)来估算数据所需的硬件资源。 ## 连接 Milvus 服务端 @@ -28,7 +28,7 @@ sidebar_label: Learn Milvus Operations >>> milvus = Milvus(host='localhost', port='19530') ``` - > 注意:在上面的代码中,`host` 和 `port` 都使用了默认值。您可以将其更改为自己设定的 IP 地址和端口。 + > 注意:在上面的代码中,`host` 和 `port` 都使用了默认值。你可以将其更改为自己设定的 IP 地址和端口。 ```python >>> milvus = Milvus(uri='tcp://localhost:19530') @@ -54,7 +54,7 @@ sidebar_label: Learn Milvus Operations #### 获取 collection 的统计信息 -您可以调用如下接口查询 collection 的统计信息。查询结果的信息包含 collection /分区/ segment 的向量数量,存储使用量等信息。 +你可以调用如下接口查询 collection 的统计信息。查询结果的信息包含 collection /分区/ segment 的向量数量,存储使用量等信息。 ```python >>> milvus.get_collection_stats('test01') @@ -73,7 +73,7 @@ sidebar_label: Learn Milvus Operations #### 创建分区 -您可以通过标签将 collection 分割为若干个分区,从而提高搜索效率。每个分区实际上也是一个 collection 。 +你可以通过标签将 collection 分割为若干个分区,从而提高搜索效率。每个分区实际上也是一个 collection 。 ```python # Create partition @@ -136,14 +136,14 @@ sidebar_label: Learn Milvus Operations >>> vectors = [[random.random() for _ in range(dim)] for _ in range(20)] ``` -2. 插入向量列表。如果您不指定向量 ID,Milvus 自动为向量分配 ID。 +2. 插入向量列表。如果你不指定向量 ID,Milvus 自动为向量分配 ID。 ```python # Insert vectors >>> milvus.insert(collection_name='test01', records=vectors) ``` - 您也可以自己定义向量 ID: + 你也可以自己定义向量 ID: ```python >>> vector_ids = [id for id in range(20)] @@ -158,13 +158,13 @@ sidebar_label: Learn Milvus Operations #### 通过 ID 删除向量 -假设您的 collection 中存在以下向量 ID: +假设你的 collection 中存在以下向量 ID: ```python >>> ids = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19] ``` -您可以通过以下命令删除向量: +你可以通过以下命令删除向量: ```python >>> milvus.delete_entity_by_id(collection_name='test01', id_array=ids) @@ -172,7 +172,7 @@ sidebar_label: Learn Milvus Operations #### 通过 ID 获取向量 -您也可以根据向量 ID 获取向量: +你也可以根据向量 ID 获取向量: ```python >>> status, vector = milvus.get_entity_by_id(collection_name='test01', ids=ids[:10]) @@ -180,7 +180,7 @@ sidebar_label: Learn Milvus Operations ## 将 collection 中的数据进行 flush 操作 -当您在进行有关数据更改的操作时,您可以将 collection 中的数据从内存中进行 flush 操作使数据落盘。Milvus 也会执行自动 flush。自动 flush 会在固定的时间周期(1 秒)将所有现存 collection 的数据进行 flush 操作。 +当你在进行有关数据更改的操作时,你可以将 collection 中的数据从内存中进行 flush 操作使数据落盘。Milvus 也会执行自动 flush。自动 flush 会在固定的时间周期(1 秒)将所有现存 collection 的数据进行 flush 操作。 ```python >>> milvus.flush(collection_name_array=['test01']) @@ -188,7 +188,7 @@ sidebar_label: Learn Milvus Operations ## 对 collection 中的 segment 进行 compact 操作 -Segment 是 Milvus 自动将插入的向量数据合并所获得的数据文件。一个 collection 可包含多个 segment 。如果一个 segment 中的向量数据被删除,被删除的向量数据占据的空间并不会自动释放。您可以对 collection 中的 segment 进行 compact 操作以释放多余空间。 +Segment 是 Milvus 自动将插入的向量数据合并所获得的数据文件。一个 collection 可包含多个 segment 。如果一个 segment 中的向量数据被删除,被删除的向量数据占据的空间并不会自动释放。你可以对 collection 中的 segment 进行 compact 操作以释放多余空间。 ```python >>> milvus.compact(collection_name='test01', timeout='1') @@ -196,7 +196,7 @@ Segment 是 Milvus 自动将插入的向量数据合并所获得的数据文件 ## 获取 segment 中的向量 ID -您可以获取指定 segment 中向量 ID 信息。您需要提供 segment 的名称。 segment 的名称可以从 `get_collection_stats` 中获取。 +你可以获取指定 segment 中向量 ID 信息。你需要提供 segment 的名称。 segment 的名称可以从 `get_collection_stats` 中获取。 ```python >>> milvus.list_id_in_segment('test01', '1583727470444700000') @@ -240,7 +240,7 @@ Segment 是 Milvus 自动将插入的向量数据合并所获得的数据文件 >>> milvus.search(collection_name='test01', query_records=q_records, top_k=1, partition_tags=['tag01'], params=search_param) ``` -> 注意:如果您不指定 `partition_tags`, Milvus 会在整个 collection 中搜索。 +> 注意:如果你不指定 `partition_tags`, Milvus 会在整个 collection 中搜索。 ## 关闭客户端 @@ -248,7 +248,7 @@ Segment 是 Milvus 自动将插入的向量数据合并所获得的数据文件 >>> milvus.close() ``` -## 接下来您可以 +## 接下来你可以 - [体验 Milvus 在线训练营](https://github.com/milvus-io/bootcamp) 了解更多解决方案 - [故障诊断 API 行为](troubleshoot.md) diff --git a/site/zh-CN/guides/monitor.md b/site/zh-CN/guides/monitor.md index ec4d09034..ded491445 100644 --- a/site/zh-CN/guides/monitor.md +++ b/site/zh-CN/guides/monitor.md @@ -54,12 +54,12 @@ Milvus 使用 Prometheus 作为监控和性能指标存储方案,使用 Grafan ## 使用 Prometheus 和 Alertmanager -Milvus 会生成详细的关于系统运行状态的时序 metrics。该页面向您展示如何利用 [Prometheus](https://prometheus.io/) 提取收集这些 metrics,如何将 [Grafana](https://grafana.com/) 和 [Alertmanager](https://prometheus.io/docs/alerting/alertmanager/) 连接到 Prometheus 实现数据可视化的展示和报警机制。 +Milvus 会生成详细的关于系统运行状态的时序 metrics。该页面向你展示如何利用 [Prometheus](https://prometheus.io/) 提取收集这些 metrics,如何将 [Grafana](https://grafana.com/) 和 [Alertmanager](https://prometheus.io/docs/alerting/alertmanager/) 连接到 Prometheus 实现数据可视化的展示和报警机制。 ### 前提条件 -- 请确保您已经启动了 Milvus 服务。 -- 请确保您已经启用了 Milvus 的监控功能。 +- 请确保你已经启动了 Milvus 服务。 +- 请确保你已经启用了 Milvus 的监控功能。 ### 安装 Prometheus @@ -71,24 +71,24 @@ Milvus 会生成详细的关于系统运行状态的时序 metrics。该页面 $ prometheus --version ``` - > 建议:您可以提取 Prometheus binary 并添加到 `PATH` ,以便在任意 Shell 上都能快速启动 Prometheus。 + > 建议:你可以提取 Prometheus binary 并添加到 `PATH` ,以便在任意 Shell 上都能快速启动 Prometheus。 ### 设置 Prometheus -1. 下载 Milvus [Prometheus 配置文件](https://github.com/milvus-io/docs/blob/v0.9.1/assets/monitoring/prometheus.yml) 。 +1. 下载 Milvus [Prometheus 配置文件](https://github.com/milvus-io/docs/blob/v{{var.release_version}}/assets/monitoring/prometheus.yml) 。 ```shell - $ wget https://raw.githubusercontent.com/milvus-io/docs/v0.9.1/assets/monitoring/prometheus.yml \ -O prometheus.yml + $ wget https://raw.githubusercontent.com/milvus-io/docs/v{{var.release_version}}/assets/monitoring/prometheus.yml \ -O prometheus.yml ``` -2. 根据您的需求编辑配置文件。参考 [https://prometheus.io/docs/prometheus/latest/configuration/configuration/](https://prometheus.io/docs/prometheus/latest/configuration/configuration/) 了解更多关于 Prometheus 配置文件的信息。 +2. 根据你的需求编辑配置文件。参考 [https://prometheus.io/docs/prometheus/latest/configuration/configuration/](https://prometheus.io/docs/prometheus/latest/configuration/configuration/) 了解更多关于 Prometheus 配置文件的信息。 - > 注意:如果您使用了分布式集群,则需要在 `job_name = 'milvus_server'` 下的 `targets` 字段,为集群中的每个节点分布添加相应的 `localhost: ` 。 + > 注意:如果你使用了分布式集群,则需要在 `job_name = 'milvus_server'` 下的 `targets` 字段,为集群中的每个节点分布添加相应的 `localhost: ` 。 -3. 下载 Milvus [报警规则文件](https://github.com/milvus-io/docs/blob/v0.9.1/assets/monitoring/alert_rules.yml) 到 Prometheus 根目录。 +3. 下载 Milvus [报警规则文件](https://github.com/milvus-io/docs/blob/v{{var.release_version}}/assets/monitoring/alert_rules.yml) 到 Prometheus 根目录。 ```shell - wget -P rules https://raw.githubusercontent.com/milvus-io/docs/v0.9.1/assets/monitoring/alert_rules.yml + wget -P rules https://raw.githubusercontent.com/milvus-io/docs/v{{var.release_version}}/assets/monitoring/alert_rules.yml ``` ### 启动 Prometheus @@ -113,7 +113,7 @@ Milvus 会生成详细的关于系统运行状态的时序 metrics。该页面 $ docker run -i -p 3000:3000 grafana/grafana ``` -2. 将浏览器指向 `http://:3000` ,使用默认的用户名/密码,`admin/admin`,登录 Grafana 用户交互页面。您也可以在此创建新的 Grafana 账号。 +2. 将浏览器指向 `http://:3000` ,使用默认的用户名/密码,`admin/admin`,登录 Grafana 用户交互页面。你也可以在此创建新的 Grafana 账号。 3. [添加 Prometheus 作为 data source](https://grafana.com/docs/grafana/latest/features/datasources/prometheus/). @@ -126,17 +126,17 @@ Milvus 会生成详细的关于系统运行状态的时序 metrics。该页面 | URL | `http://:9090` | | Access | Browser | -5. 下载 [Grafana 配置文件](https://github.com/milvus-io/docs/blob/v0.9.1/assets/monitoring/dashboard.json) : +5. 下载 [Grafana 配置文件](https://github.com/milvus-io/docs/blob/v{{var.release_version}}/assets/monitoring/dashboard.json) : ```shell - $ wget https://raw.githubusercontent.com/milvus-io/docs/v0.9.1/assets/monitoring/dashboard.json + $ wget https://raw.githubusercontent.com/milvus-io/docs/v{{var.release_version}}/assets/monitoring/dashboard.json ``` 6. [将配置文件导入 Grafana](http://docs.grafana.org/reference/export_import/#importing-a-dashboard). ### 使用 Alertmanager 发送通知 -在 Prometheus 配置,您已经下载了 Milvus 的报警规则文件。现在,您只需要下载、配置并启动 Alertmanager。 +在 Prometheus 配置,你已经下载了 Milvus 的报警规则文件。现在,你只需要下载、配置并启动 Alertmanager。 1. 下载 [最新 Alertmanager tarball](https://prometheus.io/download/#alertmanager) 。 @@ -146,7 +146,7 @@ Milvus 会生成详细的关于系统运行状态的时序 metrics。该页面 $ alertmanager --version ``` - > 建议:您可以提取 Alertmanager binary 并添加到 `PATH` ,以便在任意 Shell 上都能快速启动 Alertmanager。 + > 建议:你可以提取 Alertmanager binary 并添加到 `PATH` ,以便在任意 Shell 上都能快速启动 Alertmanager。 3. 创建 [Alertmanager 配置文件](https://prometheus.io/docs/alerting/configuration/) 来指定接受报警通知的邮箱/微信账户,并将配置文件添加到 Alertmanager 根目录下。 @@ -156,7 +156,7 @@ Milvus 会生成详细的关于系统运行状态的时序 metrics。该页面 alertmanager --config.file=simple.yml ``` -5. 将浏览器指向 `http://:9093` ,进入 Alertmanager 用户交互页面。您可以在此定义 [muting alerts](https://prometheus.io/docs/alerting/alertmanager/#silences) 的条件。 +5. 将浏览器指向 `http://:9093` ,进入 Alertmanager 用户交互页面。你可以在此定义 [muting alerts](https://prometheus.io/docs/alerting/alertmanager/#silences) 的条件。 ## 相关阅读 diff --git a/site/zh-CN/guides/preface.md b/site/zh-CN/guides/preface.md index e906f9b4b..a4e9cd5dd 100644 --- a/site/zh-CN/guides/preface.md +++ b/site/zh-CN/guides/preface.md @@ -9,17 +9,17 @@ sidebar_label: Preface ## 概述 -本文档向您介绍如何对Milvus进行安装、设置与使用。 +本文档向你介绍如何安装、设置与使用 Milvus。 -如果您需要获取任何帮助,欢迎在 GitHub 上 [创建 issue](https://github.com/milvus-io/milvus/issues/new/choose ) 或 [加入我们的 Slack 社区](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk) 参与讨论。 +如果你需要获取任何帮助,欢迎在 GitHub 上 [创建 issue](https://github.com/milvus-io/milvus/issues/new/choose ) 或 [加入我们的 Slack 社区](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk) 参与讨论。 若要了解 Milvus 的产品优势,请参考 [与其他向量检索工具对比](../aboutmilvus/vector_db.md)。 ## 声明 -本软件及相关文档根据许可协议提供,该协议包含对使用和披露的限制,并受知识产权法保护。 除非您的许可协议明确允许或法律允许,否则您不得以任何形式使用、复制、翻译、传播、修改、许可、分派、再授权、发布或再版任何部分。除非法律要求互操作性,否则禁止对该软件进行反向编译、反向工程、破解产品的任何部分或试图发现有关产品的任何源代码、基本理念或运算方法。 +本软件及相关文档根据许可协议提供,该协议包含对使用和披露的限制,并受知识产权法保护。 除非你的许可协议明确允许或法律允许,否则你不得以任何形式使用、复制、翻译、传播、修改、许可、分派、再授权、发布或再版任何部分。除非法律要求互操作性,否则禁止对该软件进行反向编译、反向工程、破解产品的任何部分或试图发现有关产品的任何源代码、基本理念或运算方法。 -此处包含的信息如有更改,恕不另行通知,并且不保证没有错误。如果您发现任何错误,请以书面形式告知我们。 +此处包含的信息如有更改,恕不另行通知,并且不保证没有错误。如果你发现任何错误,请以书面形式告知我们。 本文档内容仅作为指导使用,文档中的所有内容不构成任何明示或暗示的担保。 @@ -31,5 +31,5 @@ sidebar_label: Preface | 代码体 | 代码体指代文件名和路径,参数名称和参数值,功能名称等。| | 代码块 | 代码块指代文章里出现的代码或命令。 | | 粗体 | 粗体字指代标题,用户交互界面文字,以及需要特别强调的内容文字。 | -| 注意 | 注意指代一条有用的补充说明,帮助您更高效地工作。 | -| 警告 | 警告通常指出一个您需要特别注意的问题。它指出可能导致失败或问题的可能操作。| +| 注意 | 注意指代一条有用的补充说明,帮助你更高效地工作。 | +| 警告 | 警告通常指出一个你需要特别注意的问题。它指出可能导致失败或问题的可能操作。| diff --git a/site/zh-CN/guides/troubleshoot.md b/site/zh-CN/guides/troubleshoot.md index a8b830430..dc9021642 100644 --- a/site/zh-CN/guides/troubleshoot.md +++ b/site/zh-CN/guides/troubleshoot.md @@ -12,7 +12,7 @@ sidebar_label: Troubleshoot - 服务启动问题 - 服务启动时发生的故障,通常会导致服务无法正常启动。您可以通过以下命令来查看相关错误信息: + 服务启动时发生的故障,通常会导致服务无法正常启动。你可以通过以下命令来查看相关错误信息: ```shell $ docker logs @@ -26,15 +26,15 @@ sidebar_label: Troubleshoot 通过 API 使用 Milvus 时发生的故障。这类错误信息将实时返回给客户端。 -对于您无法自己解决的问题,您可以: +对于你无法自己解决的问题,你可以: - [加入我们的 Slack 社区](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk),提问并与 Milvus 团队及其它社区成员交流讨论。 -- 在 GitHub 上 [创建 issue](https://github.com/milvus-io/milvus/issues/new/choose),详细描述您的问题。 +- 在 GitHub 上 [创建 issue](https://github.com/milvus-io/milvus/issues/new/choose),详细描述你的问题。 ## 向量搜索故障诊断 -有多种 Milvus 操作都会对向量搜索造成影响。如果您在向量搜索操作中遇到运行阻塞或性能下降等问题,请检查是不是下面的一种或多种操作对搜索操作造成了影响: +有多种 Milvus 操作都会对向量搜索造成影响。如果你在向量搜索操作中遇到运行阻塞或性能下降等问题,请检查是不是下面的一种或多种操作对搜索操作造成了影响: ### `Insert` 操作 @@ -64,7 +64,7 @@ Milvus 包括两种索引建立方式: #### 自动建立索引 - **(仅支持 CPU 的 Milvus)** 建索引和搜索都需要全部占用 CPU 资源,因此在后台建索引的时候,搜索任务会等待索引完成后才能执行。 -- **(支持 GPU 的 Milvus)** 如果您使用 GPU 建索引,其他的 GPU 或者 CPU 仍能执行搜索任务,因此建立索引和搜索可以异步进行。 +- **(支持 GPU 的 Milvus)** 如果你使用 GPU 建索引,其他的 GPU 或者 CPU 仍能执行搜索任务,因此建立索引和搜索可以异步进行。 #### 手动建立索引 diff --git a/site/zh-CN/milvus_admin/Install_admin.md b/site/zh-CN/milvus_admin/Install_admin.md index 533b2ec2a..660522078 100644 --- a/site/zh-CN/milvus_admin/Install_admin.md +++ b/site/zh-CN/milvus_admin/Install_admin.md @@ -20,7 +20,7 @@ sidebar_label: 安装 Milvus Admin $ docker run -p 3000:80 milvusdb/milvus-admin:v0.3.0 ``` - > 注意:您也可以映射3000以外的端口,但相应的访问 URL 也需要更新。 + > 注意:你也可以映射 3000 以外的端口,但相应的访问 URL 也需要更新。 3. 打开任意浏览器并访问以下 URL: @@ -28,8 +28,8 @@ sidebar_label: 安装 Milvus Admin http://localhost:3000/ ``` - 如果您能看到 Milvus Admin 的界面,则说明安装成功。 + 如果你能看到 Milvus Admin 的界面,则说明安装成功。 -## 下一步您可以 +## 下一步你可以 - [连接 Milvus Admin](connect_to_admin.md) \ No newline at end of file diff --git a/site/zh-CN/milvus_admin/connect_to_admin.md b/site/zh-CN/milvus_admin/connect_to_admin.md index 498c52c1f..028987f25 100644 --- a/site/zh-CN/milvus_admin/connect_to_admin.md +++ b/site/zh-CN/milvus_admin/connect_to_admin.md @@ -13,6 +13,6 @@ sidebar_label: 连接 Milvus Admin 2. 点击 **连接** 连接 Milvus Admin。如果连接成功,Milvus Admin 会返回成功信息并进入操作页面。 -## 下一步您可以 +## 下一步你可以 - [Milvus Admin 基本操作](admin_operations.md) \ No newline at end of file diff --git a/site/zh-CN/milvus_admin/release_notes_admin.md b/site/zh-CN/milvus_admin/release_notes_admin.md index aa72f3d3b..1098e498b 100644 --- a/site/zh-CN/milvus_admin/release_notes_admin.md +++ b/site/zh-CN/milvus_admin/release_notes_admin.md @@ -6,7 +6,7 @@ sidebar_label: Milvus Admin 发版说明 # Milvus Admin 发版说明 -Milvus Admin 是 Milvus 的图形化客户端。您可以通过 Milvus Admin 对 Milvus 服务端进行操作。 +Milvus Admin 是 Milvus 的图形化客户端。你可以通过 Milvus Admin 对 Milvus 服务端进行操作。 ## v0.3.0 diff --git a/site/zh-CN/reference/application.md b/site/zh-CN/reference/application.md index 753d419dc..72abbd7ab 100644 --- a/site/zh-CN/reference/application.md +++ b/site/zh-CN/reference/application.md @@ -39,7 +39,7 @@ Milvus 做特征向量检索时典型应用架构如下: #### 背景 -互联网时代个性化推荐已经渗透到人们生活的方方面面,例如常见的“猜你喜欢”、“相关商品”等。目前很多成功的手机 APP 都引入了个性化推荐算法,实时精准地把握用户兴趣,推荐他们最感兴趣的内容。例如,新闻类的有今日头条新闻客户端、网易新闻客户端等;商品广告类的有拼多多、微信等。Milvus 向量分析可以帮助您实现上述个性化推荐系统。 +互联网时代个性化推荐已经渗透到人们生活的方方面面,例如常见的“猜你喜欢”、“相关商品”等。目前很多成功的手机 APP 都引入了个性化推荐算法,实时精准地把握用户兴趣,推荐他们最感兴趣的内容。例如,新闻类的有今日头条新闻客户端、网易新闻客户端等;商品广告类的有拼多多、微信等。Milvus 向量分析可以帮助你实现上述个性化推荐系统。 #### 用户需求 diff --git a/site/zh-CN/reference/data_manage.md b/site/zh-CN/reference/data_manage.md index 936ea1548..4ea310258 100644 --- a/site/zh-CN/reference/data_manage.md +++ b/site/zh-CN/reference/data_manage.md @@ -8,7 +8,7 @@ sidebar_label: Data Management ## 使用 MySQL 作为元数据管理服务 -Milvus 默认使用 SQLite 作为元数据后台管理服务,SQLite 内嵌于 Milvus 进程中,无需启动额外服务。但是在生产环境中,基于可靠性的考虑,我们强烈建议您使用 MySQL 作为元数据管理服务。 +Milvus 默认使用 SQLite 作为元数据后台管理服务,SQLite 内嵌于 Milvus 进程中,无需启动额外服务。但是在生产环境中,基于可靠性的考虑,我们强烈建议你使用 MySQL 作为元数据管理服务。 > 注意:Milvus 在 CentOS 系统中不支持 MySQL 8.0 或更高版本。 diff --git a/site/zh-CN/reference/milvus_config.md b/site/zh-CN/reference/milvus_config.md index 7ddfd779b..d910b78d6 100644 --- a/site/zh-CN/reference/milvus_config.md +++ b/site/zh-CN/reference/milvus_config.md @@ -24,7 +24,7 @@ sidebar_label: Milvus Configuration ### 编辑配置文件 -您可以直接编辑配置文件对配置进行修改。如果修改了配置文件,您必须重启 Milvus 服务来启用新的更改。 +你可以直接编辑配置文件对配置进行修改。如果修改了配置文件,你必须重启 Milvus 服务来启用新的更改。 ```shell $ docker restart @@ -32,7 +32,7 @@ $ docker restart ### 运行时修改 -您可以使用 Milvus 客户端 对 `server_config.yaml` 的配置进行运行时修改。修改后无需重启 Milvus 即可启用新的更改。详情请参考[客户端参考](sdk.md)。 +你可以使用 Milvus 客户端 对 `server_config.yaml` 的配置进行运行时修改。修改后无需重启 Milvus 即可启用新的更改。详情请参考[客户端参考](sdk.md)。 对以下参数的运行时修改是立即生效的: @@ -49,7 +49,7 @@ $ docker restart - `search_resources` - `build_index_resources` -对于其它参数,您必须重新启动 Milvus 才能使改动生效。 +对于其它参数,你必须重新启动 Milvus 才能使改动生效。 ## `server_config.yaml` 参数说明 @@ -64,9 +64,9 @@ $ docker restart | `address` | Milvus 服务端监听的 IP 地址。 | String | `0.0.0.0` | | `port` | Milvus 服务端监听的端口号,范围:(1024, 65535)。 | Integer | `19530` | | `deploy_mode` | Milvus 部署类型。选择 `single` ,`cluster_readonly` 或 `cluster_writable`。 | DeployMode | `single` | -| `time_zone` | 使用 UTC-x 或 UTC+x 来指定时区。比如,您可以使用 `UTC+8` 来代表中国标准时间。 | Timezone | `UTC+8` | +| `time_zone` | 使用 UTC-x 或 UTC+x 来指定时区。比如,你可以使用 `UTC+8` 来代表中国标准时间。 | Timezone | `UTC+8` | | `web_enable` | 选择是否启用 Web 服务器。 | Boolean | `true` | -| `web_port` | Milvus 网络服务端监听的端口号,范围:(1024, 65535)。您可以使用 Milvus 网络服务端与 [Milvus RESTful API](sdk.md) 通信。 | Integer | `19121` | +| `web_port` | Milvus 网络服务端监听的端口号,范围:(1024, 65535)。你可以使用 Milvus 网络服务端与 [Milvus RESTful API](sdk.md) 通信。 | Integer | `19121` | @@ -76,7 +76,7 @@ $ docker restart | 参数 | 说明 | 类型 | 默认值 | | -------------------- | ------------------------------------------------------------ | ----------- | --------------- | -| `backend_url` | 元数据存储的 URL 。使用 SQLite(单机部署) 或 MySQL(分布式集群部署)来存储元数据。
`backend_url` 的格式为:`dialect://username:password@host:port/database`。( `dialect` 可以是 `mysql` 或 `sqlite`,取决于您是用了 MySQL 还是 SQLite 数据库。) | String | `sqlite://:@:/` | +| `backend_url` | 元数据存储的 URL 。使用 SQLite(单机部署) 或 MySQL(分布式集群部署)来存储元数据。
`backend_url` 的格式为:`dialect://username:password@host:port/database`。( `dialect` 可以是 `mysql` 或 `sqlite`,取决于你是用了 MySQL 还是 SQLite 数据库。) | String | `sqlite://:@:/` | | `preload_collection` | 定义在 Milvus 服务再次启动后,是否将之前已经导入并保存在磁盘的 collection 预加载到内存。支持全部 collection 或者部分 collection 的预加载。
若要加载所有 collection,使用 `'*'` (包含引号);若要加载部分 collection,列出所有需要加载的 collection 名,以逗号隔开。如果无需加载 collection,请将该值留空 ( ` ` )。 | StringList | ` ` | | `auto_flush_interval` | Milvus 每次自动将缓存中的插入数据 flush 的时间间隔,单位为秒。如果 `auto_flush_interval` 值为0,则 Milvus 不会定时自动将数据 flush。如果缓存空间已满,Milvus 总是会自动将数据 flush,这和 `auto_flush_interval` 的值无关。 | Integer | 1 (s) | @@ -141,7 +141,7 @@ $ docker restart | `build_index_resources` | 定义 Milvus 里用户创建索引的 GPU 资源。格式为:`gpux`,其中 `x` 是 GPU 的序号,例如 `gpu0`。 | DeviceList | `gpu0` | -> 注意:在 Milvus 里,创建索引和搜索是两个独立分开的过程,可以只在 `cpu`,或同时在 `cpu` 和 `gpu` 里进行。通过将 GPU 添加至 `search_resources` 或者 `build_index_resources` 下方,您可以指定多张 GPU 来进行创建索引或搜索。 请参考下面的 YAML 示例代码: +> 注意:在 Milvus 里,创建索引和搜索是两个独立分开的过程,可以只在 `cpu`,或同时在 `cpu` 和 `gpu` 里进行。通过将 GPU 添加至 `search_resources` 或者 `build_index_resources` 下方,你可以指定多张 GPU 来进行创建索引或搜索。 请参考下面的 YAML 示例代码: ```yaml search_resources: @@ -169,7 +169,7 @@ $ docker restart | -------------------- | ------------------------------------------------------------ | ------------ | ------- | | `enable` | 是否开启预写式日志(write-ahead logging,WAL)。如果开启,Milvus 会将所有数据变化预先写入日志文件,之后才会执行数据操作。WAL 可以保证 Milvus 操作的原子性和持久性。 | Boolean | true | | `recovery_error_ignore` | 在通过 WAL 执行恢复操作时,是否忽略出现错误的日志。如果设为 true,当 Milvus 重启恢复时,如果有日志出现错误,则 Milvus 会忽略出现错误的日志。如果设为 false,如果 WAL 日志中存在错误,则 Milvus 会启动失败。 | Boolean | true | -| `buffer_size` | 读取缓冲区和写入缓冲区的总大小,单位为 MB。`buffer_size` 的值必须在 `[64, 4096]` 范围内。如果您设的值超出范围,Milvus 自动使用与所设的值最接近的边界值。建议 `buffer_size` 的值要大于单次插入的数据量,以获取更好的性能。 | Integer | `256` (MB) | +| `buffer_size` | 读取缓冲区和写入缓冲区的总大小,单位为 MB。`buffer_size` 的值必须在 `[64, 4096]` 范围内。如果你设的值超出范围,Milvus 自动使用与所设的值最接近的边界值。建议 `buffer_size` 的值要大于单次插入的数据量,以获取更好的性能。 | Integer | `256` (MB) | | `wal_path` | 预写式日志文件路径。 | String | ` ` | diff --git a/site/zh-CN/reference/performance_tuning.md b/site/zh-CN/reference/performance_tuning.md index 6ec77efb6..fd3cb0a4d 100644 --- a/site/zh-CN/reference/performance_tuning.md +++ b/site/zh-CN/reference/performance_tuning.md @@ -6,7 +6,7 @@ sidebar_label: 配置 Milvus 以用于生产环境 # 配置 Milvus 以用于生产环境 -在生产环节中使用 Milvus 之前,请您检查以下设置,以保证 Milvus 可以保证数据安全并达到一定的性能要求。 +在生产环节中使用 Milvus 之前,请你检查以下设置,以保证 Milvus 可以保证数据安全并达到一定的性能要求。 ## 数据安全 diff --git a/site/zh-CN/release/release_notes.md b/site/zh-CN/release/release_notes.md index bf1356a6c..a004998e7 100644 --- a/site/zh-CN/release/release_notes.md +++ b/site/zh-CN/release/release_notes.md @@ -288,7 +288,7 @@ sidebar_label: 发版说明 - **向量删除** - 新增了对单条或多条向量的删除功能。如果您对一个集合进行了向量删除操作,后续对这个集合的搜索操作仅支持一部分索引类型,包括在 CPU 上运行的 Flat、IVFlat、IVFSQ8 等。Milvus 的后续版本将为其他索引类型提供支持。[#861](https://github.com/milvus-io/milvus/issues/861) + 新增了对单条或多条向量的删除功能。如果你对一个集合进行了向量删除操作,后续对这个集合的搜索操作仅支持一部分索引类型,包括在 CPU 上运行的 Flat、IVFlat、IVFSQ8 等。Milvus 的后续版本将为其他索引类型提供支持。[#861](https://github.com/milvus-io/milvus/issues/861) - **向量读取** @@ -296,15 +296,15 @@ sidebar_label: 发版说明 - **数据落盘与压缩** - 新增了数据落盘与压缩功能。您可以设置定时落盘或者手动落盘,从而避免数据丢失。如果一个段中的向量数据被删除,被删除的向量数据占据的空间并不会自动释放。您可以对集合中的段进行压缩操作以释放多余空间。[#861](https://github.com/milvus-io/milvus/issues/861) [#1426](https://github.com/milvus-io/milvus/pull/1426) + 新增了数据落盘与压缩功能。你可以设置定时落盘或者手动落盘,从而避免数据丢失。如果一个段中的向量数据被删除,被删除的向量数据占据的空间并不会自动释放。你可以对集合中的段进行压缩操作以释放多余空间。[#861](https://github.com/milvus-io/milvus/issues/861) [#1426](https://github.com/milvus-io/milvus/pull/1426) - **运行时更改 Milvus 服务端参数** - 新增了运行时更改 Milvus 服务端参数的功能。您可以通过 Milvus 客户端对 Milvus 服务端参数进行更改,部分参数更改后可即时生效,无需重启 Milvus。[#665](https://github.com/milvus-io/milvus/issues/665) + 新增了运行时更改 Milvus 服务端参数的功能。你可以通过 Milvus 客户端对 Milvus 服务端参数进行更改,部分参数更改后可即时生效,无需重启 Milvus。[#665](https://github.com/milvus-io/milvus/issues/665) - **预写式日志(Write-Ahead Logging, WAL)** - 新增了 WAL 功能,可以大大提高数据操作的可靠性。您可以在 Milvus 服务端配置文件(`server_config.yaml`)中对 WAL 进行设置。[#830](https://github.com/milvus-io/milvus/issues/830) + 新增了 WAL 功能,可以大大提高数据操作的可靠性。你可以在 Milvus 服务端配置文件(`server_config.yaml`)中对 WAL 进行设置。[#830](https://github.com/milvus-io/milvus/issues/830) - **RESTful API** @@ -394,7 +394,7 @@ sidebar_label: 发版说明 - **多张 GPU 创建索引** - 支持使用多张 GPU 来创建索引以减少创建索引和整体查询的时间。您可以通过对 Milvus 配置文件中的参数 `build_index_resources` 来指定用于创建索引的 GPU 卡。[#414](https://github.com/milvus-io/milvus/pull/414) + 支持使用多张 GPU 来创建索引以减少创建索引和整体查询的时间。你可以通过对 Milvus 配置文件中的参数 `build_index_resources` 来指定用于创建索引的 GPU 卡。[#414](https://github.com/milvus-io/milvus/pull/414) #### Bug 修复 @@ -522,7 +522,7 @@ sidebar_label: 发版说明 - 当磁盘空间不足时,可通过参数“db_slave_path"添加多个二级数据存储文件路径。 - 通过参数"parallel_reduce"启用多线程向量归并。 -- 通过参数”insert_buffer_size",您可以指定内存中的一部分作为数据插入的缓冲区。 +- 通过参数”insert_buffer_size",你可以指定内存中的一部分作为数据插入的缓冲区。 - 当缓存已满时,通过参数“cache_free_percent"来设置有多少数据将被保留。 - 通过参数”insert_cache_immediately"来启用一边插一边查的功能。 - 将原先以分数来评价搜索结果,改成对应的向量距离评价搜索结果。