Skip to content

Commit

Permalink
Replaced version number and docker image versions with variables. Mis…
Browse files Browse the repository at this point in the history
…cellaneous editorial updates.
  • Loading branch information
PahudPlus committed Jun 8, 2020
1 parent 5d3fbc3 commit 71c577e
Show file tree
Hide file tree
Showing 30 changed files with 189 additions and 173 deletions.
6 changes: 3 additions & 3 deletions site/en/guides/get_started/example_code.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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.

Expand Down
22 changes: 11 additions & 11 deletions site/en/guides/get_started/install_milvus/cpu_milvus_docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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:
Expand Down Expand Up @@ -107,19 +107,19 @@ $ docker logs <milvus container id>

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
Expand All @@ -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
Expand Down
12 changes: 6 additions & 6 deletions site/en/guides/get_started/install_milvus/gpu_milvus_docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -58,25 +58,25 @@ $ 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

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:
Expand Down Expand Up @@ -115,6 +115,6 @@ $ docker logs <milvus container id>
- 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)
12 changes: 6 additions & 6 deletions site/en/guides/monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,21 +75,21 @@ 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

```

2. Configure the file to suit your requirements. Refer to [https://prometheus.io/docs/prometheus/latest/configuration/configuration/](https://prometheus.io/docs/prometheus/latest/configuration/configuration/) to learn more about the configuration file for Prometheus.

> Note: If you use distributed cluster, you must expand the `targets` field to include `localhost: <http-port>` 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

```

Expand Down Expand Up @@ -128,10 +128,10 @@ Refer to [https://github.com/prometheus/pushgateway](https://github.com/promethe
| URL | `http://<hostname of machine running prometheus>: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

```

Expand Down
2 changes: 1 addition & 1 deletion site/en/milvus_admin/release_notes_admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
7 changes: 6 additions & 1 deletion site/en/variables.json
Original file line number Diff line number Diff line change
@@ -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"

}
3 changes: 3 additions & 0 deletions site/zh-CN/Tips.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"collection": "asdasd"
}
8 changes: 8 additions & 0 deletions site/zh-CN/Variables.json
Original file line number Diff line number Diff line change
@@ -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"

}
16 changes: 8 additions & 8 deletions site/zh-CN/aboutmilvus/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,35 +14,35 @@ Milvus 是一款开源的特征向量相似度搜索引擎,具有使用方便

- 全面的相似度指标

Milvus 支持各种常用的相似度计算指标,包括欧氏距离、内积、汉明距离和杰卡德距离等。您可以根据应用需求来选择最有效的向量相似度计算方式
Milvus 支持各种常用的相似度计算指标,包括欧氏距离、内积、汉明距离和杰卡德距离等。你可以根据应用需求来选择最有效的向量相似度计算方式

- 业界领先的性能

Milvus 基于高度优化的 Approximate Nearest Neighbor Search (ANNS) 索引库构建,包括 faiss、 annoy、和 hnswlib 等。您可以针对不同使用场景选择不同的索引类型
Milvus 基于高度优化的 Approximate Nearest Neighbor Search (ANNS) 索引库构建,包括 faiss、 annoy、和 hnswlib 等。你可以针对不同使用场景选择不同的索引类型

- 动态数据管理

您可以随时对数据进行插入、删除、搜索、更新等操作而无需受到静态数据带来的困扰。
你可以随时对数据进行插入、删除、搜索、更新等操作而无需受到静态数据带来的困扰。

- 近实时搜索

在插入或更新数据之后,您可以几乎立刻对插入或更新过的数据进行搜索。Milvus 负责保证搜索结果的准确率和数据一致性。
在插入或更新数据之后,你可以几乎立刻对插入或更新过的数据进行搜索。Milvus 负责保证搜索结果的准确率和数据一致性。

- 高成本效益

Milvus 充分利用现代处理器的并行计算能力,可以在单台通用服务器上完成对十亿级数据的毫秒级搜索。

- 支持多种数据类型和高级搜索(即将上线)

Milvus 的数据记录中的字段支持多种数据类型。您还可以对一个或多个字段使用高级搜索,例如过滤、排序和聚合。
Milvus 的数据记录中的字段支持多种数据类型。你还可以对一个或多个字段使用高级搜索,例如过滤、排序和聚合。

- 高扩展性和可靠性

您可以在分布式环境中部署 Milvus。如果要对集群扩容或者增加可靠性,您只需增加节点
你可以在分布式环境中部署 Milvus。如果要对集群扩容或者增加可靠性,你只需增加节点

- 云原生

您可以轻松在公有云、私有云、或混合云上运行 Milvus。
你可以轻松在公有云、私有云、或混合云上运行 Milvus。

- 简单易用

Expand All @@ -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)
8 changes: 4 additions & 4 deletions site/zh-CN/contribute/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 贡献者!

## 改进文档

Expand Down
Loading

0 comments on commit 71c577e

Please sign in to comment.