Skip to content

Commit 7c658f8

Browse files
JinHai-CNJinHai-CN
authored
Merge pull request #244 from milvus-io/0.5.2
Merge from 0.5.2
2 parents eb3d56c + 428da32 commit 7c658f8

File tree

3 files changed

+28
-146
lines changed

3 files changed

+28
-146
lines changed

‎README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,8 @@ To connect with other users and contributors, welcome to join our [Slack channel
5656

5757
We greatly appreciate the help of the following people.
5858

59-
- [akihoni](https://github.com/akihoni) found a broken link and a small typo in the README file.
59+
- [akihoni](https://github.com/akihoni) provided the CN version of README, and found a broken link in the doc.
60+
- [goodhamgupta](https://github.com/goodhamgupta) fixed a filename typo in the bootcamp doc.
6061

6162
## Resources
6263

‎README_CN.md

+24-143
Original file line numberDiff line numberDiff line change
@@ -1,195 +1,76 @@
11
![Milvuslogo](https://raw.githubusercontent.com/milvus-io/docs/master/assets/milvus_logo.png)
22

3+
[![Slack](https://img.shields.io/badge/Join-Slack-orange)](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk)
34
![LICENSE](https://img.shields.io/badge/license-Apache--2.0-brightgreen)
45
![Language](https://img.shields.io/badge/language-C%2B%2B-blue)
56
[![codebeat badge](https://codebeat.co/badges/e030a4f6-b126-4475-a938-4723d54ec3a7?style=plastic)](https://codebeat.co/projects/github-com-jinhai-cn-milvus-master)
6-
77
![Release](https://img.shields.io/badge/release-v0.5.2-orange)
88
![Release_date](https://img.shields.io/badge/release_date-October-yellowgreen)
99

10-
- [Slack 频道](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk)
11-
- [Twitter](https://twitter.com/milvusio)
12-
- [Facebook](https://www.facebook.com/io.milvus.5)
13-
- [博客](https://www.milvus.io/blog/)
14-
- [CSDN](https://zilliz.blog.csdn.net/)
15-
- [中文官网](https://www.milvus.io/zh-CN/)
16-
1710
# 欢迎来到 Milvus
1811

1912
## Milvus 是什么
2013

2114
Milvus 是一款开源的、针对海量特征向量的相似性搜索引擎。基于异构众核计算框架设计，成本更低，性能更好。在有限的计算资源下，十亿向量搜索仅毫秒响应。
2215

23-
Milvus 提供稳定的 Python、Java 以及 C++ 的 API 接口。
24-
25-
通过 [版本发布说明](https://milvus.io/docs/zh-CN/release/v0.5.2/) 获取最新发行版本的 Milvus。
26-
27-
- 异构众核
28-
29-
Milvus 基于异构众核计算框架设计，成本更低，性能更好。
30-
31-
- 多元化索引
32-
33-
Milvus 支持多种索引方式，使用量化索引、基于树的索引和图索引等算法。
34-
35-
- 资源智能管理
36-
37-
Milvus 根据实际数据规模和可利用资源，智能调节优化查询计算和索引构建过程。
38-
39-
- 水平扩容
40-
41-
Milvus 支持在线 / 离线扩容，仅需执行简单命令，便可弹性伸缩计算节点和存储节点。
42-
43-
- 高可用性
44-
45-
Milvus 集成了 Kubernetes 框架，能有效避免单点障碍情况的发生。
46-
47-
- 简单易用
48-
49-
Milvus 安装简单，使用方便，并可使您专注于特征向量。
50-
51-
- 可视化监控
16+
若要了解 Milvus 详细介绍和整体架构，请访问 [Milvus 简介](https://www.milvus.io/docs/zh-CN/aboutmilvus/overview/)。
5217

53-
您可以使用基于 Prometheus 的图形化监控，以便实时跟踪系统性能。
18+
Milvus 提供稳定的 [Python](https://github.com/milvus-io/pymilvus)、[Java](https://github.com/milvus-io/milvus-sdk-java) 以及 C++ 的 API 接口。
5419

55-
## 整体架构
56-
57-
![Milvus_arch](https://github.com/milvus-io/docs/blob/master/assets/milvus_arch.png)
20+
通过 [版本发布说明](https://milvus.io/docs/zh-CN/release/v0.5.2/) 获取最新版本的功能和更新。
5821

5922
## 开始使用 Milvus
6023

61-
### 硬件要求
62-
63-
| 硬件设备 | 推荐配置 |
64-
| -------- | ------------------------------------- |
65-
| CPU | Intel CPU Haswell 及以上 |
66-
| GPU | NVIDIA Pascal 系列及以上 |
67-
| 内存 | 8 GB 或以上（取决于具体向量数据规模） |
68-
| 硬盘 | SATA 3.0 SSD 及以上 |
69-
70-
### 使用 Docker
71-
72-
您可以方便地使用 Docker 安装 Milvus。具体请查看 [Milvus 安装指南](https://milvus.io/docs/zh-CN/userguide/install_milvus/)。
73-
74-
### 从源代码编译
75-
76-
#### 软件要求
77-
78-
- Ubuntu 18.04 及以上
79-
- CMake 3.14 及以上
80-
- CUDA 10.0 及以上
81-
- NVIDIA driver 418 及以上
82-
83-
#### 编译
24+
请参阅 [Milvus 安装指南](https://www.milvus.io/docs/zh-CN/userguide/install_milvus/) 使用 Docker 容器安装 Milvus。若要基于源码编译，请访问 [源码安装](install.md)。
8425

85-
##### 第一步 安装依赖项
86-
87-
```shell
88-
$ cd [Milvus sourcecode path]/core
89-
$ ./ubuntu_build_deps.sh
90-
```
91-
92-
##### 第二步 编译
93-
94-
```shell
95-
$ cd [Milvus sourcecode path]/core
96-
$ ./build.sh -t Debug
97-
or
98-
$ ./build.sh -t Release
99-
```
100-
101-
当您成功编译后，所有 Milvus 必需组件将安装在`[Milvus root path]/core/milvus`路径下。
102-
103-
##### 启动 Milvus 服务
104-
105-
```shell
106-
$ cd [Milvus root path]/core/milvus
107-
```
108-
109-
在 `LD_LIBRARY_PATH` 中添加 `lib/` 目录：
110-
111-
```shell
112-
$ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/path/to/milvus/lib
113-
```
114-
115-
启动 Milvus 服务：
116-
117-
```shell
118-
$ cd scripts
119-
$ ./start_server.sh
120-
```
121-
122-
若要停止 Milvus 服务，请使用如下命令：
123-
124-
```shell
125-
$ ./stop_server.sh
126-
```
127-
128-
若需要修改 Milvus 配置文件 `conf/server_config.yaml` 和`conf/log_config.conf`，请查看 [Milvus 配置](https://milvus.io/docs/zh-CN/reference/milvus_config/)。
26+
若要更改 Milvus 设置，请参阅 [Milvus 配置](https://www.milvus.io/docs/zh-CN/reference/milvus_config/)。
12927

13028
### 开始您的第一个 Milvus 程序
13129

132-
#### 运行 Python 示例代码
133-
134-
请确保系统的 Python 版本为 [Python 3.5](https://www.python.org/downloads/) 或以上。
30+
您可以尝试用 [Python](https://www.milvus.io/docs/en/userguide/example_code/) 或 [Java example code](https://github.com/milvus-io/milvus-sdk-java/tree/master/examples) 运行 Milvus 示例代码。
13531

136-
安装 Milvus Python SDK。
137-
138-
```shell
139-
# Install Milvus Python SDK
140-
$ pip install pymilvus==0.2.3
141-
```
142-
143-
创建 `example.py` 文件，并向文件中加入 [Python 示例代码](https://github.com/milvus-io/pymilvus/blob/master/examples/advanced_example.py)。
144-
145-
运行示例代码
146-
147-
```shell
148-
# Run Milvus Python example
149-
$ python3 example.py
150-
```
151-
152-
#### 运行 C++ 示例代码
32+
若要使用 C++ 示例代码，请使用以下命令：
15333

15434
```shell
15535
# Run Milvus C++ example
15636
$ cd [Milvus root path]/core/milvus/bin
15737
$ ./sdk_simple
15838
```
15939

160-
#### 运行 Java 示例代码
161-
162-
请确保系统的 Java 版本为 Java 8 或以上。
40+
## 路线图
16341

164-
请从[此处](https://github.com/milvus-io/milvus-sdk-java/tree/master/examples)获取 Java 示例代码。
42+
请阅读我们的[路线图](https://milvus.io/docs/zh-CN/roadmap/)以了解更多即将开发的新功能。
16543

16644
## 贡献者指南
16745

168-
我们由衷欢迎您推送贡献。关于贡献流程的详细信息，请参阅 [贡献者指南](https://github.com/milvus-io/milvus/blob/master/CONTRIBUTING.md)。本项目遵循 Milvus [行为准则](https://github.com/milvus-io/milvus/blob/master/CODE_OF_CONDUCT.md)。如果您希望参与本项目，请遵守该准则的内容。
46+
我们由衷欢迎您推送贡献。关于贡献流程的详细信息，请参阅[贡献者指南](https://github.com/milvus-io/milvus/blob/master/CONTRIBUTING.md)。本项目遵循 Milvus [行为准则](https://github.com/milvus-io/milvus/blob/master/CODE_OF_CONDUCT.md)。如果您希望参与本项目，请遵守该准则的内容。
16947

170-
我们使用 [GitHub issues](https://github.com/milvus-io/milvus/issues/new/choose) 追踪问题和补丁。若您希望提出问题或进行讨论，请加入我们的社区。
48+
我们使用 [GitHub issues](https://github.com/milvus-io/milvus/issues) 追踪问题和补丁。若您希望提出问题或进行讨论，请加入我们的社区。
17149

17250
## 加入 Milvus 社区
17351

174-
欢迎加入我们的 [Slack 频道](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk) 以便与其他用户和贡献者进行交流。
52+
欢迎加入我们的 [Slack 频道](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk)以便与其他用户和贡献者进行交流。
53+
54+
## 贡献者
17555

176-
## Milvus 路线图
56+
以下是 Milvus 贡献者名单，在此我们深表感谢：
17757

178-
请阅读我们的[路线图](https://milvus.io/docs/zh-CN/roadmap/)以获得更多即将开发的新功能。
58+
- [akihoni](https://github.com/akihoni) 提供了中文版 README，并发现了 README 中的无效链接。
59+
- [goodhamgupta](https://github.com/goodhamgupta) 发现并修正了在线训练营文档中的文件名拼写错误。
17960

18061
## 相关链接
18162

182-
[Milvus 官方网站](https://www.milvus.io/)
63+
- [Milvus.io](https://www.milvus.io)
18364

184-
[Milvus 文档](https://www.milvus.io/docs/en/userguide/install_milvus/)
65+
- [Milvus 在线训练营](https://github.com/milvus-io/bootcamp)
18566

186-
[Milvus 在线训练营](https://github.com/milvus-io/bootcamp)
67+
- [Milvus Medium](https://medium.com/@milvusio)
18768

188-
[Milvus 博客](https://www.milvus.io/blog/)
69+
- [Milvus CSDN](https://zilliz.blog.csdn.net/)
18970

190-
[Milvus CSDN](https://zilliz.blog.csdn.net/)
71+
- [Milvus Twitter](https://twitter.com/milvusio)
19172

192-
[Milvus 路线图](https://milvus.io/docs/en/roadmap/)
73+
- [Milvus Facebook](https://www.facebook.com/io.milvus.5)
19374

19475
## 许可协议
19576

‎README_JP.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
![LICENSE](https://img.shields.io/badge/license-Apache--2.0-brightgreen)
66
![Language](https://img.shields.io/badge/language-C%2B%2B-blue)
77
[![codebeat badge](https://codebeat.co/badges/e030a4f6-b126-4475-a938-4723d54ec3a7?style=plastic)](https://codebeat.co/projects/github-com-jinhai-cn-milvus-master)
8-
![Release](https://img.shields.io/badge/release-v0.5.1-yellowgreen)
8+
![Release](https://img.shields.io/badge/release-v0.5.2-yellowgreen)
99
![Release_date](https://img.shields.io/badge/release%20date-November-yellowgreen)
1010

1111

@@ -17,7 +17,7 @@ Milvus は大規模な特徴ベクトルにむかう類似性検索エンジン
1717

1818
Milvus は安定的な Python、Java 又は C++ APIsを提供します。
1919

20-
Milvus [リリースノート](https://milvus.io/docs/en/release/v0.5.1/)を読んで最新バージョンや更新情報を手に入れます。
20+
Milvus [リリースノート](https://milvus.io/docs/en/release/v0.5.2/)を読んで最新バージョンや更新情報を手に入れます。
2121

2222
- 不均質な計算アーキテクチャー
2323

0 commit comments

Comments
 (0)