mirror of
https://gitee.com/milvus-io/milvus.git
synced 2024-12-02 20:09:57 +08:00
85 lines
4.1 KiB
Markdown
85 lines
4.1 KiB
Markdown
|
|
|
|
|
|
[](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk)
|
|
|
|
|
|
[](https://codebeat.co/projects/github-com-jinhai-cn-milvus-master)
|
|
|
|
|
|
[](https://codecov.io/gh/milvus-io/milvus)
|
|
|
|
[中文版](README_CN.md) | [日本語版](README_JP.md)
|
|
|
|
## What is Milvus
|
|
|
|
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.
|
|
|
|
For more detailed introduction of Milvus and its architecture, see [Milvus overview](https://www.milvus.io/docs/en/aboutmilvus/overview/).
|
|
|
|
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.
|
|
|
|
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/).
|
|
|
|
## Get started
|
|
|
|
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).
|
|
|
|
To edit Milvus settings, read [Milvus configuration](https://www.milvus.io/docs/en/reference/milvus_config/).
|
|
|
|
### Try your first Milvus program
|
|
|
|
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).
|
|
|
|
To use C++ example code, use below command:
|
|
|
|
```shell
|
|
# Run Milvus C++ example
|
|
$ cd [Milvus root path]/core/milvus/bin
|
|
$ ./sdk_simple
|
|
```
|
|
|
|
## Roadmap
|
|
|
|
Please read our [roadmap](https://milvus.io/docs/en/roadmap/) for upcoming features.
|
|
|
|
## Contribution guidelines
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
## Join our community
|
|
|
|
To connect with other users and contributors, welcome to join our [Slack channel](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk).
|
|
|
|
## Contributors
|
|
|
|
Below is a list of Milvus contributors. We greatly appreciate your contributions!
|
|
|
|
- [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.
|
|
- [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.
|
|
|
|
## Resources
|
|
|
|
- [Milvus.io](https://www.milvus.io)
|
|
|
|
- [Milvus bootcamp](https://github.com/milvus-io/bootcamp)
|
|
|
|
- [Milvus test reports](https://github.com/milvus-io/milvus/tree/master/docs)
|
|
|
|
- [Milvus FAQ](https://www.milvus.io/docs/en/faq/operational_faq/)
|
|
|
|
- [Milvus Medium](https://medium.com/@milvusio)
|
|
|
|
- [Milvus CSDN](https://zilliz.blog.csdn.net/)
|
|
|
|
- [Milvus Twitter](https://twitter.com/milvusio)
|
|
|
|
- [Milvus Facebook](https://www.facebook.com/io.milvus.5)
|
|
|
|
## License
|
|
|
|
[Apache License 2.0](LICENSE)
|