README.md 6.1 KB
Newer Older
J
jielinxu 已提交
1
![Milvuslogo](https://github.com/milvus-io/docs/blob/master/assets/milvus_logo.png)
J
jielinxu 已提交
2

J
Jin Hai 已提交
3
[![Slack](https://img.shields.io/badge/Join-Slack-orange)](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk)
J
jielinxu 已提交
4 5
![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 已提交
6
[![codebeat badge](https://codebeat.co/badges/e030a4f6-b126-4475-a938-4723d54ec3a7?style=plastic)](https://codebeat.co/projects/github-com-jinhai-cn-milvus-master)
7 8
![Release](https://img.shields.io/badge/release-v0.6.0-yellowgreen)
![Release_date](https://img.shields.io/badge/release%20date-December-yellowgreen)
Q
quicksilver 已提交
9
[![codecov](https://codecov.io/gh/milvus-io/milvus/branch/master/graph/badge.svg)](https://codecov.io/gh/milvus-io/milvus)
10
[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors-)
J
Jin Hai 已提交
11
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/3563/badge)](https://bestpractices.coreinfrastructure.org/projects/3563)
Q
quicksilver 已提交
12

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

## What is Milvus

J
Jin Hai 已提交
17
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 已提交
18

19
For more detailed introduction of Milvus and its architecture, see [Milvus overview](https://www.milvus.io/docs/about_milvus/overview.md).
J
jielinxu 已提交
20

21
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/sdk) SDKs. 
J
jielinxu 已提交
22

23
Keep up-to-date with newest releases and latest updates by reading Milvus [release notes](https://www.milvus.io/docs/v0.6.0/releases/v0.6.0.md).
J
JinHai-CN 已提交
24 25 26

## Get started

27
See the [Milvus install guide](https://www.milvus.io/docs/guides/get_started/install_milvus/install_milvus.md) for using Docker containers. To install Milvus from source code, see [build from source](INSTALL.md).
J
JinHai-CN 已提交
28

29
To edit Milvus settings, read [Milvus configuration](https://www.milvus.io/docs/v0.6.0/reference/milvus_config.md).
J
JinHai-CN 已提交
30 31 32

### Try your first Milvus program

33
Try running a program with Milvus using [Python](https://www.milvus.io/docs/guides/get_started/example_code.md), [Java](https://github.com/milvus-io/milvus-sdk-java/tree/master/examples), or [C++ example code](https://github.com/milvus-io/milvus/tree/master/sdk/examples). 
J
JinHai-CN 已提交
34

J
jielinxu 已提交
35

J
JinHai-CN 已提交
36 37
## Contribution guidelines

J
jielinxu 已提交
38
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 已提交
39

J
Jin Hai 已提交
40
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 已提交
41

J
jielinxu 已提交
42
## Join our community
J
JinHai-CN 已提交
43

J
jielinxu 已提交
44
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 已提交
45

J
jielinxu 已提交
46
## Contributors
J
JinHai-CN 已提交
47

J
jielinxu 已提交
48
Below is a list of Milvus contributors. We greatly appreciate your contributions!
49 50 51 52 53
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tr>
54 55 56 57 58
    <td align="center"><a href="https://github.com/zerowe-seven"><img src="https://avatars0.githubusercontent.com/u/57790060?v=4" width="100px;" alt=""/><br /><sub><b>zerowe-seven</b></sub></a><br /><a href="https://github.com/milvus-io/milvus/commits?author=zerowe-seven" title="Code">💻</a></td>
    <td align="center"><a href="https://github.com/erdustiggen"><img src="https://avatars1.githubusercontent.com/u/25433850?v=4" width="100px;" alt=""/><br /><sub><b>erdustiggen</b></sub></a><br /><a href="https://github.com/milvus-io/milvus/commits?author=erdustiggen" title="Code">💻</a></td>
    <td align="center"><a href="https://github.com/gaolizhou"><img src="https://avatars2.githubusercontent.com/u/2884044?v=4" width="100px;" alt=""/><br /><sub><b>gaolizhou</b></sub></a><br /><a href="https://github.com/milvus-io/milvus/commits?author=gaolizhou" title="Code">💻</a></td>
    <td align="center"><a href="https://github.com/akihoni"><img src="https://avatars0.githubusercontent.com/u/36330442?v=4" width="100px;" alt=""/><br /><sub><b>Sijie Zhang</b></sub></a><br /><a href="https://github.com/milvus-io/milvus/commits?author=akihoni" title="Documentation">📖</a></td>
    <td align="center"><a href="https://github.com/PizzaL"><img src="https://avatars0.githubusercontent.com/u/5666666?v=4" width="100px;" alt=""/><br /><sub><b>PizzaL</b></sub></a><br /><a href="https://github.com/milvus-io/milvus/commits?author=PizzaL" title="Code">💻</a></td>
59
    <td align="center"><a href="https://github.com/levylll"><img src="https://avatars2.githubusercontent.com/u/5645285?v=4" width="100px;" alt=""/><br /><sub><b>levylll</b></sub></a><br /><a href="https://github.com/milvus-io/milvus/commits?author=levylll" title="Code">💻</a></td>
60
    <td align="center"><a href="https://github.com/aaronjin2010"><img src="https://avatars1.githubusercontent.com/u/48044391?v=4" width="100px;" alt=""/><br /><sub><b>aaronjin2010</b></sub></a><br /><a href="https://github.com/milvus-io/milvus/commits?author=aaronjin2010" title="Code">💻</a></td>
61 62 63 64 65 66
  </tr>
</table>

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


## Resources

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

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

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

77
- [Milvus FAQ](https://www.milvus.io/docs/faq/operational_faq.md)
78

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

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

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

J
jielinxu 已提交
85
- [Milvus Facebook](https://www.facebook.com/io.milvus.5)
J
JinHai-CN 已提交
86 87 88

## License

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