milvus-io / 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. 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

Have a new topic that you want to include in the docs? Need additional instructions or clarifications? Spot a broken link? Please open an issue.

Contribute to Milvus docs

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

Active Milvus releases

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

v2.1.x branch	2.1.x version (the default and latest branch)
v2.0.x branch	2.0.x version
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 contribute to the Milvus SDK documentation, visit the language-specific repositories listed below:

• PyMilvus
• GO
• Java
• Node.js

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 contact [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 our 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, or questions with our engineering team.

Subscribe to Milvus's mailing lists:

• Technical Steering Committee

• Technical Discussions

• Announcement

Follow Milvus on social media:

• Medium

• Twitter

• LinkedIn

milvus-docs's Issues

[Suggestion] Add guide to get existing collection

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Is there anything that's missing or inappropriate in the docs? Please describe.
As per user questions, it seems our current doc doesn't show how to get an existing collection by name (there is only example/guide of creating a new collection).

Describe your suggestion
Add the following after "You can also get info of the collection." in tutorial (https://milvus.io/api-reference/pymilvus-orm/v2.0.0rc2/tutorial.html)

You can get an existing collection by its name.
collection=Collection(name=collection_name)

Additional reference
Provide any other reference docs or websites about your request.

[Suggestion] hyperlink the version part to install page

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Is there anything that's missing or inappropriate in the docs? Please describe.
Describe what the problem is, and where is it. Ex. I think it's better to add/change [...] in [Install Milvus].
hyperlink the version part to install page
Describe your suggestion
A clear and concise description of what you want to change or add.

Additional reference
Provide any other reference docs or websites about your request.

[ERROR] wrong roadmap timeline

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Where is the error
What is the URL/path of the document related to this issue?

How would you like to improve it

Screenshots
If applicable, add screenshots to help explain your problem.

[ERROR] Doc home blog image down

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Where is the error
What is the URL/path of the document related to this issue?
doc home
How would you like to improve it
fix the image link
Screenshots
If applicable, add screenshots to help explain your problem.

[ERROR] Wrong description on FAQ

https://milvus.io/docs/v2.0.0/product_faq.md#Can-multiple-indexes-be-created-for-the-same-field-in-a-collection

Multiple indexes on the same filed are not supported.

[Suggestion]Update the returned result of ServiceMonitor in monitor.md

The result should be

kubectl get servicemonitor
NAME                           AGE
my-release-milvus              54s

[ERROR] Duplicate menu id

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Where is the error
What is the URL/path of the document related to this issue?

How would you like to improve it

Screenshots
If applicable, add screenshots to help explain your problem.

[Suggestion] CN translate Milvus insight docs.

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Is there anything that's missing or inappropriate in the docs? Please describe.
Describe what the problem is, and where is it. Ex. I think it's better to add/change [...] in [Install Milvus].

Describe your suggestion
A clear and concise description of what you want to change or add.

Additional reference
Provide any other reference docs or websites about your request.

[ERROR] link error on expression.md

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Where is the error
What is the URL/path of the document related to this issue?

How would you like to improve it

Screenshots
If applicable, add screenshots to help explain your problem.

[Suggestion]Update menu structure

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Is there anything that's missing or inappropriate in the docs? Please describe.
Describe what the problem is, and where is it. Ex. I think it's better to add/change [...] in [Install Milvus].

Describe your suggestion
A clear and concise description of what you want to change or add.

Additional reference
Provide any other reference docs or websites about your request.

[ERROR] milvus-docs/site/en/getstarted links broken

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Where is the error
I am trying to follow the instructions to Install Milvus and following the User guide on https://github.com/milvus-io/milvus-docs/tree/v2.0.0/site/en/getstarted

It looks like all the links here are broken.

How would you like to improve it

Screenshots
If applicable, add screenshots to help explain your problem.

[Suggestion] Add hyperlink to rawgithub on install-docker pages

Note: This repository is ONLY used to solve issues related to DOCS
For other issues, please move to other repositories.

Is there anything that's missing or inappropriate in the docs? Please describe.
Describe what the problem is, and where is it. Ex. I think it's better to add/change [...] in [Install Milvus].

Describe your suggestion
A clear and concise description of what you want to change or add.

Additional reference
Provide any other reference docs or websites about your request.

[Suggestion] add FAQs

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Is there anything that's missing or inappropriate in the docs? Please describe.
Describe what the problem is, and where is it. Ex. I think it's better to add/change [...] in [Install Milvus].

Describe your suggestion
A clear and concise description of what you want to change or add.

Additional reference
Provide any other reference docs or websites about your request.

[Suggestion]Update README

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Is there anything that's missing or inappropriate in the docs? Please describe.
Describe what the problem is, and where is it. Ex. I think it's better to add/change [...] in [Install Milvus].

Describe your suggestion
A clear and concise description of what you want to change or add.

Additional reference
Provide any other reference docs or websites about your request.

[Suggestion]CN translate data_processing.md

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Is there anything that's missing or inappropriate in the docs? Please describe.
Describe what the problem is, and where is it. Ex. I think it's better to add/change [...] in [Install Milvus].

Describe your suggestion
A clear and concise description of what you want to change or add.

Additional reference
Provide any other reference docs or websites about your request.

[ERROR] wrong h2 in deploy s3

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Where is the error
What is the URL/path of the document related to this issue?
wrong h2 in deploy s3
How would you like to improve it

Screenshots
If applicable, add screenshots to help explain your problem.

[Suggestion]Add Data Processing under Architecture

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Is there anything that's missing or inappropriate in the docs? Please describe.
Describe what the problem is, and where is it. Ex. I think it's better to add/change [...] in [Install Milvus].

Describe your suggestion
A clear and concise description of what you want to change or add.

Additional reference
Provide any other reference docs or websites about your request.

[Suggestion] Add a guide to Milvus insight - Overview

[ERROR] delete title field

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Where is the error
What is the URL/path of the document related to this issue?

How would you like to improve it

Screenshots
If applicable, add screenshots to help explain your problem.

Hello Robot [QUESTION]

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Before submitting your question, make sure you have:

• Googled your question.
• Searched the GitHub issues.
• Read the documentation

"What is your question?"

[ERROR] Missing navigation for Chinese FAQs (Milvus v2.0.0)

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Where is the error
When Milvus version is v2.0.0 & language is Chinese, there is no navigation in web page for FAQs pages. Missing FAQs tab in menu bar.
I can only access Chinese FAQs pages for v2.0.0 following steps: English version FAQs > Change language

How would you like to improve it
Add menu bar for FAQs pages when language is Chinese & version is v2.0.0

Screenshots
If applicable, add screenshots to help explain your problem.

[Suggestion] Translate the alert section in monitor.md into CN.

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Is there anything that's missing or inappropriate in the docs? Please describe.
Describe what the problem is, and where is it. Ex. I think it's better to add/change [...] in [Install Milvus].

Describe your suggestion
A clear and concise description of what you want to change or add.

Additional reference
Provide any other reference docs or websites about your request.

Binary field index type error

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Where is the error
https://milvus.io/docs/v2.0.0/metric.md#binary

How would you like to improve it
In binary field, index should be BIN_FLAT and BIN_IVF_FLAT

Screenshots

[Suggestion]CN Translate index.md and index_selection.md

[ERROR] inconsistent format in index.md

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Where is the error
What is the URL/path of the document related to this issue?

How would you like to improve it

Screenshots
If applicable, add screenshots to help explain your problem.

[Suggestion] Add What's Next at the bottom of Architecture Overview

[Suggestion] Style for html and markdown tables are inconsistent.

Where is the issue:
https://milvus.io/docs/v2.0.0/hybrid.md

On the same webpage, the table written in markdown format is displayed as:

While the other table written in html format is displayed as:

I have to write the second table in the html format because there is a symbol "||"" that can not be properly recognized in the markdown format.

[Suggestion] reconstruct sys config structure

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Is there anything that's missing or inappropriate in the docs? Please describe.
Describe what the problem is, and where is it. Ex. I think it's better to add/change [...] in [Install Milvus].

Describe your suggestion
A clear and concise description of what you want to change or add.

Additional reference
Provide any other reference docs or websites about your request.

[Suggestion] Replace "PyMilvus-ORM" with "PyMilvus"

pymilvus and pymilvus-orm repos have been combined. "PyMilvus-ORM", "pymilvus_orm", "Python (ORM)", and other expressions that specify ORM should be updated, and so should the related links.

[Suggestion] CN Translate hybrid.md

Please translate the doc hybrid.md into EN. Thanks!

[Suggestion]Update glossary.md

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Is there anything that's missing or inappropriate in the docs? Please describe.
Describe what the problem is, and where is it. Ex. I think it's better to add/change [...] in [Install Milvus].

Describe your suggestion
A clear and concise description of what you want to change or add.

Additional reference
Provide any other reference docs or websites about your request.

[Suggestion] delete statement on not supporting async search

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Is there anything that's missing or inappropriate in the docs? Please describe.
Describe what the problem is, and where is it. Ex. I think it's better to add/change [...] in [Install Milvus].

Describe your suggestion
A clear and concise description of what you want to change or add.

Additional reference
Provide any other reference docs or websites about your request.

[ERROR] typo on homepage

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Where is the error
...approximate nearest neighbor (ANN) search liraries (e.g. Faiss, ...

How would you like to improve it

Screenshots
If applicable, add screenshots to help explain your problem.

[Suggestion] update topk limitation in accordance with #7095

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Is there anything that's missing or inappropriate in the docs? Please describe.
Describe what the problem is, and where is it. Ex. I think it's better to add/change [...] in [Install Milvus].

Describe your suggestion
A clear and concise description of what you want to change or add.

Additional reference
Provide any other reference docs or websites about your request.

[ERROR] delete explore_pymilvus.md and update relevant links

delete explore_pymilvus.md and update relevant links

[Suggestion] Add the CN version of Node SDK to user guide.

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Is there anything that's missing or inappropriate in the docs? Please describe.
Describe what the problem is, and where is it. Ex. I think it's better to add/change [...] in [Install Milvus].

Describe your suggestion
A clear and concise description of what you want to change or add.

Additional reference
Provide any other reference docs or websites about your request.

[Suggestion] menu reference duplicate

menu reference duplicate

[ERROR] image down on main_components

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Where is the error
What is the URL/path of the document related to this issue?

How would you like to improve it

Screenshots
If applicable, add screenshots to help explain your problem.

[ERROR] CN Menu is disordered

fix CN menu

[ERROR] image down in multiple pages

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Where is the error
What is the URL/path of the document related to this issue?

How would you like to improve it

Screenshots
If applicable, add screenshots to help explain your problem.

[Suggestion] add CN RC4 Release note

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Is there anything that's missing or inappropriate in the docs? Please describe.
Describe what the problem is, and where is it. Ex. I think it's better to add/change [...] in [Install Milvus].

Describe your suggestion
A clear and concise description of what you want to change or add.

Additional reference
Provide any other reference docs or websites about your request.

[Suggestion]Update docs under About Milvus

Update features that have been developed and released.
Add Milvus CLI.

[Suggestion] revise connect.md title and intro

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Is there anything that's missing or inappropriate in the docs? Please describe.
Describe what the problem is, and where is it. Ex. I think it's better to add/change [...] in [Install Milvus].

Describe your suggestion
A clear and concise description of what you want to change or add.

Additional reference
Provide any other reference docs or websites about your request.

[ERROR] wrong title level in build.md

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Where is the error
What is the URL/path of the document related to this issue?

How would you like to improve it

Screenshots
If applicable, add screenshots to help explain your problem.

[Suggestion] Update index.md and add index_selection.md

Repurpose Vector Index and add an index selection guide.

[Suggestion]Add Milvus doesn't support Apple Silicon.

Add Milvus doesn't support Apple Silicon.

[Suggestion] add query operation in user guide

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Is there anything that's missing or inappropriate in the docs? Please describe.
Describe what the problem is, and where is it. Ex. I think it's better to add/change [...] in [Install Milvus].

Describe your suggestion
A clear and concise description of what you want to change or add.

Additional reference
Provide any other reference docs or websites about your request.

[Suggestion]Wrong method call to create a collection in create.md

Please change from create_collection() to Collection()

[Suggestion]Add Milvus CLI link under Tools

Note: This repository is ONLY used to solve issues related to DOCS.
For other issues, please move to other repositories.

Is there anything that's missing or inappropriate in the docs? Please describe.
Describe what the problem is, and where is it. Ex. I think it's better to add/change [...] in [Install Milvus].

Describe your suggestion
A clear and concise description of what you want to change or add.

Additional reference
Provide any other reference docs or websites about your request.

[Suggestion] The display of the code is weird.

The last chunk of code on this page (https://milvus.io/docs/v2.0.0/example_code.md) is not displayed properly.

Desired display is: