milvus-io
/
milvus
mirror of https://github.com/milvus-io/milvus.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update the README (#9942) 

Signed-off-by: shiyu22 <shiyu.chen@zilliz.com>
pull/9934/head
shiyu22 2021-10-15 15:22:34 +08:00 committed by GitHub
parent b98b779356
commit c28085a381
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
scripts/README.md
View File

@ -3,31 +3,30 @@
## Environment
```
OS: Ubuntu 18.04
go：1.15
cmake: >=3.18
gcc： 7.5
OS: Ubuntu 18.04
go：1.15
cmake: >=3.18
gcc： 7.5
```
## Install dependencies
Install compile dependencies
```shell
sudo apt install -y g++ gcc make libssl-dev zlib1g-dev libboost-regex-dev \
$ sudo apt install -y g++ gcc make libssl-dev zlib1g-dev libboost-regex-dev \
libboost-program-options-dev libboost-system-dev libboost-filesystem-dev \
libboost-serialization-dev python3-dev libboost-python-dev libcurl4-openssl-dev gfortran libtbb-dev
export GO111MODULE=on
go get github.com/golang/protobuf/protoc-gen-go@v1.3.2
$ export GO111MODULE=on
$ go get github.com/golang/protobuf/protoc-gen-go@v1.3.2
```
Install OpenBlas library
```shell
wget https://github.com/xianyi/OpenBLAS/archive/v0.3.9.tar.gz && \
tar zxvf v0.3.9.tar.gz && cd OpenBLAS-0.3.9 && \
make TARGET=CORE2 DYNAMIC_ARCH=1 DYNAMIC_OLDER=1 USE_THREAD=0 USE_OPENMP=0 FC=gfortran CC=gcc COMMON_OPT="-O3 -g -fPIC" FCOMMON_OPT="-O3 -g -fPIC -frecursive" NMAX="NUM_THREADS=128" LIBPREFIX="libopenblas" LAPACKE="NO_LAPACKE=1" INTERFACE64=0 NO_STATIC=1 && \
make PREFIX=/usr install
$ wget https://github.com/xianyi/OpenBLAS/archive/v0.3.9.tar.gz && \
$ tar zxvf v0.3.9.tar.gz && cd OpenBLAS-0.3.9 && \
$ make TARGET=CORE2 DYNAMIC_ARCH=1 DYNAMIC_OLDER=1 USE_THREAD=0 USE_OPENMP=0 FC=gfortran CC=gcc COMMON_OPT="-O3 -g -fPIC" FCOMMON_OPT="-O3 -g -fPIC -frecursive" NMAX="NUM_THREADS=128" LIBPREFIX="libopenblas" LAPACKE="NO_LAPACKE=1" INTERFACE64=0 NO_STATIC=1 && \
$ make PREFIX=/usr install
```
## Compile
@ -35,75 +34,75 @@ Install OpenBlas library
Generate the go files from proto file
```shell
make check-proto-product
$ make check-proto-product
```
Check code specifications
```shell
make verifiers
$ make verifiers
```
Compile milvus
```shell
make all
$ make all
```
## Install docker-compose
refer: https://docs.docker.com/compose/install/
```shell
sudo curl -L "https://github.com/docker/compose/releases/download/1.27.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
docker-compose --version
$ sudo curl -L "https://github.com/docker/compose/releases/download/1.27.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
$ sudo chmod +x /usr/local/bin/docker-compose
$ sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
$ docker-compose --version
```
## Start service
Start third-party service:
```shell
cd [milvus project path]/deployments/docker/cluster
docker-compose up -d
$ cd [milvus project path]/deployments/docker/cluster
$ docker-compose up -d
```
Start milvus cluster:
```shell
cd [milvus project path]/scripts
start_cluster.sh
$ cd [milvus project path]/scripts
$ start_cluster.sh
```
## Run unittest
Run all unittest including go and cpp cases:
```shell
make unittest
$ make unittest
```
You also can run go unittest only:
```shell
make test-go
$ make test-go
```
Run cpp unittest only:
```shell
make test-cpp
$ make test-cpp
```
## Run code coverage
Run code coverage including go and cpp:
```shell
make codecov
$ make codecov
```
You also can run go code coverage only:
```shell
make codecov-go
$ make codecov-go
```
Run cpp code coverage only:
```shell
make codecov-cpp
$ make codecov-cpp
```