2019-10-22 09:11:55 +00:00
![Milvuslogo ](https://github.com/milvus-io/docs/blob/master/assets/milvus_logo.png )
2019-10-15 11:45:58 +00:00
2019-11-04 06:40:31 +00:00
[![Slack ](https://img.shields.io/badge/Join-Slack-orange )](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk)
2020-02-23 18:19:53 +00:00
2020-02-23 21:53:44 +00:00
![GitHub ](https://img.shields.io/github/license/milvus-io/milvus )
2020-02-23 20:09:14 +00:00
![Language ](https://img.shields.io/github/languages/count/milvus-io/milvus )
![GitHub top language ](https://img.shields.io/github/languages/top/milvus-io/milvus )
2020-02-23 20:42:17 +00:00
![GitHub release (latest by date) ](https://img.shields.io/github/v/release/milvus-io/milvus )
2020-02-23 21:48:43 +00:00
![GitHub Release Date ](https://img.shields.io/github/release-date/milvus-io/milvus )
2020-02-23 22:07:50 +00:00
2020-02-23 21:06:11 +00:00
[![Maintenance ](https://img.shields.io/badge/Maintained%3F-yes-green.svg )](https://github.com/milvus-io/milvus/pulse/monthly)
2020-02-23 21:48:43 +00:00
![OSS Lifecycle ](https://img.shields.io/osslifecycle/milvus-io/milvus )
2020-02-23 22:07:50 +00:00
[![HitCount ](http://hits.dwyl.com/milvus-io/milvus.svg )](http://hits.dwyl.com/milvus-io/milvus)
![Docker pulls ](https://img.shields.io/docker/pulls/milvusdb/milvus )
2020-02-23 18:19:53 +00:00
2020-02-18 15:36:23 +00:00
[![Build Status ](http://internal.zilliz.com:18080/jenkins/job/milvus-ci/job/master/badge/icon )](http://internal.zilliz.com:18080/jenkins/job/milvus-ci/job/master/)
2020-02-23 18:19:53 +00:00
[![CII Best Practices ](https://bestpractices.coreinfrastructure.org/projects/3563/badge )](https://bestpractices.coreinfrastructure.org/projects/3563)
[![codecov ](https://codecov.io/gh/milvus-io/milvus/branch/master/graph/badge.svg )](https://codecov.io/gh/milvus-io/milvus)
2020-02-24 12:04:56 +00:00
[![codebeat badge ](https://codebeat.co/badges/e030a4f6-b126-4475-a938-4723d54ec3a7?style=plastic )](https://codebeat.co/projects/github-com-milvus-io-milvus-master)
2020-02-25 03:36:30 +00:00
[![CodeFactor Grade ](https://www.codefactor.io/repository/github/milvus-io/milvus/badge )](https://www.codefactor.io/repository/github/milvus-io/milvus)
2020-02-23 19:38:14 +00:00
[![Codacy Badge ](https://api.codacy.com/project/badge/Grade/c4bb2ccfb51b47f99e43bfd1705edd95 )](https://app.codacy.com/gh/milvus-io/milvus?utm_source=github.com& utm_medium=referral& utm_content=milvus-io/milvus& utm_campaign=Badge_Grade_Dashboard)
2020-02-23 18:19:53 +00:00
[![Scrutinizer Quality Score ](https://scrutinizer-ci.com/g/milvus-io/milvus/badges/quality-score.png?b=master )](https://scrutinizer-ci.com/g/milvus-io/milvus/)
2019-11-25 03:20:24 +00:00
2020-02-23 19:38:14 +00:00
[![PRs Welcome ](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square )](http://makeapullrequest.com)
2019-11-11 05:45:43 +00:00
[中文版 ](README_CN.md ) | [日本語版 ](README_JP.md )
2019-10-15 10:42:20 +00:00
## What is Milvus
2020-02-23 06:37:17 +00:00
Milvus is an open source vector similarity search engine. 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 09:11:55 +00:00
2019-12-31 02:54:48 +00: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 09:11:55 +00:00
2019-12-31 02:54:48 +00: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 10:42:20 +00:00
2020-02-08 03:29:52 +00:00
## Roadmap
To learn what's coming up soon in Milvus, read our [Roadmap ](https://github.com/milvus-io/milvus/milestones ).
It is a Work in Progress, and is subject to reasonable adjustments when necessary. And we greatly welcome any comments/requirements/suggestions regarding Milvus roadmap.:clap:
## Application scenarios
Milvus is broadly applicable to a variety of areas. Below screenshot showcases our content-based image retrieval demo system built based on Milvus and VGG.
[![image retrieval demo ](https://raw.githubusercontent.com/milvus-io/docs/v0.7.0/assets/image_retrieval.png )](https://raw.githubusercontent.com/milvus-io/docs/v0.7.0/assets/image_retrieval.png)
To explore more Milvus solutions and application scenarios, see our [bootcamp ](https://github.com/milvus-io/bootcamp ) repository.
## Test reports
See our [test reports ](https://github.com/milvus-io/milvus/tree/master/docs ) for more information about performance benchmarking of different indexes in Milvus.
## Supported clients
2020-03-02 16:25:22 +00:00
- [Go ](https://github.com/milvus-io/milvus-sdk-go )
- [Python ](https://github.com/milvus-io/pymilvus )
- [Java ](https://github.com/milvus-io/milvus-sdk-java )
- [C++ ](https://github.com/milvus-io/milvus/tree/master/sdk )
- [RESTful API ](https://github.com/milvus-io/milvus/tree/master/core/src/server/web_impl )
- [Node.js ](https://www.npmjs.com/package/@arkie-ai/milvus-client ) (Provided by [arkie ](https://www.arkie.cn/ ))
2020-02-08 03:29:52 +00:00
2019-10-15 10:42:20 +00:00
## Get started
2020-01-09 03:39:33 +00: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 10:42:20 +00:00
2019-12-31 02:54:48 +00:00
To edit Milvus settings, read [Milvus configuration ](https://www.milvus.io/docs/v0.6.0/reference/milvus_config.md ).
2019-10-15 10:42:20 +00:00
### Try your first Milvus program
2020-02-23 21:48:43 +00: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 10:42:20 +00:00
2019-10-16 02:32:16 +00:00
2019-10-15 10:42:20 +00:00
## Contribution guidelines
2019-10-28 01:31:46 +00: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 10:42:20 +00:00
2019-11-04 06:40:31 +00: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 10:42:20 +00:00
2019-11-01 07:11:46 +00:00
## Join our community
2019-10-15 10:42:20 +00:00
2020-02-23 21:48:43 +00:00
:heart:To connect with other users and contributors, welcome to join our [Slack channel ](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk ).
2020-02-08 03:29:52 +00:00
See our [community ](https://github.com/milvus-io/community ) repository to learn about our governance and access more community resources.
2019-10-15 10:42:20 +00:00
2020-02-14 16:00:52 +00:00
## Mailing lists
2020-03-02 16:25:22 +00:00
- [Milvus TSC ](https://lists.lfai.foundation/g/milvus-tsc )
- [Milvus Technical Discuss ](https://lists.lfai.foundation/g/milvus-technical-discuss )
- [Milvus Announce ](https://lists.lfai.foundation/g/milvus-announce )
2020-02-14 16:00:52 +00:00
2019-11-20 07:44:25 +00:00
## Contributors
2019-10-15 10:42:20 +00:00
2019-11-20 07:44:25 +00:00
Below is a list of Milvus contributors. We greatly appreciate your contributions!
2019-12-04 03:42:34 +00:00
<!-- ALL - CONTRIBUTORS - LIST:START - Do not remove or modify this section -->
<!-- prettier - ignore - start -->
<!-- markdownlint - disable -->
< table >
< tr >
2019-12-09 06:29:48 +00: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 11:09:53 +00: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 >
2020-01-17 11:03:38 +00:00
< 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 >
2019-12-04 03:42:34 +00:00
< / tr >
< / table >
<!-- markdownlint - enable -->
<!-- prettier - ignore - end -->
<!-- ALL - CONTRIBUTORS - LIST:END -->
2019-10-15 10:42:20 +00:00
## Resources
2020-03-02 16:25:22 +00:00
- [Milvus.io ](https://www.milvus.io )
2019-10-15 10:42:20 +00:00
2020-03-02 16:25:22 +00:00
- [Milvus FAQ ](https://www.milvus.io/docs/faq/operational_faq.md )
2019-11-27 08:07:58 +00:00
2020-03-02 16:25:22 +00:00
- [Milvus Medium ](https://medium.com/@milvusio )
2019-10-15 10:42:20 +00:00
2020-03-02 16:25:22 +00:00
- [Milvus CSDN ](https://zilliz.blog.csdn.net/ )
2019-10-15 10:42:20 +00:00
2020-03-02 16:25:22 +00:00
- [Milvus Twitter ](https://twitter.com/milvusio )
2019-10-15 10:42:20 +00:00
2020-03-02 16:25:22 +00:00
- [Milvus Facebook ](https://www.facebook.com/io.milvus.5 )
2019-10-15 10:42:20 +00:00
2020-03-02 16:25:22 +00:00
- [Milvus design docs ](DESIGN.md )
2020-02-15 01:40:27 +00:00
2019-10-15 10:42:20 +00:00
## License
2019-11-27 08:16:18 +00:00
[Apache License 2.0 ](LICENSE )