2019-10-22 17:11:55 +08:00
![Milvuslogo ](https://github.com/milvus-io/docs/blob/master/assets/milvus_logo.png )
2019-10-15 19:45:58 +08:00
2019-11-04 14:40:31 +08:00
[![Slack ](https://img.shields.io/badge/Join-Slack-orange )](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk)
2019-10-16 10:32:16 +08:00
![LICENSE ](https://img.shields.io/badge/license-Apache--2.0-brightgreen )
![Language ](https://img.shields.io/badge/language-C%2B%2B-blue )
2019-10-17 20:40:48 +08:00
[![codebeat badge ](https://codebeat.co/badges/e030a4f6-b126-4475-a938-4723d54ec3a7?style=plastic )](https://codebeat.co/projects/github-com-jinhai-cn-milvus-master)
2019-12-04 10:14:42 +08:00
![Release ](https://img.shields.io/badge/release-v0.6.0-yellowgreen )
![Release_date ](https://img.shields.io/badge/release%20date-December-yellowgreen )
2019-11-25 11:20:24 +08:00
[![codecov ](https://codecov.io/gh/milvus-io/milvus/branch/master/graph/badge.svg )](https://codecov.io/gh/milvus-io/milvus)
2019-12-10 16:35:58 +08:00
[![All Contributors ](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square )](#contributors-)
2020-01-07 18:29:16 +08:00
[![CII Best Practices ](https://bestpractices.coreinfrastructure.org/projects/3563/badge )](https://bestpractices.coreinfrastructure.org/projects/3563)
2019-11-25 11:20:24 +08:00
2019-11-11 13:45:43 +08:00
[中文版 ](README_CN.md ) | [日本語版 ](README_JP.md )
2019-10-15 18:42:20 +08:00
## What is Milvus
2019-11-03 17:31:23 +08:00
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.
2019-10-22 17:11:55 +08:00
2019-12-31 10:54:48 +08:00
For more detailed introduction of Milvus and its architecture, see [Milvus overview ](https://www.milvus.io/docs/about_milvus/overview.md ).
2019-10-22 17:11:55 +08:00
2019-12-27 18:58:16 +08:00
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.
2019-10-22 17:11:55 +08:00
2019-12-31 10:54:48 +08:00
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 ).
2019-10-15 18:42:20 +08:00
## Get started
2020-01-09 11:39:33 +08:00
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 ).
2019-10-15 18:42:20 +08:00
2019-12-31 10:54:48 +08:00
To edit Milvus settings, read [Milvus configuration ](https://www.milvus.io/docs/v0.6.0/reference/milvus_config.md ).
2019-10-15 18:42:20 +08:00
### Try your first Milvus program
2019-12-31 10:54:48 +08:00
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 ).
2019-10-15 18:42:20 +08:00
2019-10-16 10:32:16 +08:00
2019-10-15 18:42:20 +08:00
## Contribution guidelines
2019-10-28 09:31:46 +08:00
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.
2019-10-15 18:42:20 +08:00
2019-11-04 14:40:31 +08:00
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.
2019-10-15 18:42:20 +08:00
2019-11-01 15:11:46 +08:00
## Join our community
2019-10-15 18:42:20 +08:00
2019-11-01 16:46:03 +08:00
To connect with other users and contributors, welcome to join our [Slack channel ](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk ).
2019-10-15 18:42:20 +08:00
2019-11-20 15:44:25 +08:00
## Contributors
2019-10-15 18:42:20 +08:00
2019-11-20 15:44:25 +08:00
Below is a list of Milvus contributors. We greatly appreciate your contributions!
2019-12-04 11:42:34 +08:00
<!-- ALL - CONTRIBUTORS - LIST:START - Do not remove or modify this section -->
<!-- prettier - ignore - start -->
<!-- markdownlint - disable -->
< table >
< tr >
2019-12-09 14:29:48 +08:00
< 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 >
2019-12-09 19:09:53 +08:00
< 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 >
2019-12-04 11:42:34 +08:00
< / tr >
< / table >
<!-- markdownlint - enable -->
<!-- prettier - ignore - end -->
<!-- ALL - CONTRIBUTORS - LIST:END -->
2019-10-15 18:42:20 +08:00
## Resources
2019-11-01 16:44:34 +08:00
- [Milvus.io ](https://www.milvus.io )
2019-10-15 18:42:20 +08:00
2019-11-01 16:44:34 +08:00
- [Milvus bootcamp ](https://github.com/milvus-io/bootcamp )
2019-10-16 10:32:16 +08:00
2019-11-20 17:21:10 +08:00
- [Milvus test reports ](https://github.com/milvus-io/milvus/tree/master/docs )
2019-11-20 15:44:25 +08:00
2019-12-31 10:54:48 +08:00
- [Milvus FAQ ](https://www.milvus.io/docs/faq/operational_faq.md )
2019-11-27 16:07:58 +08:00
2019-11-01 16:44:34 +08:00
- [Milvus Medium ](https://medium.com/@milvusio )
2019-10-15 18:42:20 +08:00
2019-11-01 16:44:34 +08:00
- [Milvus CSDN ](https://zilliz.blog.csdn.net/ )
2019-10-15 18:42:20 +08:00
2019-11-01 16:44:34 +08:00
- [Milvus Twitter ](https://twitter.com/milvusio )
2019-10-15 18:42:20 +08:00
2019-11-01 16:44:34 +08:00
- [Milvus Facebook ](https://www.facebook.com/io.milvus.5 )
2019-10-15 18:42:20 +08:00
## License
2019-11-27 16:16:18 +08:00
[Apache License 2.0 ](LICENSE )