README.md 5.7 KB
Newer Older
J
jielinxu 已提交
1

2
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)<!-- ALL-CONTRIBUTORS-BADGE:END -->
J
jielinxu 已提交
3
![Milvuslogo](https://github.com/milvus-io/docs/blob/master/assets/milvus_logo.png)
J
jielinxu 已提交
4

J
Jin Hai 已提交
5
[![Slack](https://img.shields.io/badge/Join-Slack-orange)](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk)
J
jielinxu 已提交
6 7
![LICENSE](https://img.shields.io/badge/license-Apache--2.0-brightgreen)
![Language](https://img.shields.io/badge/language-C%2B%2B-blue)
Y
yinghao.zou 已提交
8
[![codebeat badge](https://codebeat.co/badges/e030a4f6-b126-4475-a938-4723d54ec3a7?style=plastic)](https://codebeat.co/projects/github-com-jinhai-cn-milvus-master)
9 10
![Release](https://img.shields.io/badge/release-v0.6.0-yellowgreen)
![Release_date](https://img.shields.io/badge/release%20date-December-yellowgreen)
Q
quicksilver 已提交
11
[![codecov](https://codecov.io/gh/milvus-io/milvus/branch/master/graph/badge.svg)](https://codecov.io/gh/milvus-io/milvus)
J
Jin Hai 已提交
12 13
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
J
Jin Hai 已提交
14
<!-- ALL-CONTRIBUTORS-BADGE:END -->
Q
quicksilver 已提交
15

J
jielinxu 已提交
16
[中文版](README_CN.md) | [日本語版](README_JP.md)
J
JinHai-CN 已提交
17 18 19

## What is Milvus

J
Jin Hai 已提交
20
Milvus is the world's fastest similarity search engine for massive-scale feature vectors. Built with heterogeneous computing architecture for the best cost efficiency. Searches over billion-scale vectors take only milliseconds with minimum computing resources.
J
jielinxu 已提交
21

J
jielinxu 已提交
22
For more detailed introduction of Milvus and its architecture, see [Milvus overview](https://www.milvus.io/docs/en/aboutmilvus/overview/).
J
jielinxu 已提交
23

G
G.Y Feng 已提交
24
Milvus provides stable [Python](https://github.com/milvus-io/pymilvus), [Java](https://github.com/milvus-io/milvus-sdk-java) and [C++](https://github.com/milvus-io/milvus/tree/master/core/src/sdk) APIs. 
J
jielinxu 已提交
25

J
jielinxu 已提交
26
Keep up-to-date with newest releases and latest updates by reading Milvus [release notes](https://www.milvus.io/docs/en/release/v0.5.3/).
J
JinHai-CN 已提交
27 28 29

## Get started

J
jielinxu 已提交
30
See the [Milvus install guide](https://www.milvus.io/docs/en/userguide/install_milvus/) for using Docker containers. To install Milvus from source code, see [build from source](install.md).
J
JinHai-CN 已提交
31

J
jielinxu 已提交
32
To edit Milvus settings, read [Milvus configuration](https://www.milvus.io/docs/en/reference/milvus_config/).
J
JinHai-CN 已提交
33 34 35

### Try your first Milvus program

J
jielinxu 已提交
36
Try running a program with Milvus using [Python](https://www.milvus.io/docs/en/userguide/example_code/) or [Java example code](https://github.com/milvus-io/milvus-sdk-java/tree/master/examples). 
J
JinHai-CN 已提交
37

J
jielinxu 已提交
38
To use C++ example code, use below command:
J
JinHai-CN 已提交
39 40 41 42 43 44 45

```shell
 # Run Milvus C++ example
 $ cd [Milvus root path]/core/milvus/bin
 $ ./sdk_simple
```

J
jielinxu 已提交
46
## Roadmap
J
jielinxu 已提交
47

J
jielinxu 已提交
48
Please read our [roadmap](https://milvus.io/docs/en/roadmap/) for upcoming features.
J
jielinxu 已提交
49

J
JinHai-CN 已提交
50 51
## Contribution guidelines

J
jielinxu 已提交
52
Contributions are welcomed and greatly appreciated. Please read our [contribution guidelines](CONTRIBUTING.md) for detailed contribution workflow. This project adheres to the [code of conduct](CODE_OF_CONDUCT.md) of Milvus. By participating, you are expected to uphold this code.
J
JinHai-CN 已提交
53

J
Jin Hai 已提交
54
We use [GitHub issues](https://github.com/milvus-io/milvus/issues) to track issues and bugs. For general questions and public discussions, please join our community.
J
JinHai-CN 已提交
55

J
jielinxu 已提交
56
## Join our community
J
JinHai-CN 已提交
57

J
jielinxu 已提交
58
To connect with other users and contributors, welcome to join our [Slack channel](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk). 
J
JinHai-CN 已提交
59

J
jielinxu 已提交
60
## Contributors
J
JinHai-CN 已提交
61

J
jielinxu 已提交
62
Below is a list of Milvus contributors. We greatly appreciate your contributions!
63 64 65 66 67
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tr>
68
    <td align="center"><a href="https://github.com/erdustiggen"><img src="https://avatars1.githubusercontent.com/u/25433850?v=4" width="100px;" alt="erdustiggen"/><br /><sub><b>erdustiggen</b></sub></a><br /><a href="https://github.com/milvus-io/milvus/commits?author=erdustiggen" title="Code">💻</a></td>
69
    <td align="center"><a href="https://github.com/gaolizhou"><img src="https://avatars2.githubusercontent.com/u/2884044?v=4" width="100px;" alt="gaolizhou"/><br /><sub><b>gaolizhou</b></sub></a><br /><a href="https://github.com/milvus-io/milvus/commits?author=gaolizhou" title="Code">💻</a></td>
70
    <td align="center"><a href="https://github.com/akihoni"><img src="https://avatars0.githubusercontent.com/u/36330442?v=4" width="100px;" alt="Sijie Zhang"/><br /><sub><b>Sijie Zhang</b></sub></a><br /><a href="https://github.com/milvus-io/milvus/commits?author=akihoni" title="Documentation">📖</a></td>
71 72 73 74 75 76
  </tr>
</table>

<!-- markdownlint-enable -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
J
JinHai-CN 已提交
77

J
jielinxu 已提交
78 79
- [akihoni](https://github.com/akihoni) provided the CN version of README, and found a broken link in the doc.
- [goodhamgupta](https://github.com/goodhamgupta) fixed a filename typo in the bootcamp doc.
J
jielinxu 已提交
80
- [erdustiggen](https://github.com/erdustiggen) changed from std::cout to LOG for error messages, and fixed a clang format issue as well as some grammatical errors.
J
JinHai-CN 已提交
81 82 83

## Resources

J
jielinxu 已提交
84
- [Milvus.io](https://www.milvus.io)
J
JinHai-CN 已提交
85

J
jielinxu 已提交
86
- [Milvus bootcamp](https://github.com/milvus-io/bootcamp)
J
jielinxu 已提交
87

J
jielinxu 已提交
88
- [Milvus test reports](https://github.com/milvus-io/milvus/tree/master/docs)
J
jielinxu 已提交
89

valerianian's avatar
valerianian 已提交
90
- [Milvus FAQ](https://www.milvus.io/docs/en/faq/operational_faq/)
91

J
jielinxu 已提交
92
- [Milvus Medium](https://medium.com/@milvusio)
J
JinHai-CN 已提交
93

J
jielinxu 已提交
94
- [Milvus CSDN](https://zilliz.blog.csdn.net/)
J
JinHai-CN 已提交
95

J
jielinxu 已提交
96
- [Milvus Twitter](https://twitter.com/milvusio)
J
JinHai-CN 已提交
97

J
jielinxu 已提交
98
- [Milvus Facebook](https://www.facebook.com/io.milvus.5)
J
JinHai-CN 已提交
99 100 101

## License

valerianian's avatar
valerianian 已提交
102
[Apache License 2.0](LICENSE)