jemeszhou/milvus-docs

This repository is for Milvus technical documentation update and maintenance. Visit Milvus.io for fully rendered technical documents.

Milvus Documentation

Welcome to Milvus documentation!

This repository contains technical documentation for Milvus, the world's most advanced open-source vector database.

This repository is for Milvus technical documentation update and maintenance. Visit Milvus.io or Web content repo for fully rendered documents.

Each branch corresponds to a Milvus release by name. We've set the branch of the latest Milvus release as the default branch. For documentation of a different Milvus release, switch to the corresponding branch.

Index

• Suggest changes

• Contribute to Milvus docs

• Active Milvus releases

• Other contributing channels

• Reference

• Get in touch

Suggest changes

Think of a new topic to be included in the docs? Need additional instructions or clarifications? Spot a broken link? Please open an issue.

Contribute to Milvus docs

Want to write the docs yourself? See CONTRIBUTING for details about setting yourself up and getting started.

Active Milvus releases

Currently, we maintain the following versions of Milvus documentation in different branches:

v2.0.0 branch	2.0.0 version (the default and latest branch)
v1.1.1 branch	1.1.1 version
v1.1.0 branch	1.1.0 version
v1.0.0 branch	1.0.0 version (first with long-term support)

Note: The latest branch is set as the default working branch. Milvus releases prior to v1.0.0 are no longer supported, but you can still find their documentation in the corresponding branch.

Other contributing channels

Not all content rendered on milvus.io is hosted in this repository.

Contribute to API docs

To make contributions to the Milvus SDK reference documentation, visit the programming language specific repositories listed below:

• PyMilvus ORM
• Node.js (released and under continuous development)
• GoLang

Contribute to community content

If you would like to write an article for our blog, please file an issue in the Milvus community repository or send it to [email protected]. Feel free to submit either a completed draft or article ideas. All submissions will be reviewed as quickly as possible. If your article or idea seems like a good fit for the blog, we will reach out to you directly.

In your title/subject line, please put in [blog submission] to make sure your email does not get buried.

Reference

Reference to cite when you use Milvus in a research paper:

@inproceedings{2021milvus,

  title={Milvus: A Purpose-Built Vector Data Management System},

  author={Wang, Jianguo and Yi, Xiaomeng and Guo, Rentong and Jin, Hai and Xu, Peng and Li, Shengjun and Wang, Xiangyu and Guo, Xiangzhou and Li, Chengming and Xu, Xiaohai and others},

  booktitle={Proceedings of the 2021 International Conference on Management of Data},

  pages={2614--2627},

  year={2021}

}

Get in touch

Join the Milvus community on Slack to share your suggestions, advice, and questions with our engineering team.

Subscribe to Milvus mailing lists:

• Technical Steering Committee

• Technical Discussions

• Announcement

Follow Milvus on social media:

• Medium

• Twitter