fix errors in .mds (#4644)

* Updated logo and architecture links. (#2529)

Signed-off-by: PahudPlus <haimeng.cai@zilliz.com>

* Fixed broken links. (#2902)

Signed-off-by: PahudPlus <haimeng.cai@zilliz.com>

* Minor editorial updates. (#2946)

Signed-off-by: Amy Hong <yun.hong@zilliz.com>

* fix cuda version requirement (#2909)

Signed-off-by: Xiangyu Wang <xy.wang@zilliz.com>

* [skip ci] Updated INSTALL.md.  (#3016)

Signed-off-by: Amy Hong <yun.hong@zilliz.com>

* [skip ci] Fixed broken links. (#3304)

Signed-off-by: Amy Hong <yun.hong@zilliz.com>

* [skip ci] update install from code (#3855)

Signed-off-by: shengjun.li <shengjun.li@zilliz.com>

* [skip ci] update cmake version (#4084)

Signed-off-by: shengjun.li <shengjun.li@zilliz.com>

* [skip ci] Update the foundation name. (#4438)

Signed-off-by: ireneontheway5 <qingying.hu@zilliz.com>

* [skip ci] Added a space for readability (#4465)

Added a space between the heart emoji and the word for better readability.

Signed-off-by: Mark Berger <maberger0811@gmail.com>

* [skip ci] Update links and fix dead links. (#4496)

Signed-off-by: ireneontheway5 <qingying.hu@zilliz.com>

* [skip ci] fix errors in mds

Signed-off-by: shengjun.li <shengjun.li@zilliz.com>

Co-authored-by: PahudPlus <64403786+PahudPlus@users.noreply.github.com>
Co-authored-by: JinHai-CN <hai.jin@zilliz.com>
Co-authored-by: AmyYH <68527082+AmyYH@users.noreply.github.com>
Co-authored-by: Wang XiangYu <xy.wang@zilliz.com>
Co-authored-by: ireneontheway5 <75291211+ireneontheway5@users.noreply.github.com>
Co-authored-by: Mark Berger <maberger0811@gmail.com>
pull/4651/head^2
shengjun.li 2021-01-22 19:16:40 +08:00 committed by GitHub
parent 19cd3d8f7c
commit f942f0b823
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
17 changed files with 123 additions and 96 deletions

View File

@ -1,7 +1,7 @@
# Changelog
Please mark all change in change log and use the issue from GitHub
# Milvus 0.10.5 (TBD)
# Milvus 0.10.5 (2021-01-07)
## Bug
- \#4296,#4554 Fix mishards add name-mismatched pod to read-only group
- \#4307 Specify partition to load for load_collection()

View File

@ -35,7 +35,7 @@ The Milvus team members will review your pull requests, and once it is accepted,
Please create a new branch from an up-to-date master on your fork.
1. Fork the repository on GitHub.
2. Clone your fork to your local machine with `git clone git@github.com:<yourname>/milvus-io/milvus.git`.
2. Clone your fork to your local machine with `git clone git@github.com:<yourname>/milvus.git`.
3. Create a branch with `git checkout -b my-topic-branch`.
4. Make your changes, commit, then push to to GitHub with `git push --set-upstream origin my-topic-branch`. You must record your changes in [CHANGELOG.md](CHANGELOG.md) with issue numbers and descriptions.
5. Visit GitHub and make your pull request.

View File

@ -4,31 +4,31 @@
- [Build from source](#build-from-source)
- [Requirements](#requirements)
- [Requirements](#requirements)
- [Compilation](#compilation)
- [Compilation](#compilation)
- [Launch Milvus server](#launch-milvus-server)
- [Launch Milvus server](#launch-milvus-server)
- [Compile Milvus on Docker](#compile-milvus-on-docker)
- [Compile Milvus on Docker](#compile-milvus-on-docker)
- [Step 1 Pull Milvus Docker images](#step-1-pull-milvus-docker-images)
- [Step 1 Pull Milvus Docker images](#step-1-pull-milvus-docker-images)
- [Step 2 Start the Docker container](#step-2-start-the-docker-container)
- [Step 2 Start the Docker container](#step-2-start-the-docker-container)
- [Step 3 Download Milvus source code](#step-3-download-milvus-source-code)
- [Step 3 Download Milvus source code](#step-3-download-milvus-source-code)
- [Step 4 Compile Milvus in the container](#step-4-compile-milvus-in-the-container)
- [Step 4 Compile Milvus in the container](#step-4-compile-milvus-in-the-container)
- [Troubleshooting](#troubleshooting)
- [Error message: `protocol https not supported or disabled in libcurl`](#error-message-protocol-https-not-supported-or-disabled-in-libcurl)
- [Error message: `protocol https not supported or disabled in libcurl`](#error-message-protocol-https-not-supported-or-disabled-in-libcurl)
- [Error message: `internal compiler error`](#error-message-internal-compiler-error)
- [Error message: `internal compiler error`](#error-message-internal-compiler-error)
- [Error message: `error while loading shared libraries: libmysqlpp.so.3`](#error-message-error-while-loading-shared-libraries-libmysqlppso3)
- [Error message: `error while loading shared libraries: libmysqlpp.so.3`](#error-message-error-while-loading-shared-libraries-libmysqlppso3)
- [CMake version is not supported](#cmake-version-is-not-supported)
- [CMake version is not supported](#cmake-version-is-not-supported)
<!-- /TOC -->
@ -42,64 +42,77 @@
- CentOS 7
> Note: If your Linux operating system does not meet the requirements, we recommend that you pull a Docker image of [Ubuntu 18.04](https://docs.docker.com/install/linux/docker-ce/ubuntu/) or [CentOS 7](https://docs.docker.com/install/linux/docker-ce/centos/) as your compilation environment.
> Note: If your Linux operating system does not meet the requirements, we recommend that you pull a Docker image of [Ubuntu 18.04](https://docs.docker.com/install/linux/docker-ce/ubuntu/) or [CentOS 7](https://docs.docker.com/install/linux/docker-ce/centos/) as your compilation environment.
- GCC 7.0 or higher to support C++ 17
- CMake 3.12 or higher
- CMake 3.14 or higher
- Git
For GPU-enabled version, you will also need:
- CUDA 10.0 or higher
- CUDA 10.x (10.0, 10.1, 10.2)
- NVIDIA driver 418 or higher
### Compilation
#### Step 1 Install dependencies
#### Step 1 Download Milvus source code and specify version
Download Milvus source code, change directory and specify version (for example, 0.10.3):
```shell
$ git clone https://github.com/milvus-io/milvus
$ cd ./milvus/core
$ git checkout 0.10.3
```
#### Step 2 Install dependencies
##### Install in Ubuntu
```shell
$ cd [Milvus root path]/core
$ ./ubuntu_build_deps.sh
```
##### Install in CentOS
```shell
$ cd [Milvus root path]/core
$ ./centos7_build_deps.sh
```
#### Step 2 Build
#### Step 3 Build Milvus source code
```shell
$ cd [Milvus root path]/core
$ ./build.sh -t Debug
```
If you want to use CPU-only:
or
run `build.sh`:
```shell
$ ./build.sh -t Release
```
By default, it will build CPU-only version. To build GPU version, add `-g` option.
If you want to use GPU-enabled:
1. Add cuda library path to `LD_LIBRARY_PATH`:
```shell
$ ./build.sh -g
$ export LD_LIBRARY_PATH=/usr/local/cuda/lib64:$LD_LIBRARY_PATH
```
If you want to know the complete build options, run the following command.
2. Add cuda binary path to `PATH`:
```shell
$./build.sh -h
$ export PATH=/usr/local/cuda/bin:$PATH
```
When the build is completed, everything that you need in order to run Milvus will be installed under `[Milvus root path]/core/milvus`.
3. Add a `-g` parameter to run `build.sh`:
```shell
$ ./build.sh -g -t Release
```
When the build completes, everything that you need to run Milvus is under `[Milvus root path]/core/milvus`.
### Launch Milvus server
@ -132,23 +145,40 @@ With the following Docker images, you should be able to compile Milvus on any Li
### Step 1 Pull Milvus Docker images
#### ubuntu18.04
Pull CPU-only image:
```shell
$ docker pull milvusdb/milvus-cpu-build-env:latest
$ docker pull milvusdb/milvus-cpu-build-env:v0.7.0-ubuntu18.04
```
Pull GPU-enabled image:
```shell
$ docker pull milvusdb/milvus-gpu-build-env:latest
$ docker pull milvusdb/milvus-gpu-build-env:v0.7.0-ubuntu18.04
```
#### CentOs7
Pull CPU-only image:
```shell
$ docker pull milvusdb/milvus-cpu-build-env:v0.7.0-centos7
```
Pull GPU-enabled image:
```shell
$ docker pull milvusdb/milvus-gpu-build-env:v0.7.0-centos7
```
### Step 2 Start the Docker container
Start a CPU-only container:
```shell
$ docker run -it -p 19530:19530 -d milvusdb/milvus-cpu-build-env:latest
$ docker run -it -p 19530:19530 -d <milvus_cpu_docker_image>
```
Start a GPU container:
@ -156,13 +186,13 @@ Start a GPU container:
- For nvidia docker 2:
```shell
$ docker run --runtime=nvidia -it -p 19530:19530 -d milvusdb/milvus-gpu-build-env:latest
$ docker run --runtime=nvidia -it -p 19530:19530 -d <milvus_gpu_docker_image>
```
- For nvidia container toolkit:
```shell
docker run --gpus all -it -p 19530:19530 -d milvusdb/milvus-gpu-build-env:latest
docker run --gpus all -it -p 19530:19530 -d <milvus_gpu_docker_image>
```
To enter the container:
@ -173,10 +203,9 @@ $ docker exec -it [container_id] bash
### Step 3 Download Milvus source code
Download latest Milvus source code:
Download Milvus source code:
```shell
$ cd /home
$ git clone https://github.com/milvus-io/milvus
```
@ -186,6 +215,12 @@ To enter its core directory:
$ cd ./milvus/core
```
Specify version (for example, 0.10.3):
```shell
$ git checkout 0.10.3
```
### Step 4 Compile Milvus in the container
If you are using a CPU-only image:
@ -267,16 +302,16 @@ Follow the steps below to solve this problem:
Follow the steps below to install a supported version of CMake:
1. Remove the unsupported version of CMake.
2. Get CMake 3.12 or higher. Here we get CMake 3.12.
2. Get CMake 3.14 or higher. Here we get CMake 3.14.
```shell
$ wget https://cmake.org/files/v3.12/cmake-3.12.2-Linux-x86_64.tar.gz
$ wget https://cmake.org/files/v3.14/cmake-3.14.7-Linux-x86_64.tar.gz
```
3. Extract the file and install CMake.
```shell
$ tar zxvf cmake-3.12.2-Linux-x86_64.tar.gz
$ mv cmake-3.12.2-Linux-x86_64 /opt/cmake-3.12.2
$ ln -sf /opt/cmake-3.12.2/bin/* /usr/bin/
$ tar zxvf cmake-3.14.7-Linux-x86_64.tar.gz
$ mv cmake-3.14.7-Linux-x86_64 /opt/cmake-3.14.7
$ ln -sf /opt/cmake-3.14.7/bin/* /usr/bin/
```

View File

@ -1,5 +1,4 @@
![Milvuslogo](https://github.com/milvus-io/docs/blob/master/assets/milvus_logo.png)
![Milvuslogo](https://github.com/milvus-io/docs/blob/master/v0.9.1/assets/milvus_logo.png)
[![Slack](https://img.shields.io/badge/Join-Slack-orange)](https://join.slack.com/t/milvusio/shared_invite/zt-e0u4qu3k-bI2GDNys3ZqX1YCJ9OM~GQ)
![GitHub](https://img.shields.io/github/license/milvus-io/milvus)
![Docker pulls](https://img.shields.io/docker/pulls/milvusdb/milvus)
@ -11,29 +10,26 @@
[![CodeFactor Grade](https://www.codefactor.io/repository/github/milvus-io/milvus/badge)](https://www.codefactor.io/repository/github/milvus-io/milvus)
[![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)
English | [中文版](README_CN.md)
## What is Milvus
As an open source vector similarity search engine, Milvus is easy-to-use, highly reliable, scalable, robust, and blazing fast. Adopted by over 100 organizations and institutions worldwide, Milvus empowers applications in a variety of fields, including image processing, computer vision, natural language processing, voice recognition, recommender systems, drug discovery, etc.
As an open source vector similarity search engine, Milvus is easy-to-use, highly reliable, scalable, robust, and blazing fast. Adopted by over 100 organizations and institutions worldwide, Milvus empowers applications in a variety of fields, including image processing, computer vision, natural language processing, voice recognition, recommender systems, drug discovery, and more.
Milvus has the following architecture:
The following is Milvus architecture:
![arch](https://github.com/milvus-io/docs/blob/v0.7.1/assets/milvus_arch.png)
![arch](https://github.com/milvus-io/docs/blob/master/v0.9.1/assets/milvus_arch.png)
For more detailed introduction of Milvus and its architecture, see [Milvus overview](https://www.milvus.io/docs/overview.md). See Milvus [release notes](https://www.milvus.io/docs/release_notes.md) to keep up-to-date with its releases and updates.
For more detailed introduction of Milvus and its architecture, see [Milvus overview](https://www.milvus.io/docs/about_milvus/overview.md). Keep up-to-date with newest releases and latest updates by reading Milvus [release notes](https://www.milvus.io/docs/releases/release_notes.md).
Milvus is an [LF AI Foundation](https://lfai.foundation/) incubation project. Learn more at [lfai.foundation](https://lfai.foundation/).
Milvus is an incubation-stage project at [LF AI & Data Foundation](https://lfaidata.foundation/).
## Get started
### Install Milvus
See the [Milvus install guide](https://www.milvus.io/docs/guides/get_started/install_milvus/install_milvus.md) to install Milvus using Docker. To install Milvus from source code, see [build from source](INSTALL.md).
See [Milvus install guide](https://www.milvus.io/docs/install_milvus.md) to install Milvus using Docker. To install Milvus from source code, see [build from source](INSTALL.md).
### Try example programs
Try an example 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), [Go](https://github.com/milvus-io/milvus-sdk-go/tree/master/examples), or [C++ example code](https://github.com/milvus-io/milvus/tree/master/sdk/examples).
Try an example program with Milvus using [Python](https://www.milvus.io/docs/example_code.md), [Java](https://github.com/milvus-io/milvus-sdk-java/tree/master/examples), [Go](https://github.com/milvus-io/milvus-sdk-go/tree/master/examples), or [C++ example code](https://github.com/milvus-io/milvus/tree/master/sdk/examples).
## Supported clients
@ -42,11 +38,11 @@ Try an example program with Milvus using [Python](https://www.milvus.io/docs/gui
- [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/))
- [Node.js](https://www.npmjs.com/package/@arkie-ai/milvus-client) (Contributed by [arkie](https://www.arkie.cn/))
## Application scenarios
You can use Milvus to build intelligent systems in a variety of AI application scenarios. Refer to [Milvus Scenarios](https://milvus.io/scenarios) for live demos. You can also refer to [Milvus Bootcamp](https://github.com/milvus-io/bootcamp) for detailed solutions and application scenarios.
You can use Milvus to build intelligent systems in a variety of AI application scenarios. See [Milvus Scenarios](https://milvus.io/scenarios) for live demos. You can also see [Milvus Bootcamp](https://github.com/milvus-io/bootcamp) for detailed solutions and application scenarios.
## Benchmark
@ -54,21 +50,21 @@ See our [test reports](https://github.com/milvus-io/milvus/tree/master/docs) for
## Roadmap
To learn what's coming up soon in Milvus, read our [Roadmap](https://github.com/milvus-io/milvus/projects).
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:
It is a Work in Progress, and is subject to reasonable adjustments when necessary. And we greatly appreciate any comments/requirements/suggestions regarding Milvus' roadmap.:clap:
## 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.
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. You must abide by this code in order to participate.
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
:heart:To connect with other users and contributors, welcome to join our [Slack channel](https://join.slack.com/t/milvusio/shared_invite/zt-e0u4qu3k-bI2GDNys3ZqX1YCJ9OM~GQ).
:heart: To connect with other users and contributors, welcome to join our [Slack channel](https://join.slack.com/t/milvusio/shared_invite/zt-e0u4qu3k-bI2GDNys3ZqX1YCJ9OM~GQ).
See our [community](https://github.com/milvus-io/community) repository to learn about our governance and access more community resources.
See our [community](https://github.com/milvus-io/community) repository to learn more about our governance and access more community resources.
## Resources

View File

@ -1,5 +1,5 @@
![Milvuslogo](https://github.com/milvus-io/docs/blob/master/assets/milvus_logo.png)
![Milvuslogo](https://github.com/milvus-io/docs/blob/master/v0.9.1/assets/milvus_logo.png)
[![Slack](https://img.shields.io/badge/Join-Slack-orange)](https://join.slack.com/t/milvusio/shared_invite/zt-e0u4qu3k-bI2GDNys3ZqX1YCJ9OM~GQ)
![GitHub](https://img.shields.io/github/license/milvus-io/milvus)
@ -21,21 +21,21 @@ Milvus 是一款开源的特征向量相似度搜索引擎,具有使用方便
Milvus 的架构如下:
![arch](https://github.com/milvus-io/docs/raw/v0.7.1/assets/milvus_arch.png)
![arch](https://github.com/milvus-io/docs/blob/master/v0.9.1/assets/milvus_arch.png)
若要了解 Milvus 详细介绍和整体架构,请访问 [Milvus 简介](https://www.milvus.io/cn/docs/about_milvus/overview.md)。您可以通过 [版本发布说明](https://www.milvus.io/cn/docs/releases/release_notes.md) 获取最新版本的功能和更新。
若要了解 Milvus 详细介绍和整体架构,请访问 [Milvus 简介](https://www.milvus.io/docs/overview.md)。你可以通过 [版本发布说明](https://www.milvus.io/docs/release_notes.md) 获取最新版本的功能和更新。
Milvus是一个[LF AI基金会](https://lfai.foundation/)的孵化项目。获取更多,请访问[lfai.foundation](https://lfai.foundation/)。
Milvus是一个 [LF AI & Data 基金会](https://lfaidata.foundation/)的孵化项目。获取更多,请访问[lfai.foundation](https://lfaidata.foundation/)。
## Milvus 快速上手
### 安装 Milvus
请参阅 [Milvus 安装指南](https://www.milvus.io/cn/docs/guides/get_started/install_milvus/install_milvus.md) 使用 Docker 容器安装 Milvus。若要基于源码编译请访问 [源码安装](INSTALL.md)。
请参阅 [Milvus 安装指南](https://www.milvus.io/docs/install_milvus.md) 使用 Docker 容器安装 Milvus。若要基于源码编译请访问 [源码安装](INSTALL.md)。
### 尝试示例代码
可以尝试用 [Python](https://www.milvus.io/cn/docs/guides/get_started/example_code.md)[Java](https://github.com/milvus-io/milvus-sdk-java/tree/master/examples)[Go](https://github.com/milvus-io/milvus-sdk-go/tree/master/examples),或者 [C++](https://github.com/milvus-io/milvus/tree/master/sdk/examples) 运行 Milvus 示例代码。
可以尝试用 [Python](https://www.milvus.io/docs/example_code.md)[Java](https://github.com/milvus-io/milvus-sdk-java/tree/master/examples)[Go](https://github.com/milvus-io/milvus-sdk-go/tree/master/examples),或者 [C++](https://github.com/milvus-io/milvus/tree/master/sdk/examples) 运行 Milvus 示例代码。
## 支持的客户端
@ -48,7 +48,7 @@ Milvus是一个[LF AI基金会](https://lfai.foundation/)的孵化项目。获
## 应用场景
Milvus 可以应用于多种 AI 场景。可以访问 [Milvus 应用场景](https://milvus.io/scenarios) 体验在线场景展示。也可以访问 [Milvus 训练营](https://github.com/milvus-io/bootcamp) 了解更详细的应用场景和解决方案。
Milvus 可以应用于多种 AI 场景。可以访问 [Milvus 应用场景](https://milvus.io/scenarios) 体验在线场景展示。也可以访问 [Milvus 训练营](https://github.com/milvus-io/bootcamp) 了解更详细的应用场景和解决方案。
## 性能基准测试
@ -56,15 +56,15 @@ Milvus 可以应用于多种 AI 场景。您可以访问 [Milvus 应用场景](h
## 路线图
您可以参考我们的[路线图](https://github.com/milvus-io/milvus/projects),了解 Milvus 即将实现的新特性。
你可以参考我们的[路线图](https://github.com/milvus-io/milvus/milestones),了解 Milvus 即将实现的新特性。
路线图尚未完成,并且可能会存在合理改动。我们欢迎各种针对路线图的意见、需求和建议。
## 贡献者指南
我们由衷欢迎推送贡献。关于贡献流程的详细信息,请参阅[贡献者指南](https://github.com/milvus-io/milvus/blob/master/CONTRIBUTING.md)。本项目遵循 Milvus [行为准则](https://github.com/milvus-io/milvus/blob/master/CODE_OF_CONDUCT.md)。如果希望参与本项目,请遵守该准则的内容。
我们由衷欢迎推送贡献。关于贡献流程的详细信息,请参阅[贡献者指南](https://github.com/milvus-io/milvus/blob/master/CONTRIBUTING.md)。本项目遵循 Milvus [行为准则](https://github.com/milvus-io/milvus/blob/master/CODE_OF_CONDUCT.md)。如果希望参与本项目,请遵守该准则的内容。
我们使用 [GitHub issues](https://github.com/milvus-io/milvus/issues) 追踪问题和补丁。若希望提出问题或进行讨论,请加入我们的社区。
我们使用 [GitHub issues](https://github.com/milvus-io/milvus/issues) 追踪问题和补丁。若希望提出问题或进行讨论,请加入我们的社区。
## 加入 Milvus 社区

View File

@ -3,9 +3,9 @@
We use GitHub for tracking bugs and feature requests. If you need any support for using Milvus, please refer to the following resources below.
## Documentation
- [User Documentation](https://www.milvus.io/docs/guides/get_started/install_milvus/install_milvus.md)
- [Troubleshooting Guide](https://www.milvus.io/docs/v0.6.0/guides/troubleshoot.md)
- [FAQ](https://www.milvus.io/docs/v0.6.0/faq/operational_faq.md)
- [User Documentation](https://www.milvus.io/docs/install_milvus.md)
- [Troubleshooting Guide](https://www.milvus.io/docs/troubleshoot.md)
- [FAQ](https://www.milvus.io/docs/operational_faq.md)
## Real-time chat
[Slack](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk): The #general channel is the place where people offer support.

View File

@ -41,7 +41,7 @@
## Overview
With the RESTful API, you can use Milvus by sending HTTP requests to the Milvus server web port. The RESTful API is available as long as you have a running Milvus server. You can set the web port in the Milvus configuration file. Refer to [Milvus Configuration](https://www.milvus.io/docs/reference/milvus_config.md) for more information.
With the RESTful API, you can use Milvus by sending HTTP requests to the Milvus server web port. The RESTful API is available as long as you have a running Milvus server. You can set the web port in the Milvus configuration file. Refer to [Milvus Configuration](https://www.milvus.io/docs/milvus_config.md) for more information.
## API Reference
@ -690,7 +690,8 @@ Updates the index type and nlist of a collection.
| Parameter | Description | Required? |
| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| `index_type` | The type of indexing method to query the collection. Please refer to [Milvus Indexes](https://www.milvus.io/docs/guides/index.md) for detailed introduction of supported indexes. The default is "FLAT". | No |
| `index_type` | The type of indexing method to query the collection. Please refer to [Milvus Indexes](https://www.milvus.io/docs/index.md) for detailed introduction of supported indexes. The default is "FLAT". | No |
| `metric_type`| The type of metric to query the collection. Please refer to [Milvus Indexes](https://www.milvus.io/docs/index.md) for detailed introduction of supported indexes. | No |
| `params` | The extra params of indexing method to query the collection. Please refer to [Index and search parameters](#Index-and-search-parameters) for detailed introduction of supported indexes. | No |
##### Query Parameters
@ -1563,7 +1564,7 @@ For each index type, the RESTful API has specific index parameters and search pa
</tr>
</table>
For detailed information about the parameters above, refer to [Milvus Indexes](https://milvus.io/docs/guides/index.md)
For detailed information about the parameters above, refer to [Milvus Indexes](https://milvus.io/docs/index.md)
## Error Codes

View File

@ -18,8 +18,3 @@ The following is a list of existing test reports:
- [IVF_SQ8H](test_report/milvus_ivfsq8h_test_report_detailed_version.md)
- [IVFLAT](test_report/ivfflat_test_report_en.md)
To read the CN version of these reports:
- [IVF_SQ8_cn](test_report/milvus_ivfsq8_test_report_detailed_version_cn.md)
- [IVF_SQ8H_cn](test_report/milvus_ivfsq8h_test_report_detailed_version_cn.md)
- [IVFLAT_cn](test_report/ivfflat_test_report_cn.md)

View File

@ -97,7 +97,7 @@ Milvus设置
- gpu_cache_capacity: 6
- use_blas_threshold: 2100
Milvus设置的详细定义可以参考 https://milvus.io/docs/en/reference/milvus_config/
Milvus设置的详细定义可以参考 https://milvus.io/cn/docs/milvus_config.md
测试方法

View File

@ -97,7 +97,7 @@ Milvus configuration
- gpu_cache_capacity: 6
- use_blas_threshold: 2100
The definitions of Milvus configuration are on https://milvus.io/docs/en/reference/milvus_config/.
The definitions of Milvus configuration are on https://milvus.io/docs/milvus_config.md.
Test method

View File

@ -93,7 +93,7 @@ Milvus configuration
- gpu_cache_capacity: 6
- use_blas_threshold: 1100
The definitions of Milvus configuration are on https://milvus.io/docs/en/reference/milvus_config/.
The definitions of Milvus configuration are on https://milvus.io/docs/milvus_config.md.
Test method
@ -203,4 +203,4 @@ search_resources: cpu, gpu0
**Conclusion**
As nq increases, the recall gradually stabilizes to over 93%.
As nq increases, the recall gradually stabilizes to over 93%.

View File

@ -93,7 +93,7 @@ Milvus设置
- gpu_cache_capacity: 6
- use_blas_threshold: 1100
Milvus设置的详细定义可以参考 https://milvus.io/docs/en/reference/milvus_config/
Milvus设置的详细定义可以参考 https://milvus.io/docs/milvus_config.md
测试方法

View File

@ -96,7 +96,7 @@ Milvus configuration
- gpu_search_threshold: 1200
- search_resources: cpu, gpu0, gpu1
The definitions of Milvus configuration are on https://milvus.io/docs/en/reference/milvus_config/.
The definitions of Milvus configuration are on https://milvus.io/docs/milvus_config.md.
Test method
@ -176,4 +176,4 @@ We use the ground_truth in sift1b dataset to calculate the recall of query resul
**Conclusion**
As nq increases, the recall gradually stabilizes to over 93%. The usage of CPU or GPU and different topk are not related to recall.
As nq increases, the recall gradually stabilizes to over 93%. The usage of CPU or GPU and different topk are not related to recall.

View File

@ -96,7 +96,7 @@ Milvus设置
- gpu_search_threshold: 1200
- search_resources: cpu, gpu0, gpu1
Milvus设置的详细定义可以参考 https://milvus.io/docs/en/reference/milvus_config/
Milvus设置的详细定义可以参考 https://milvus.io/docs/milvus_config.md
测试方法

View File

@ -20,7 +20,7 @@ You must build the C++ SDK before using it:
### Try C++ example
You must have a running Milvus server to try the C++ example. Refer to [Milvus Documentation](https://milvus.io/docs/guides/get_started/install_milvus/install_milvus.md) to learn how to install and run a Milvus server.
You must have a running Milvus server to try the C++ example. Refer to [Milvus Documentation](https://milvus.io/docs/install_milvus.md) to learn how to install and run a Milvus server.
Run C++ example:

View File

@ -26,13 +26,13 @@ Below graph is a demonstration of the process:
Below examples codes demonstrate how to build from source code a Milvus server with Mishards on a standalone machine, as well as how to use Kubernetes to establish Milvus cluster with Mishards.
Before executing these examples, make sure you meet the prerequisites of [Milvus installation](https://milvus.io/docs/guides/get_started/install_milvus/install_milvus.md).
Before executing these examples, make sure you meet the prerequisites of [Milvus installation](https://milvus.io/docs/install_milvus.md).
### Build from source code
#### Prequisites
#### Prerequisites
Make sure Python 3.6 or higher is installed.
Ensure that Python 3.6 or higher is installed.
#### Start Milvus and Mishards from source code

View File

@ -20,7 +20,7 @@ Mishards 负责将上游请求拆分,并路由到内部各细分子服务,
以下分别向您展示如何使用源代码在单机上启动 Mishards 和 Milvus 服务,以及如何使用 Kubernetes 启动 Milvus 集群和 Mishards。
Milvus 启动的前提条件请参考 [Milvus 安装](https://milvus.io/cn/docs/guides/get_started/install_milvus/install_milvus.md)。
Milvus 启动的前提条件请参考 [Milvus 安装](https://milvus.io/cn/docs/install_milvus.md)。
### 源代码启动示例