提交 7941aa5c 编写于 作者: J jielin.xu

Update README.md

Former-commit-id: 7b155725e3407f47c6432ce0d678a1c783b29ed8
上级 fa9b470d
### 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
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
```
sudo ln -s /path/to/libmysqlclient.so /path/to/libmysqlclient_r.so
Verify the existence of `libmysqlclient_r.so`:
```shell
# Verify existence
$ locate libmysqlclient_r.so
```
#### Step 2: build(output to cmake_build folder)
If not, you need to create a symbolic link:
cmake_build/src/milvus_server is the server
```shell
# Create symbolic link
$ sudo ln -s /path/to/libmysqlclient.so /path/to/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
###### Step 2 Build
cd [sourcecode path]/cpp
./build.sh -t Debug
or ./build.sh -t Release
```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
If you encounter the following error when building:
`protocol https not supported or disabled in libcurl`
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`.
1. Install libcurl4-openssl-dev
If you encounter the following error message,
`protocol https not supported or disabled in libcurl`
2. Install cmake 3.14:
please reinstall CMake with curl:
1. ```shell
CentOS 7:
$ yum install curl-devel
Ubuntu 16.04:
$ sudo apt-get install libcurl4-openssl-dev
```
./bootstrap --system-curl
make
sudo make install
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
$ sudo make install
```
#### To build unittest:
##### Run unit test
```shell
$ ./build.sh -u
or
$ ./build.sh --unittest
```
./build.sh -u
or
./build.sh --unittest
##### Run code coverage
#### To run code coverage
```shell
CentOS 7:
$ yum install lcov
Ubuntu 16.04:
$ sudo apt-get install lcov
$ ./build.sh -u -c
```
apt-get install lcov
./build.sh -u -c
##### Launch Milvus server
### Launch server
Set config in cpp/conf/server_config.yaml
```shell
$ cd [Milvus root path]/cpp/milvus
```
Add milvus/lib to LD_LIBRARY_PATH
Add `lib/` directory to `LD_LIBRARY_PATH`
```
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/path/to/milvus/lib
$ 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]
Then launch server with config:
cd [build output path]
start_server.sh
stop_server.sh
## License
### 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
[Apache 2.0 license](milvus-io/milvus/LICENSE.md)
\ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册