From 7d07e51072a056ed68e91984df68c396f4fee87c Mon Sep 17 00:00:00 2001 From: jielinxu <52057195+jielinxu@users.noreply.github.com> Date: Thu, 31 Oct 2019 14:19:58 +0800 Subject: [PATCH 01/11] [skip ci] Correct a link issue Former-commit-id: da7d00fb1e64047c699bf35d6fa10e6e552a4265 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 884ddb01ca..4faab3c111 100644 --- a/README.md +++ b/README.md @@ -146,7 +146,7 @@ Install Milvus Python SDK. $ pip install pymilvus==0.2.3 ``` -Create a new file `example.py`, and add [Python example code](https://github.com/milvus-io/pymilvus/blob/master/examples/AdvancedExample.py) to it. +Create a new file `example.py`, and add [Python example code](https://github.com/milvus-io/pymilvus/blob/master/examples/advancedexample.py) to it. Run the example code. From eec29282b434a88af3aabcb3348ccd69db51e0d7 Mon Sep 17 00:00:00 2001 From: jielinxu <52057195+jielinxu@users.noreply.github.com> Date: Thu, 31 Oct 2019 14:21:38 +0800 Subject: [PATCH 02/11] [skip ci] Update Python example code link Former-commit-id: 369a101beda4041a537b7cdb391f60f1ef237d7a --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4faab3c111..31cc2f684f 100644 --- a/README.md +++ b/README.md @@ -146,7 +146,7 @@ Install Milvus Python SDK. $ pip install pymilvus==0.2.3 ``` -Create a new file `example.py`, and add [Python example code](https://github.com/milvus-io/pymilvus/blob/master/examples/advancedexample.py) to it. +Create a new file `example.py`, and add [Python example code](https://github.com/milvus-io/pymilvus/blob/master/examples/advanced_example.py) to it. Run the example code. From 23996fc0ebcb289c131c9d80a6f9e3ab65182cb5 Mon Sep 17 00:00:00 2001 From: jielinxu <52057195+jielinxu@users.noreply.github.com> Date: Thu, 31 Oct 2019 14:37:41 +0800 Subject: [PATCH 03/11] [skip ci] Correct EASYLOGGINGPP link Former-commit-id: 100df31ff199591596e6909ab43cd3edfcf22bc2 --- NOTICE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/NOTICE.md b/NOTICE.md index 40ea77d3b7..018e2b80e0 100644 --- a/NOTICE.md +++ b/NOTICE.md @@ -25,6 +25,6 @@ | libunwind | [MIT](https://github.com/libunwind/libunwind/blob/master/LICENSE) | | gperftools | [BSD 3-Clause](https://github.com/gperftools/gperftools/blob/master/COPYING) | | grpc | [Apache 2.0](https://github.com/grpc/grpc/blob/master/LICENSE) | -| EASYLOGGINGPP | [MIT](https://github.com/zuhd-org/easyloggingpp/blob/master/LICENSEhttps://github.com/zuhd-org/easyloggingpp/blob/master/LICENSE) | +| EASYLOGGINGPP | [MIT](https://github.com/zuhd-org/easyloggingpp/blob/master/LICENSE) | | Json | [MIT](https://github.com/nlohmann/json/blob/develop/LICENSE.MIT) | From c219fe0c1faaf5c75c3d4c54a2ba9ddc5c3c8651 Mon Sep 17 00:00:00 2001 From: jielinxu <52057195+jielinxu@users.noreply.github.com> Date: Thu, 31 Oct 2019 15:02:19 +0800 Subject: [PATCH 04/11] [skip ci] Update Contributing code Former-commit-id: a96d53012ffe755b1b3ef5cc7ac55ceec96e2df5 --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 475387c319..1ff37372db 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,7 +28,7 @@ Contributions to Milvus fall into the following categories. If you have improvements to Milvus, send us your pull requests! For those just getting started, see [GitHub workflow](#github-workflow). -The Milvus team members will review your pull requests, and once it is accepted, it will be given a `ready to merge` label. This means we are working on submitting your pull request to the internal repository. After the change has been submitted internally, your pull request will be merged automatically on GitHub. +The Milvus team members will review your pull requests, and once it is accepted, the status of the projects to which it is associated will be changed to **Reviewer approved**. This means we are working on submitting your pull request to the internal repository. After the change has been submitted internally, your pull request will be merged automatically on GitHub. ### GitHub workflow From be63ba0c8e9a6b6003487e94f874044433998b05 Mon Sep 17 00:00:00 2001 From: jielinxu <52057195+jielinxu@users.noreply.github.com> Date: Fri, 1 Nov 2019 14:55:49 +0800 Subject: [PATCH 05/11] [skip ci] Simplified README with reference links Former-commit-id: be550f395896049d290fa47cec12e0a00031078c --- README.md | 59 ++++--------------------------------------------------- 1 file changed, 4 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index 31cc2f684f..74743c4e8b 100644 --- a/README.md +++ b/README.md @@ -22,45 +22,9 @@ Milvus is an open source 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. -Milvus provides stable Python, Java and C++ APIs. +Milvus provides stable Python, Java and C++ APIs. For more detailed introduction of Milvus and its architecture, see [Milvus overview](https://www.milvus.io/docs/en/aboutmilvus/overview/). -Keep up-to-date with newest releases and latest updates by reading Milvus [release notes](https://milvus.io/docs/en/release/v0.5.0/). - -- Heterogeneous computing - - Milvus is built with heterogeneous computing architecture for the best performance and cost efficiency. - -- Multiple indexes - - Milvus supports a variety of indexing types that employs quantization, tree-based, and graph indexing techniques. - -- Intelligent resource management - - Milvus automatically adapts search computation and index building processes based on your datasets and available resources. - -- Horizontal scalability - - Milvus supports online / offline expansion to scale both storage and computation resources with simple commands. - -- High availability - - Milvus is integrated with Kubernetes framework so that all single point of failures could be avoided. - -- High compatibility - - Milvus is compatible with almost all deep learning models and major programming languages such as Python, Java and C++, etc. - -- Ease of use - - Milvus can be easily installed in a few steps and enables you to exclusively focus on feature vectors. - -- Visualized monitor - - You can track system performance on Prometheus-based GUI monitor dashboards. - -## Architecture - -![Milvus_arch](https://github.com/milvus-io/docs/blob/master/assets/milvus_arch.png) +Keep up-to-date with newest releases and latest updates by reading Milvus [release notes](https://www.milvus.io/docs/en/release/v0.5.0/). ## Get started @@ -137,23 +101,7 @@ To edit Milvus settings in `conf/server_config.yaml` and `conf/log_config.conf`, #### Run Python example code -Make sure [Python 3.5](https://www.python.org/downloads/) or higher is already installed and in use. - -Install Milvus Python SDK. - -```shell -# Install Milvus Python SDK -$ pip install pymilvus==0.2.3 -``` - -Create a new file `example.py`, and add [Python example code](https://github.com/milvus-io/pymilvus/blob/master/examples/advanced_example.py) to it. - -Run the example code. - -```shell -# Run Milvus Python example -$ python3 example.py -``` +Please read [this page](https://www.milvus.io/docs/en/userguide/example_code/) for how to run an example program using Python SDK. #### Run C++ example code @@ -164,6 +112,7 @@ $ python3 example.py ``` #### Run Java example code + Make sure Java 8 or higher is already installed. Refer to [this link](https://github.com/milvus-io/milvus-sdk-java/tree/master/examples) for the example code. From 5b5c42d1861192c99b8fbedabe93992461f4b2ab Mon Sep 17 00:00:00 2001 From: jielinxu <52057195+jielinxu@users.noreply.github.com> Date: Fri, 1 Nov 2019 15:11:46 +0800 Subject: [PATCH 06/11] [skip ci] Minor change Former-commit-id: 166ff3b7e998da253a2cfc1aaab8909bad262aac --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 74743c4e8b..debd8e2a2a 100644 --- a/README.md +++ b/README.md @@ -16,13 +16,13 @@ - [中文官网](https://www.milvus.io/zh-CN/) -# Welcome to Milvus - ## What is Milvus Milvus is an open source 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. -Milvus provides stable Python, Java and C++ APIs. For more detailed introduction of Milvus and its architecture, see [Milvus overview](https://www.milvus.io/docs/en/aboutmilvus/overview/). +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://milvus-io.github.io/milvus-sdk-java/javadoc/io/milvus/client/package-summary.html) and C++ 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.0/). @@ -39,7 +39,7 @@ Keep up-to-date with newest releases and latest updates by reading Milvus [relea ### Install using docker -Use Docker to install Milvus is a breeze. See the [Milvus install guide](https://milvus.io/docs/en/userguide/install_milvus/) for details. +Using Docker to install Milvus is a breeze. See the [Milvus install guide](https://milvus.io/docs/en/userguide/install_milvus/) for details. ### Build from source @@ -103,6 +103,12 @@ To edit Milvus settings in `conf/server_config.yaml` and `conf/log_config.conf`, Please read [this page](https://www.milvus.io/docs/en/userguide/example_code/) for how to run an example program using Python SDK. +#### Run Java example code + +Make sure Java 8 or higher is already installed. + +Refer to [this link](https://github.com/milvus-io/milvus-sdk-java/tree/master/examples) for the example code. + #### Run C++ example code ```shell @@ -111,13 +117,7 @@ Please read [this page](https://www.milvus.io/docs/en/userguide/example_code/) f $ ./sdk_simple ``` -#### Run Java example code - -Make sure Java 8 or higher is already installed. - -Refer to [this link](https://github.com/milvus-io/milvus-sdk-java/tree/master/examples) for the example code. - -## Milvus roadmap +## Roadmap Please read our [roadmap](https://milvus.io/docs/en/roadmap/) to learn about upcoming features. @@ -127,7 +127,7 @@ Contributions are welcomed and greatly appreciated. Please read our [contributio We use [GitHub issues](https://github.com/milvus-io/milvus/issues/new/choose) to track issues and bugs. For general questions and public discussions, please join our community. -## Join the Milvus 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). From 38c6a48718ce5759ed596532801c3feb43467b36 Mon Sep 17 00:00:00 2001 From: jielinxu <52057195+jielinxu@users.noreply.github.com> Date: Fri, 1 Nov 2019 15:42:04 +0800 Subject: [PATCH 07/11] [skip ci] Create build from source doc Former-commit-id: ab66f08498bc2ed9062e002fc9bbb14db2962108 --- install.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 install.md diff --git a/install.md b/install.md new file mode 100644 index 0000000000..f869520ba3 --- /dev/null +++ b/install.md @@ -0,0 +1,53 @@ +# Install Milvus from Source Code + +## Software requirements + +- Ubuntu 18.04 or higher +- CMake 3.14 or higher +- CUDA 10.0 or higher +- NVIDIA driver 418 or higher + +## Compilation + +### Step 1 Install dependencies + +```shell +$ cd [Milvus sourcecode path]/core +$ ./ubuntu_build_deps.sh +``` + +### Step 2 Build + +```shell +$ cd [Milvus sourcecode path]/core +$ ./build.sh -t Debug +or +$ ./build.sh -t Release +``` + +When the build is completed, all the stuff that you need in order to run Milvus will be installed under `[Milvus root path]/core/milvus`. + +## Launch Milvus server + +```shell +$ cd [Milvus root path]/core/milvus +``` + +Add `lib/` directory to `LD_LIBRARY_PATH` + +``` +$ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/path/to/milvus/lib +``` + +Then start Milvus server: + +``` +$ cd scripts +$ ./start_server.sh +``` + +To stop Milvus server, run: + +```shell +$ ./stop_server.sh +``` From bf63c3c33745a9e41d7e37b5b0f76cd1403fefdc Mon Sep 17 00:00:00 2001 From: jielinxu <52057195+jielinxu@users.noreply.github.com> Date: Fri, 1 Nov 2019 16:09:46 +0800 Subject: [PATCH 08/11] [skip ci] Reorganize the structure Former-commit-id: c5c7b37ded00b8bb6b57a51f39b4c02361555c8a --- README.md | 89 +++++-------------------------------------------------- 1 file changed, 8 insertions(+), 81 deletions(-) diff --git a/README.md b/README.md index debd8e2a2a..3419c2dee2 100644 --- a/README.md +++ b/README.md @@ -22,94 +22,21 @@ Milvus is an open source similarity search engine for massive-scale feature vect 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://milvus-io.github.io/milvus-sdk-java/javadoc/io/milvus/client/package-summary.html) and C++ APIs. +Milvus provides stable [Python](https://pypi.org/project/pymilvus/), [Java](https://milvus-io.github.io/milvus-sdk-java/javadoc/io/milvus/client/package-summary.html) and C++ 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.0/). ## Get started -### Hardware requirements +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). -| Component | Recommended configuration | -| --------- | ----------------------------------- | -| CPU | Intel CPU Haswell or higher | -| GPU | NVIDIA Pascal series or higher | -| RAM | 8 GB or more (depends on data size) | -| Hard drive| SATA 3.0 SSD or higher | - -### Install using docker - -Using Docker to install Milvus is a breeze. See the [Milvus install guide](https://milvus.io/docs/en/userguide/install_milvus/) for details. - -### Build from source - -#### Software requirements - -- Ubuntu 18.04 or higher -- CMake 3.14 or higher -- CUDA 10.0 or higher -- NVIDIA driver 418 or higher - -#### Compilation - -##### Step 1 Install dependencies - -```shell -$ cd [Milvus sourcecode path]/core -$ ./ubuntu_build_deps.sh -``` - -##### Step 2 Build - -```shell -$ cd [Milvus sourcecode path]/core -$ ./build.sh -t Debug -or -$ ./build.sh -t Release -``` - -When the build is completed, all the stuff that you need in order to run Milvus will be installed under `[Milvus root path]/core/milvus`. - -#### Launch Milvus server - -```shell -$ cd [Milvus root path]/core/milvus -``` - -Add `lib/` directory to `LD_LIBRARY_PATH` - -``` -$ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/path/to/milvus/lib -``` - -Then start Milvus server: - -``` -$ cd scripts -$ ./start_server.sh -``` - -To stop Milvus server, run: - -```shell -$ ./stop_server.sh -``` - -To edit Milvus settings in `conf/server_config.yaml` and `conf/log_config.conf`, please read [Milvus Configuration](https://github.com/milvus-io/docs/blob/master/reference/milvus_config.md). +To edit Milvus settings, read [Milvus configuration](https://www.milvus.io/docs/en/reference/milvus_config/). ### Try your first Milvus program -#### Run Python example code +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). -Please read [this page](https://www.milvus.io/docs/en/userguide/example_code/) for how to run an example program using Python SDK. - -#### Run Java example code - -Make sure Java 8 or higher is already installed. - -Refer to [this link](https://github.com/milvus-io/milvus-sdk-java/tree/master/examples) for the example code. - -#### Run C++ example code +To use C++ example code, use below command: ```shell # Run Milvus C++ example @@ -119,7 +46,7 @@ Refer to [this link](https://github.com/milvus-io/milvus-sdk-java/tree/master/ex ## Roadmap -Please read our [roadmap](https://milvus.io/docs/en/roadmap/) to learn about upcoming features. +Please read our [roadmap](https://milvus.io/docs/en/roadmap/) for upcoming features. ## Contribution guidelines @@ -147,9 +74,9 @@ We greatly appreciate the help of the following people. [Milvus blog](https://www.milvus.io/blog/) -[Milvus CSDN](https://zilliz.blog.csdn.net/) +[Milvus Medium](https://medium.com/@milvusio) -[Milvus roadmap](https://milvus.io/docs/en/roadmap/) +[Milvus CSDN](https://zilliz.blog.csdn.net/) ## License From 34a72696ec7518ac9b92de573a3e01fdb8b730fa Mon Sep 17 00:00:00 2001 From: jielinxu <52057195+jielinxu@users.noreply.github.com> Date: Fri, 1 Nov 2019 16:14:33 +0800 Subject: [PATCH 09/11] [skip ci] minor change Former-commit-id: 9aebb2b5489c1e9e3ec79c0536449a159d72a196 --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index 3419c2dee2..5340777ac2 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,6 @@ - [Twitter](https://twitter.com/milvusio) - [Facebook](https://www.facebook.com/io.milvus.5) - [Blog](https://www.milvus.io/blog/) -- [CSDN](https://zilliz.blog.csdn.net/) - [中文官网](https://www.milvus.io/zh-CN/) @@ -72,8 +71,6 @@ We greatly appreciate the help of the following people. [Milvus bootcamp](https://github.com/milvus-io/bootcamp) -[Milvus blog](https://www.milvus.io/blog/) - [Milvus Medium](https://medium.com/@milvusio) [Milvus CSDN](https://zilliz.blog.csdn.net/) From 752014541439c9b423311698daa9fafa80d4e557 Mon Sep 17 00:00:00 2001 From: jielinxu <52057195+jielinxu@users.noreply.github.com> Date: Fri, 1 Nov 2019 16:44:34 +0800 Subject: [PATCH 10/11] [skip ci] Update Resources Former-commit-id: 2b135aeb664641e607b84f2403d9dc964b3b85be --- README.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 5340777ac2..45dac99510 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,7 @@ ![Release](https://img.shields.io/badge/release-v0.5.0-orange) ![Release_date](https://img.shields.io/badge/release_date-October-yellowgreen) -- [Slack Community](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk) -- [Twitter](https://twitter.com/milvusio) -- [Facebook](https://www.facebook.com/io.milvus.5) -- [Blog](https://www.milvus.io/blog/) -- [中文官网](https://www.milvus.io/zh-CN/) - +[中文版](README_CN.md) ## What is Milvus @@ -65,15 +60,17 @@ We greatly appreciate the help of the following people. ## Resources -[Milvus official website](https://www.milvus.io) +- [Milvus.io](https://www.milvus.io) -[Milvus docs](https://www.milvus.io/docs/en/userguide/install_milvus/) +- [Milvus bootcamp](https://github.com/milvus-io/bootcamp) -[Milvus bootcamp](https://github.com/milvus-io/bootcamp) +- [Milvus Medium](https://medium.com/@milvusio) -[Milvus Medium](https://medium.com/@milvusio) +- [Milvus CSDN](https://zilliz.blog.csdn.net/) -[Milvus CSDN](https://zilliz.blog.csdn.net/) +- [Milvus Twitter](https://twitter.com/milvusio) + +- [Milvus Facebook](https://www.facebook.com/io.milvus.5) ## License From f2f9ebb98c4e94f640674686b373dc65e8620ca6 Mon Sep 17 00:00:00 2001 From: jielinxu <52057195+jielinxu@users.noreply.github.com> Date: Fri, 1 Nov 2019 16:46:03 +0800 Subject: [PATCH 11/11] [skip ci] Typo change Former-commit-id: 68966d259693535b25458771b3f3c100a1615b2f --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 45dac99510..d5c7651eb6 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ We use [GitHub issues](https://github.com/milvus-io/milvus/issues/new/choose) to ## 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). +To connect with other users and contributors, welcome to join our [Slack channel](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk). ## Thanks