From 97539416513d8f5ed27a4178b5b869d9b409b2c5 Mon Sep 17 00:00:00 2001 From: "jielin.xu" Date: Tue, 17 Sep 2019 14:15:42 +0800 Subject: [PATCH 01/11] Add new file Former-commit-id: 718692a49171c7bb36219dbbd0db024427b40904 --- cpp/CONTRIBUTING.md | 52 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 cpp/CONTRIBUTING.md diff --git a/cpp/CONTRIBUTING.md b/cpp/CONTRIBUTING.md new file mode 100644 index 0000000000..7e6398715e --- /dev/null +++ b/cpp/CONTRIBUTING.md @@ -0,0 +1,52 @@ +# Contributing to Milvus + +First of all, thanks for taking the time to contribute to Milvus! It's people like you that help Milvus come to fruition. + +The following are a set of guidelines for contributing to Milvus. Following these guidelines helps contributing to this project easy and transparent. These are mostly guideline, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. + +As for everything else in the project, the contributions to Milvus are governed by our [Code of Conduct](http://hood.ie/code-of-conduct/). + +TOC + +## Contribution Checklist + +Before you make any contributions, make sure you follow this list. + +- Read [contributing to Milvus](CONTRIBUTING.md). +- Check if the changes are consistent with the [Coding Style]. +- Run [Unit Tests]. + +## What contributions can I make? + +Contributions to Milvus fall into the following categories. + +1. To report a bug or a problem with documentation, please file an [issue](https://github.com/rapidsai/cudf/issues/new/choose) providing the details of the problem. If you believe the issue needs priority attention, please comment on the issue to notify the team. +2. To propose a new feature, please file a new feature request [issue](https://github.com/rapidsai/cudf/issues/new/choose). Describe the intended feature and discuss the design and implementation with the team and community. Once the team agrees that the plan looks good, go ahead and implement it, following the [Contributing code]. +3. To implement a feature or bug-fix for an existing outstanding issue, follow the [Contributing code]. If you need more context on a particular issue, comment on the issue to let people know. + +## How can I contribute? + +### Contributor License Agreement (CLA) + +We greatly welcome your contributions. However, before we can accept your pull requests, we will need you to [sign a Contributor License Agreement (CLA)]. + +### Contributing code + +If you have improvements to Milvus, send us your pull requests! For those just getting started, GitHub has a [how-to](https://help.github.com/en/articles/about-pull-requests). + +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. + + + +### General guidelines + +Before sending your pull requests for review, make sure your changes are consistent with the guidelines and follow the Milvus coding style. + +- Include unit tests when you contribute new features, as they help to a) prove that your code works correctly, and b) guard against future breaking changes to lower the maintenance cost. +- Bug fixes also generally require unit tests, because the presence of bugs usually indicates insufficient test coverage. +- Keep API compatibility in mind when you change code in Milvus. Reviewers of your pull request will comment on any API compatibility issues. +- When you contribute a new feature to Milvus, the maintenance burden is (by default) transferred to the Milvus team. This means that the benefit of the contribution must be compared against the cost of maintaining the feature. + + + +## Coding Style \ No newline at end of file From 359a71de5acf90de4089384f88e84b3738ef0124 Mon Sep 17 00:00:00 2001 From: "jielin.xu" Date: Tue, 17 Sep 2019 14:23:31 +0800 Subject: [PATCH 02/11] Update CONTRIBUTING.md Former-commit-id: 17c0b8e8ac44b035ed441c91a661b60e870d56db --- cpp/CONTRIBUTING.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/cpp/CONTRIBUTING.md b/cpp/CONTRIBUTING.md index 7e6398715e..58c41cd313 100644 --- a/cpp/CONTRIBUTING.md +++ b/cpp/CONTRIBUTING.md @@ -13,31 +13,25 @@ TOC Before you make any contributions, make sure you follow this list. - Read [contributing to Milvus](CONTRIBUTING.md). -- Check if the changes are consistent with the [Coding Style]. -- Run [Unit Tests]. +- Check if the changes are consistent with the [Coding Style](CONTRIBUTING.md#coding-style). +- Run [Unit Tests](CONTRIBUTING.md#run-unit-test). ## What contributions can I make? Contributions to Milvus fall into the following categories. -1. To report a bug or a problem with documentation, please file an [issue](https://github.com/rapidsai/cudf/issues/new/choose) providing the details of the problem. If you believe the issue needs priority attention, please comment on the issue to notify the team. -2. To propose a new feature, please file a new feature request [issue](https://github.com/rapidsai/cudf/issues/new/choose). Describe the intended feature and discuss the design and implementation with the team and community. Once the team agrees that the plan looks good, go ahead and implement it, following the [Contributing code]. +1. To report a bug or a problem with documentation, please file an [issue](https://github.com/milvus-io/milvus/issues) providing the details of the problem. If you believe the issue needs priority attention, please comment on the issue to notify the team. +2. To propose a new feature, please file a new feature request [issue](https://github.com/milvus-io/milvus/issues). Describe the intended feature and discuss the design and implementation with the team and community. Once the team agrees that the plan looks good, go ahead and implement it, following the [Contributing code]. 3. To implement a feature or bug-fix for an existing outstanding issue, follow the [Contributing code]. If you need more context on a particular issue, comment on the issue to let people know. ## How can I contribute? -### Contributor License Agreement (CLA) - -We greatly welcome your contributions. However, before we can accept your pull requests, we will need you to [sign a Contributor License Agreement (CLA)]. - ### Contributing code If you have improvements to Milvus, send us your pull requests! For those just getting started, GitHub has a [how-to](https://help.github.com/en/articles/about-pull-requests). 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. - - ### General guidelines Before sending your pull requests for review, make sure your changes are consistent with the guidelines and follow the Milvus coding style. @@ -48,5 +42,14 @@ Before sending your pull requests for review, make sure your changes are consist - When you contribute a new feature to Milvus, the maintenance burden is (by default) transferred to the Milvus team. This means that the benefit of the contribution must be compared against the cost of maintaining the feature. +## Coding Style + +## Run unit test + +```shell +$ ./build.sh -u +or +$ ./build.sh --unittest +``` + -## Coding Style \ No newline at end of file From fa9b470ddf726c998394c29608479bfbc2065004 Mon Sep 17 00:00:00 2001 From: "jielin.xu" Date: Tue, 17 Sep 2019 14:25:31 +0800 Subject: [PATCH 03/11] Update CONTRIBUTING.md Former-commit-id: 91a46fa2630cbcd50cdd35168449d474dcb36337 --- cpp/CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/cpp/CONTRIBUTING.md b/cpp/CONTRIBUTING.md index 58c41cd313..a44a933c85 100644 --- a/cpp/CONTRIBUTING.md +++ b/cpp/CONTRIBUTING.md @@ -12,16 +12,16 @@ TOC Before you make any contributions, make sure you follow this list. -- Read [contributing to Milvus](CONTRIBUTING.md). -- Check if the changes are consistent with the [Coding Style](CONTRIBUTING.md#coding-style). -- Run [Unit Tests](CONTRIBUTING.md#run-unit-test). +- Read [Contributing to Milvus](CONTRIBUTING.md). +- Check if the changes are consistent with the [coding style](CONTRIBUTING.md#coding-style). +- Run [unit tests](CONTRIBUTING.md#run-unit-test). ## What contributions can I make? Contributions to Milvus fall into the following categories. -1. To report a bug or a problem with documentation, please file an [issue](https://github.com/milvus-io/milvus/issues) providing the details of the problem. If you believe the issue needs priority attention, please comment on the issue to notify the team. -2. To propose a new feature, please file a new feature request [issue](https://github.com/milvus-io/milvus/issues). Describe the intended feature and discuss the design and implementation with the team and community. Once the team agrees that the plan looks good, go ahead and implement it, following the [Contributing code]. +1. To report a bug or a problem with documentation, please file an [issue](https://github.com/milvus-io/milvus/issues/new) providing the details of the problem. If you believe the issue needs priority attention, please comment on the issue to notify the team. +2. To propose a new feature, please file a new feature request [issue](https://github.com/milvus-io/milvus/issues/new). Describe the intended feature and discuss the design and implementation with the team and community. Once the team agrees that the plan looks good, go ahead and implement it, following the [Contributing code]. 3. To implement a feature or bug-fix for an existing outstanding issue, follow the [Contributing code]. If you need more context on a particular issue, comment on the issue to let people know. ## How can I contribute? From 7941aa5caf308ae24e4667e78293a3d0cb3dee28 Mon Sep 17 00:00:00 2001 From: "jielin.xu" Date: Tue, 17 Sep 2019 14:29:04 +0800 Subject: [PATCH 04/11] Update README.md Former-commit-id: 7b155725e3407f47c6432ce0d678a1c783b29ed8 --- cpp/README.md | 240 +++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 188 insertions(+), 52 deletions(-) diff --git a/cpp/README.md b/cpp/README.md index 8e09d821e2..d304f58304 100644 --- a/cpp/README.md +++ b/cpp/README.md @@ -1,72 +1,208 @@ -### Compilation -#### Step 1: install necessery tools +# Welcome to Milvus - centos7 : - yum install gfortran qt4 flex bison mysql-devel mysql - - ubuntu16.04 : - sudo apt-get install gfortran qt4-qmake flex bison libmysqlclient-dev mysql-client - - cd scripts && sudo ./requirements.sh +Firstly, welcome, and thanks for your interest in [Milvus](https://milvus.io)! No matter who you are, what you do, we greatly appreciate your contribution to help us reinvent data science with Milvus. -If `libmysqlclient_r.so` does not exist after installing MySQL Development Files, you need to create a symbolic link: +## What is Milvus -``` -sudo ln -s /path/to/libmysqlclient.so /path/to/libmysqlclient_r.so +Milvus is an open source vector search engine that makes incredibly fast querying speed enhancement over current solutions of massive vector processing. Built on optimized indexing algorithm, it is compatible with major AI/ML models. + +Milvus was developed by researchers and engineers in ZILLIZ, a tech startup that intends to reinvent data science, with the purpose of providing enterprises with efficient and scalable similarity search and analysis of feature vectors and unstructured data. + +Milvus provides stable [Python](https://www.tensorflow.org/api_docs/python) and [C++](https://www.tensorflow.org/api_docs/cc) APIs, as well as RESTful API. + +Keep up-to-date with newest releases and latest updates by subscribing to xxx. + +- GPU-accelerated search engine + + Milvus is designed for the largest scale of vector index. CPU/GPU heterogeneous computing architecture allows you to process data at a speed 1000 times faster. + +- Intelligent index + + With a “Decide Your Own Algorithm” approach, you can embed machine learning and advanced algorithms into Milvus without the headache of complex data engineering or migrating data between disparate systems. Milvus is built on optimized indexing algorithm based on quantization indexing, tree-based and graph indexing methods. + +- Strong scalability + + The data is stored and computed on a distributed architecture. This lets you scale data sizes up and down without redesigning the system. + +## Get started + +### Install and start Milvus server + +#### Use Docker + +Use Docker to install Milvus is a breeze. See the [Milvus install guide](doc/master/userguide/install_milvus.md) for details. + +#### Use source code + +##### Compilation + +###### Step 1 Install necessary tools + +```shell +# Install tools +Centos7 : +$ yum install gfortran qt4 flex bison mysql-devel mysql + +Ubuntu16.04 : +$ sudo apt-get install gfortran qt4-qmake flex bison libmysqlclient-dev mysql-client + ``` -#### Step 2: build(output to cmake_build folder) +Verify the existence of `libmysqlclient_r.so`: -cmake_build/src/milvus_server is the server +```shell +# Verify existence +$ locate libmysqlclient_r.so +``` - cd [sourcecode path]/cpp/thirdparty - git clone git@192.168.1.105:megasearch/knowhere.git - cd knowhere - ./build.sh -t Debug - or ./build.sh -t Release +If not, you need to create a symbolic link: - cd [sourcecode path]/cpp - ./build.sh -t Debug - or ./build.sh -t Release +```shell +# Create symbolic link +$ sudo ln -s /path/to/libmysqlclient.so /path/to/libmysqlclient_r.so +``` -If you encounter the following error when building: +###### Step 2 Build + +```shell +TBD +cd [Milvus sourcecode path]/cpp/thirdparty +git clone git@192.168.1.105:megasearch/knowhere.git +cd knowhere +./build.sh -t Debug +or ./build.sh -t Release + +cd [sourcecode path]/cpp +./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]/cpp/milvus`. + +If you encounter the following error message, `protocol https not supported or disabled in libcurl` -1. Install libcurl4-openssl-dev +please reinstall CMake with curl: -2. Install cmake 3.14: - - ``` - ./bootstrap --system-curl - make - sudo make install +1. ```shell + CentOS 7: + $ yum install curl-devel + Ubuntu 16.04: + $ sudo apt-get install libcurl4-openssl-dev ``` -#### To build unittest: +2. Install [CMake 3.14](https://github.com/Kitware/CMake/releases/download/v3.14.6/cmake-3.14.6.tar.gz): - ./build.sh -u - or - ./build.sh --unittest + ```shell + $ ./bootstrap --system-curl + $ make + $ sudo make install + ``` -#### To run code coverage +##### Run unit test - apt-get install lcov - ./build.sh -u -c - -### Launch server -Set config in cpp/conf/server_config.yaml - -Add milvus/lib to LD_LIBRARY_PATH - -``` -export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/path/to/milvus/lib +```shell +$ ./build.sh -u +or +$ ./build.sh --unittest ``` -Then launch server with config: - cd [build output path] - start_server.sh - stop_server.sh +##### Run code coverage -### Launch test_client(only for debug) -If you want to test remote api, you can run sdk example. - [build output path]/sdk/examples/grpcsimple/sdk_simple +```shell +CentOS 7: +$ yum install lcov +Ubuntu 16.04: +$ sudo apt-get install lcov + +$ ./build.sh -u -c +``` + +##### Launch Milvus server + +```shell +$ cd [Milvus root path]/cpp/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](milvus-io/milvus/doc/master/reference/milvus_config.md). + +### Try your first Milvus program + +#### Run Python example code + +Make sure [Python 3.4](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.0 +``` + +Create a new file `example.py`, and add [Python example code](https://github.com/milvus-io/pymilvus/blob/branch-0.3.1/examples/AdvancedExample.py) to it. + +Run the example code. + +```python +# Run Milvus Python example +$ python3 example.py +``` + +#### Run C++ example code + +```shell + # Run Milvus C++ example + $ cd [Milvus root path]/cpp/milvus/bin + $ ./sdk_simple +``` + +## Contribution guidelines + +Contributions are welcomed and greatly appreciated. If you want to contribute to Milvus, please read the [contribution guidelines](CONTRIBUTING.md). This project adheres to the [code of conduct](CODE OF CONDUCT.md) of Milvus. By participating, you are expected to uphold this code. + +We use [GitHub issues] to track issues and bugs. For general questions and discussions, please go to [Milvus Forum]. + +## Join the Milvus community + +For public discussion of Milvus, please join our [discussion group]. + +## Milvus Roadmap + +Please read our [roadmap](milvus-io/milvus/doc/master/roadmap.md) to learn about upcoming features. + +## Resources + +[Milvus official website](https://milvus.io) + +[Milvus docs](https://www.milvus.io/docs/en/QuickStart/) + +[Milvus blog](https://www.milvus.io/blog/) + +[Milvus CSDN](https://mp.csdn.net/mdeditor/100041006#) + +[Milvus roadmap](milvus-io/milvus/doc/master/roadmap.md) + +[Milvus white paper] + +## License + +[Apache 2.0 license](milvus-io/milvus/LICENSE.md) \ No newline at end of file From 17792a37ae5b4db13a00e6e408ed6a4157e98a79 Mon Sep 17 00:00:00 2001 From: "jielin.xu" Date: Tue, 17 Sep 2019 14:31:17 +0800 Subject: [PATCH 05/11] Update README.md Former-commit-id: 625e0ce886fdb20c072e136364b6652517c1bb65 --- cpp/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cpp/README.md b/cpp/README.md index d304f58304..1cdff6bee8 100644 --- a/cpp/README.md +++ b/cpp/README.md @@ -8,9 +8,9 @@ Milvus is an open source vector search engine that makes incredibly fast queryin Milvus was developed by researchers and engineers in ZILLIZ, a tech startup that intends to reinvent data science, with the purpose of providing enterprises with efficient and scalable similarity search and analysis of feature vectors and unstructured data. -Milvus provides stable [Python](https://www.tensorflow.org/api_docs/python) and [C++](https://www.tensorflow.org/api_docs/cc) APIs, as well as RESTful API. +Milvus provides stable Python and C++ APIs, as well as RESTful API. -Keep up-to-date with newest releases and latest updates by subscribing to xxx. +Keep up-to-date with newest releases and latest updates by reading [Releases](milvus-io/doc/master/releases). - GPU-accelerated search engine From 3cea080566b68bbb11d76a2abd36e22cfd3adca0 Mon Sep 17 00:00:00 2001 From: "jielin.xu" Date: Tue, 17 Sep 2019 14:39:43 +0800 Subject: [PATCH 06/11] Add new file Former-commit-id: a07c10c27a7ca33125b7fb3c4634f3dd24317905 --- cpp/CODE OF CONDUCT.md | 48 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 cpp/CODE OF CONDUCT.md diff --git a/cpp/CODE OF CONDUCT.md b/cpp/CODE OF CONDUCT.md new file mode 100644 index 0000000000..ef3cc592c6 --- /dev/null +++ b/cpp/CODE OF CONDUCT.md @@ -0,0 +1,48 @@ +# Milvus Code of Conduct + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +- Using welcoming and inclusive language. +- Being respectful of differing viewpoints and experiences. +- Gracefully accepting constructive criticism. +- Focusing on what is best for the community. +- Showing empathy towards other community members. + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or advances. +- Trolling, insulting/derogatory comments, and personal or political attacks. +- Public or private harassment. +- Publishing others' private information, such as a physical or electronic address, without explicit permission. +- Conduct which could reasonably be considered inappropriate for the forum in which it occurs. + +All Milvus forums and spaces are meant for professional interactions, and any behavior which could reasonably be considered inappropriate in a professional setting is unacceptable. + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies to all content on milvus.io, Milvus’s GitHub organization, or any other official Milvus web presence allowing for community interactions, as well as at all official Milvus events, whether offline or online. + +The Code of Conduct also applies within all project spaces and in public spaces whenever an individual is representing Milvus or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed or de facto representative at an online or offline event. Representation of Milvus may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at support@zilliz.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq + From a5ad6a19ed3b5ba909d7c029da657e8f37df99a9 Mon Sep 17 00:00:00 2001 From: "jielin.xu" Date: Tue, 17 Sep 2019 18:49:58 +0800 Subject: [PATCH 07/11] Update CHANGELOG.md Former-commit-id: df346c406bdecbf100761b5aa3de710ba8325a46 --- cpp/CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/cpp/CHANGELOG.md b/cpp/CHANGELOG.md index de7d8306fd..7106cc2d08 100644 --- a/cpp/CHANGELOG.md +++ b/cpp/CHANGELOG.md @@ -16,6 +16,7 @@ Please mark all change in change log and use the ticket from JIRA. ## Task - MS-554 - Change license to Apache 2.0 +- MS-561 - Add contributing guidelines, code of conduct and Readme docs # Milvus 0.4.0 (2019-09-12) From edd566b046b8ded9ee099a717e8ce5639cea8c7c Mon Sep 17 00:00:00 2001 From: "jielin.xu" Date: Tue, 17 Sep 2019 18:53:43 +0800 Subject: [PATCH 08/11] Update CHANGELOG.md Former-commit-id: d822441834b09e510ed386ee64f436ac6c15e6af --- cpp/CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpp/CHANGELOG.md b/cpp/CHANGELOG.md index 7106cc2d08..3ffbee2ff9 100644 --- a/cpp/CHANGELOG.md +++ b/cpp/CHANGELOG.md @@ -16,7 +16,7 @@ Please mark all change in change log and use the ticket from JIRA. ## Task - MS-554 - Change license to Apache 2.0 -- MS-561 - Add contributing guidelines, code of conduct and Readme docs +- MS-561 - Add contributing guidelines, code of conduct and README docs # Milvus 0.4.0 (2019-09-12) From 0f955f5183025ead8cc37dc54a0791c447689f66 Mon Sep 17 00:00:00 2001 From: "jielin.xu" Date: Tue, 17 Sep 2019 18:56:33 +0800 Subject: [PATCH 09/11] Update README.md Former-commit-id: 9a58a8165f60984fb06ba98f863c571989052dde --- cpp/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/cpp/README.md b/cpp/README.md index 1cdff6bee8..3029317810 100644 --- a/cpp/README.md +++ b/cpp/README.md @@ -84,7 +84,8 @@ If you encounter the following error message, please reinstall CMake with curl: -1. ```shell +1. Install curl development files: + ```shell CentOS 7: $ yum install curl-devel Ubuntu 16.04: From 918f299c6916c1ebbef202a2c6f0339397c72a2c Mon Sep 17 00:00:00 2001 From: "jielin.xu" Date: Tue, 17 Sep 2019 18:57:14 +0800 Subject: [PATCH 10/11] Update README.md Former-commit-id: bf982801e6f7b3b82ff6ae1af98b66a29bf8b55c --- cpp/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/cpp/README.md b/cpp/README.md index 3029317810..aa62a256d9 100644 --- a/cpp/README.md +++ b/cpp/README.md @@ -93,7 +93,6 @@ please reinstall CMake with curl: ``` 2. Install [CMake 3.14](https://github.com/Kitware/CMake/releases/download/v3.14.6/cmake-3.14.6.tar.gz): - ```shell $ ./bootstrap --system-curl $ make From 554c1808d594d6635eaab111c2f306ee9c41acad Mon Sep 17 00:00:00 2001 From: "jielin.xu" Date: Wed, 18 Sep 2019 15:17:04 +0800 Subject: [PATCH 11/11] Update README.md Former-commit-id: 5843202bb1d4083ab1ed802f1aa3cd730a63d1d9 --- cpp/README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/cpp/README.md b/cpp/README.md index aa62a256d9..18c1131f10 100644 --- a/cpp/README.md +++ b/cpp/README.md @@ -10,7 +10,7 @@ Milvus was developed by researchers and engineers in ZILLIZ, a tech startup that Milvus provides stable Python and C++ APIs, as well as RESTful API. -Keep up-to-date with newest releases and latest updates by reading [Releases](milvus-io/doc/master/releases). +Keep up-to-date with newest releases and latest updates by reading [Releases](https://www.milvus-io/docs/master/releases). - GPU-accelerated search engine @@ -24,13 +24,16 @@ Keep up-to-date with newest releases and latest updates by reading [Releases](mi The data is stored and computed on a distributed architecture. This lets you scale data sizes up and down without redesigning the system. +## Architecture +![Milvus_arch](https://www.milvus-io/docs/master/assets/milvus_arch.png) + ## Get started ### Install and start Milvus server #### Use Docker -Use Docker to install Milvus is a breeze. See the [Milvus install guide](doc/master/userguide/install_milvus.md) for details. +Use Docker to install Milvus is a breeze. See the [Milvus install guide](https://www.milvus-io/docs/master/userguide/install_milvus.md) for details. #### Use source code @@ -143,7 +146,7 @@ To stop Milvus server, run: $ ./stop_server.sh ``` -To edit Milvus settings in `conf/server_config.yaml` and `conf/log_config.conf`, please read [Milvus Configuration](milvus-io/milvus/doc/master/reference/milvus_config.md). +To edit Milvus settings in `conf/server_config.yaml` and `conf/log_config.conf`, please read [Milvus Configuration](https://www.milvus-io/docs/master/reference/milvus_config.md). ### Try your first Milvus program @@ -187,7 +190,7 @@ For public discussion of Milvus, please join our [discussion group]. ## Milvus Roadmap -Please read our [roadmap](milvus-io/milvus/doc/master/roadmap.md) to learn about upcoming features. +Please read our [roadmap](milvus-io/milvus/docs/master/roadmap.md) to learn about upcoming features. ## Resources @@ -199,7 +202,7 @@ Please read our [roadmap](milvus-io/milvus/doc/master/roadmap.md) to learn about [Milvus CSDN](https://mp.csdn.net/mdeditor/100041006#) -[Milvus roadmap](milvus-io/milvus/doc/master/roadmap.md) +[Milvus roadmap](https://www.milvus-io/docs/master/roadmap.md) [Milvus white paper]