milvus-io/web-content

Milvus web documents and contents

Milvus Website

This repository contains technical documentation, blog articles, bootcamp resources and community pages in milvus.io. Milvus is an open-source vector database powering AI applications.

Please note that, despite all documentation rendered on the website is stored in this repository, some projects have their own separate repositories to maintain their project-specific documentation.

Contributions are welcome from everyone

Please refer to our guidelines for contributing for more instructions.

Generally, we follow the "fork-and-pull" Git workflow. Remember to sync your forked repository before submitting proposed changes upstream.

Issues

Flag issues and request improvements using the links below:

• Make change requests, report errors, or submit questions about this repository (technical documentation excluded).
• File technical documentation issues or request new technical documentation for Milvus.

Writing style

Technical documentation for Milvus is written in Markdown. In general, we adhere to the Google Developer Documentation Style Guide.

License

Milvus-io/web-content is licensed under the Apache License, Version 2.0. View a copy of the license in this repository's LICENSE file.

web-content's Issues

[Suggestion] Add a new index `IVF_PQ`

Is there anything that's missing or inappropriate in the docs? Please describe.
A new indexing method IVF_PQ is supported in v0.5.1. There's currently no corresponding doc about it.

Describe your suggestion
Add descriptions about this new index in Milvus Operations and Product FAQ topics.

[ERROR] The URL "https://milvus.io/docs/" in the milvus-io/docs GitHub page returns 403

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

Where is the error

The URL link seems invalid.

How would you like to improve it
Maybe we can change the URL to https://milvus.io/docs/en/aboutmilvus/overview.

[ERROR] Invalid links

Where is the error
There are some invalid links in doc topics such as Bechmarking and Product FAQ.

How would you like to improve it
Fix these broken links.

[Suggestion] Need to specify supported GPU type

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.
https://www.milvus.io/docs/zh-CN/userguide/install_milvus/
https://www.milvus.io/docs/en/userguide/install_milvus/

Describe your suggestion
Add the following info:
Note: For Milvus with GPU support, you also need to make sure that the GPU version is NVIDIA Pascal or higher.

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

[Suggestion] Add release notes for v0.5.3

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.
There is no release notes about v0.5.3 enhancements.

Describe your suggestion
Add corresponding release notes.

[Suggestion] Add table row count SDK

Is there anything that's missing or inappropriate in the docs? Please describe.
Some users woule like to know the row count in a particular table.

Describe your suggestion
Add table row count command in Milvus Operations.

[ERROR] The cpu_cache_capacity parameter description is not accurate

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/en/reference/milvus_config/

The cpu_cache_capacity parameter description is not accurate.

How would you like to improve it
We need to add more information. For example:

cpu_cache_capacity specifies the size of the CPU memory for caching search data. This parameter must be less than the total CPU memory size. It is recommended that you reserve part of the CPU memory for other operations.

gpu_cache_capacity specifies the size of the GPU memory for caching search data. This parameter must be less than the total GPU memory size.

[Suggestion] Add Java SDK

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.
I think it's better to add Java SDK since it is supported in v0.5.0.

Describe your suggestion
Add the Java SDK part in the doc

[Suggestion] Update Milvus config file per new template in pull request #729

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.
The Milvus config template has been updated per pull request #729 in milvus-io/milvus.

Describe your suggestion
Update the config file per pull request #729 in milvus-io/milvus. Make sure the updated config file is consistent with the version of the pull request

[ERROR] Add "Note" before "Although Milvus does not support directly deleting vectors..."

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?

https://milvus.io/docs/en/faq/operational_faq/
https://milvus.io/docs/zh-CN/faq/operational_faq/

How would you like to improve it

Add "Note" before "Although Milvus does not support directly deleting vectors...".

[Suggestion] Specify whether Milvus supports insert, update, delete, or query in our FAQ

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.
Users often ask about whether Milvus supports insert, update, delete, or query.

Describe your suggestion
We might add an FAQ to cover this info.

[ERROR] The filter command in the Learn Milvus Operations topic is missing an argument

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

Where is the error
In the Learn Milvus Operations topic, the following command is used to filter results:

>>> status, results = milvus.search_vectors(table_name='test01', query_records=q_records, top_k=2, query_ranges=[('2019-06-01', '2019-06-05')] )

However, the command does not work because nprobe, a required argument, is not included.

Tested in Milvus 0.5.2, pymilvus=0.2.3

How would you like to improve it
Please add the nprobe argument.

[Suggestion] some enhancement on docs

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

i think there has some enhancements in [Install milvus]

Describe your suggestion
1.change multi line with mkdir -p /home/$USER/milvus/conf
2.affter docker 19.03,nvidia-docker2 packages are deprecated. maybe need change docker start command to docker run -td --gpus all --name milvus -e "TZ=Asia/Shanghai" -p 19530:19530 -p 8080:8080 -v /home/$USER/milvus/db:/opt/milvus/db -v /home/$USER/milvus/conf:/opt/milvus/conf -v /home/$USER/milvus/logs:/opt/milvus/logs milvusdb/milvus:latest

Additional reference
Provide any other reference docs or websites about your request.
https://github.com/NVIDIA/nvidia-docker

[Suggestion] Improve some topics: Milvus Overview and Feature Vector

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

Describe your suggestion
Improve the following topics:

• Overview
• Feature Vector

[Suggestion] Remove SDKRef.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.
SDKRef.md is unnecessary.

Describe your suggestion
Remove SDKRef.md.

[Suggestion] Add 2 GPU cache parameters

Is there anything that's missing or inappropriate in the docs? Please describe.
GPU cache is supported in v0.5.0, and the config file needs to be updated.

Describe your suggestion
Add 2 GPU cache related parameters to the config file, and update corresponding doc.

wrong link in https://milvus.io/docs/en/QuickStart/

position:

Milvus Quick Start

In this guide, we will walk you through installing Milvus Docker as well as running some Python example codes. If you want to learn more about how to use Milvus, visit [Milvus Docker User Guide](../userguide/preface.md).

method:
change (../userguide/preface.md). to /userguide/preface/

[ERROR]When I start milvus of cpu version, I can find nothing in /home/$USER/milvus/logs.

When I start milvus of cpu version, I can find nothing in /home/$USER/milvus/logs. And I have created some tables.

[Suggestion] Add more version-specific FAQ content to the documentation

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.
We can add more version-specific FAQ content to store questions and answers about the product. This will help users troubleshoot problems themselves and save the effort of customer support.

[Suggestion] Remove the link to the release notes in the install 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.
In https://www.milvus.io/docs/en/userguide/install_milvus, there is a link supposed to be directed to the latest release notes. However, this is unnecessary as we have links in the readme and doc TOC. Moreover, this link needs manual updating.

Describe your suggestion
Suggest removing the sentence:
See here for what's new in the latest release.

[Suggestion] The Install Milvus topic should have a section for hardware requirements

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.
Hardware support information is missing in the Install Milvus topic. Users will find it difficult to determine whether they have the right hardware.

Describe your suggestion
We should add hardware support information to the Install Milvus topic.

Add QuickStart Chapter

We need the quick start chapter.

[Suggestion] Add a question to the FAQ about illegal instruction error

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.
Add a question to the FAQ about illegal instruction error.

[Suggestion] Add doc about "search results fewer than topk"

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.
User searched for top K vectors, yet there are less results than K.

Describe your suggestion
Add a description about why this happens.

[ERROR] Docker syntax error in the GPU-supported Milvus start command

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

Where is the error
Milvus install guide

How would you like to improve it

$ docker run -d --name milvus_gpu gpus all -e "TZ=Asia/Shanghai" -p 19530:19530 -p 8080:8080 -v /home/$USER/milvus/db:/var/lib/milvus/db -v /home/$USER/milvus/conf:/var/lib/milvus/conf -v /home/$USER/milvus/logs:/var/lib/milvus/logs milvusdb/milvus:latest

should be:

$ docker run -d --name milvus_gpu --gpus all -e "TZ=Asia/Shanghai" -p 19530:19530 -p 8080:8080 -v /home/$USER/milvus/db:/var/lib/milvus/db -v /home/$USER/milvus/conf:/var/lib/milvus/conf -v /home/$USER/milvus/logs:/var/lib/milvus/logs milvusdb/milvus:latest

[Suggestion] Update the Troubleshoot topic per pull request #121 in milvus-io/milvus

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.
Per pull request #121, error descriptions for servers have been updated and improved for better user experience. The current documentation no longer matches the 0.5.1 software.

Describe your suggestion
We can remove all server start error messages from the Troubleshoot topics because the information just duplicates the current error messages in the software. The software can already provide enough information for users to troubleshoot.

[ERROR] Fix a typo in Chinese install guide

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?
https://www.milvus.io/docs/zh-CN/userguide/install_milvus/

How would you like to improve it
若要拉取支持 CPU 的镜像： should be 若要拉取支持 GPU 的镜像：。

[Suggestion] Add a new index type NSG

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.
NSG index is not mentioned in the docs.

Describe your suggestion
Need to add a newly supported index called NSG.

Additional reference

[ERROR] I can't start milvus by using server_config_gpu.yaml. But I can start milvus by using server_config.yaml.

[Suggestion] Describe how Milvus processes vector IDs in the FAQ

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.
Users want to know how Milvus processes vector IDs in the FAQ. When are they auto-generated and when they are user-specified?

Describe your suggestion
Add a question to the FAQ.

[ERROR] Remove "delete vectors by range" in Milvus operations

Where is the error
In topic "Learn Milvus Operations"

How would you like to improve it
Remove the section about deleting vectors by range.

[Suggestion] Update parameter descriptions in server_config.yaml file

Is there anything that's missing or inappropriate in the docs? Please describe.
Some parameter descriptions are changed in Milvus config file template Thus the .server_config.yaml file needs to be updated accordingly.

Describe your suggestion
Update param descriptions in server_config.yaml.

[ERROR] In the "Vectors should be 2-dim array" question, specify the SDK type

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

Where is the error
In the "Vectors should be 2-dim array" question of the operational FAQ, specify the SDK type.

How would you like to improve it
The FAQ should be specific to Python SDK.

[Suggestion] Add information about building Milvus from source in the docker container to operational FAQ

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.
We need guidance to build Milvus from source.

Describe your suggestion
Add information about building Milvus from source in the docker container to operational FAQ.

[Suggestion] Update README and add CONTRIBUTING

Is there anything that's missing or inappropriate in the docs? Please describe.
The current README lacks sufficient information. Need to add a contribution doc about how to contribute to the docs.

Describe your suggestion
Add information such as how to contribute, writing style guide, etc.

[Suggestion] Improve some topics in Milvus documentation

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.
Some topics in Milvus documentation need improvement.

Describe your suggestion

• Improve topics in the reference folder and the user guide folder.
• Improve operation_faq.md.

[Suggestion] Add CONTRIBUTING

Is there anything that's missing or inappropriate in the docs? Please describe.
There is no contribution doc explaining what and how to contribute to Milvus docs.

Describe your suggestion
Add a CONTRIBUTING doc.

[Suggestion] Clarify whether Milvus is an end-to-end product in our FAQ

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.
Users want to know whether Milvus is an end-to-end product or only works with feature vectors.

Describe your suggestion
Add this info to the FAQ.

[ERROR] The overall architecture image in overview.md is broken because of an unexpected image file extension change in 0.5.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
The error exists in both English and Chinese version of overview.md. You can also see the error in the website:
https://milvus.io/docs/zh-CN/aboutmilvus/overview/
https://milvus.io/docs/en/aboutmilvus/overview/

What caused the error
The image name was milvus_arch.png in branch 0.4.0 but became milvus_arch.jpg in branch 0.5.0.

How would you like to improve it
Fix the broken link by updating the file extension to png.

Screenshots

[Suggestion] Improve the Traditional Database topic, the Vector Indexing Methods topic, and the Feature Vector Database topic

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

Describe your suggestion
Update the following topics in terms of wording and technical accuracy.

• Traditional Database
• Vector Indexing Methods
• Feature Vector Database

[Suggestion] Add a new index type `IVF_SQ8H`

Is there anything that's missing or inappropriate in the docs? Please describe.
IVF_SQ8H is supported in v0.5.0, yet there's no corresponding doc.

Describe your suggestion
Add description about this new indexing method.

我现在现有镜像下 构建这个工具怎么操作

我现在现有镜像下 构建这个工具怎么操作

[ERROR] Broken link in reference/data_manage.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
Broken link in reference/data_manage.md.

How would you like to improve it
Fix it!

[ERROR] The link http://docs.grafana.org/datasources/prometheus/ is 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
This link exists in multiple files.

How would you like to improve it
Update the link to http://grafana.com/docs/grafana/latest/features/datasources/prometheus/.

[Suggestion] Add one more parameter on config files

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.
One more parameter is added to milvus to control which tables will be loaded to memory at milvus startup.

Describe your suggestion
Please check with developer on the usage of this parameters

Additional reference
No

[Suggestion] Remove gpu-only configuration

Is there anything that's missing or inappropriate in the docs? Please describe.
As GPU-only search is no longer supported in v0.5.0, doc about resource configuration needs to be changed.

Describe your suggestion
Remove doc about configuring gpu as the only resource.

Additional info
GPU-only search might be supported in future releases.

[Suggestion] Clarify supported index types in each release in our FAQ

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.
Users often ask about supported index types in each release. Such info is recorded in our documentation but is hard to find.

Describe your suggestion
Create an FAQ question to clarify this info. Suggest using a table with index types and corresponding Milvus versions.

[ERROR] Error commands

In user guide:
$ mkdir -p /home/<$USER>/milvus/conf
$ cd home/<$USER>/milvus/conf

need to be changed to:
$ mkdir -p /home/$USER/milvus/conf
$ cd /home/$USER/milvus/conf

[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?"

[Suggestion] Clarify how we support distributed indexing in FAQ

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.
Users are not sure how we support distributed indexing. This info is not covered in the doc, either.

Describe your suggestion
We can provide such info in the FAQ.