Skip to content

Commit

Permalink
Update mishards configure files (#1938)
Browse files Browse the repository at this point in the history 
* Update web readme

Signed-off-by: Yhz <[email protected]>

* [skip ci] update configure files

Signed-off-by: Yhz <[email protected]>

* [skip ci] rename table to collection

Signed-off-by: Yhz <[email protected]>
  • Loading branch information
@BossZou
BossZou authored Apr 15, 2020
1 parent 4644007 commit 423098d
Show file tree
Hide file tree
Showing 11 changed files with 65 additions and 31 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Please mark all change in change log and use the issue from GitHub

# Milvus 0.8.0 (2020-04-14)
# Milvus 0.8.0 (2020-04-15)

## Bug
- \#1276 SQLite throw exception after create 50000+ partitions in a table
Expand Down Expand Up @@ -34,7 +34,7 @@ Please mark all change in change log and use the issue from GitHub
- \#1886 Refactor log on search and insert request
- \#1897 Heap pop and push can be realized by heap_swap_top
- \#1928 Fix too many data and uid copies when loading files
- \#1930 Upgrade mishards to 0.8.0
- \#1930 Upgrade mishards to v0.8.0

## Task

Expand Down
26 changes: 20 additions & 6 deletions core/src/server/web_impl/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -422,12 +422,21 @@ Creates a collection.

##### Body Parameters

| Parameter | Description | Required? |
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| `collection_name` | The name of the collection to create, which must be unique within its database. | Yes |
| `dimension` | The dimension of the vectors that are to be inserted into the created collection. | Yes |
| `index_file_size` | Threshold value that triggers index building for raw data files. The default is 1024. | No |
| `metric_type` | The method vector distances are compared in Milvus. The default is L2. Currently supported metrics include `L2` (Euclidean distance), `IP` (Inner Product), `HAMMING` (Hamming distance), `JACCARD` (Jaccard distance), and `TANIMOTO` (Tanomoto distance). | No |
| Parameter | Description | Required? |
| ----------------- | ----------------------------------------------------------------------------------------- | --------- |
| `collection_name` | The name of the collection to create, which must be unique within its database. | Yes |
| `dimension` | The dimension of the vectors that are to be inserted into the created collection. | Yes |
| `index_file_size` | Threshold value that triggers index building for raw data files. The default is 1024. | No |
| `metric_type` | The method vector distances are compared in Milvus. The default is L2. | No |

* Currently supported metrics include:
- `L2` (Euclidean distance),
- `IP` (Inner Product)
- `HAMMING` (Hamming distance)
- `JACCARD` (Jaccard distance)
- `TANIMOTO` (Tanomoto distance)
- `SUBSTRUCTURE` (Sub structure distance)
- `SUPERSTRUCTURE` (Super structure distance)

#### Response

Expand Down Expand Up @@ -1541,6 +1550,11 @@ For each index type, the RESTful API has specific index parameters and search pa
<td><pre><code>{"M": $int, "efConstruction": $int}</code></pre></td>
<td><pre><code>{"ef": $int}</code></pre></td>
</tr>
<tr>
<td> ANNOY</td>
<td><pre><code>{"n_trees": $int}</code></pre></td>
<td><pre><code>{"search_k": $int}</code></pre></td>
</tr>
</table>
For detailed information about the parameters above, refer to [Milvus Indexes](https://milvus.io/docs/guides/index.md)
Expand Down
2 changes: 1 addition & 1 deletion shards/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Follow below steps to start a standalone Milvus instance with Mishards from sour
3. Start Milvus server.

```shell
$ sudo nvidia-docker run --rm -d -p 19530:19530 -v /tmp/milvus/db:/opt/milvus/db milvusdb/milvus:0.6.0-gpu-d120719-2b40dd
$ sudo nvidia-docker run --rm -d -p 19530:19530 -v /tmp/milvus/db:/opt/milvus/db milvusdb/milvus:0.8.0-gpu-d041520-464400
```

4. Update path permissions.
Expand Down
2 changes: 1 addition & 1 deletion shards/README_CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Python 版本为3.6及以上。
3. 启动 Milvus 服务。

```shell
$ sudo nvidia-docker run --rm -d -p 19530:19530 -v /tmp/milvus/db:/opt/milvus/db milvusdb/milvus:0.6.0-gpu-d120719-2b40dd
$ sudo nvidia-docker run --rm -d -p 19530:19530 -v /tmp/milvus/db:/opt/milvus/db milvusdb/milvus:0.8.0-gpu-d041520-464400
```

4. 更改目录权限。
Expand Down
4 changes: 2 additions & 2 deletions shards/all_in_one/all_in_one.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ services:
milvus_wr:
runtime: nvidia
restart: always
image: milvusdb/milvus:0.7.1-gpu-d032920-3cdba5
image: milvusdb/milvus:0.8.0-gpu-d041520-464400
ports:
- "0.0.0.0:19540:19530"
volumes:
Expand All @@ -13,7 +13,7 @@ services:
milvus_ro:
runtime: nvidia
restart: always
image: milvusdb/milvus:0.7.1-gpu-d032920-3cdba5
image: milvusdb/milvus:0.8.0-gpu-d041520-464400
ports:
- "0.0.0.0:19541:19530"
volumes:
Expand Down
13 changes: 9 additions & 4 deletions shards/all_in_one/ro_server.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
# is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
# or implied. See the License for the specific language governing permissions and limitations under the License.

version: 0.2
version: 0.3

#----------------------+------------------------------------------------------------+------------+-----------------+
# Server Config | Description | Type | Default |
Expand Down Expand Up @@ -42,14 +42,19 @@ server_config:
# | Keep 'dialect://:@:/', 'dialect' can be either 'sqlite' or | | |
# | 'mysql', replace other texts with real values. | | |
#----------------------+------------------------------------------------------------+------------+-----------------+
# preload_table | A comma-separated list of table names that need to be pre- | StringList | |
# | loaded when Milvus server starts up. | | |
# preload_collection | A comma-separated list of collection names that need to | StringList | |
# | be pre-loaded when Milvus server starts up. | | |
# | '*' means preload all existing tables (single-quote or | | |
# | double-quote required). | | |
#----------------------+------------------------------------------------------------+------------+-----------------+
# auto_flush_interval | The interval, in seconds, at which Milvus automatically | Integer | 1 (s) |
# | flushes data to disk. | | |
# | 0 means disable the regular flush. | | |
#----------------------+------------------------------------------------------------+------------+-----------------+
db_config:
backend_url: sqlite://:@:/
preload_table:
preload_collection:
auto_flush_interval: 1

#----------------------+------------------------------------------------------------+------------+-----------------+
# Storage Config | Description | Type | Default |
Expand Down
13 changes: 9 additions & 4 deletions shards/all_in_one/wr_server.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
# is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
# or implied. See the License for the specific language governing permissions and limitations under the License.

version: 0.2
version: 0.3

#----------------------+------------------------------------------------------------+------------+-----------------+
# Server Config | Description | Type | Default |
Expand Down Expand Up @@ -42,14 +42,19 @@ server_config:
# | Keep 'dialect://:@:/', 'dialect' can be either 'sqlite' or | | |
# | 'mysql', replace other texts with real values. | | |
#----------------------+------------------------------------------------------------+------------+-----------------+
# preload_table | A comma-separated list of table names that need to be pre- | StringList | |
# | loaded when Milvus server starts up. | | |
# preload_collection | A comma-separated list of collection names that need to | StringList | |
# | be pre-loaded when Milvus server starts up. | | |
# | '*' means preload all existing tables (single-quote or | | |
# | double-quote required). | | |
#----------------------+------------------------------------------------------------+------------+-----------------+
# auto_flush_interval | The interval, in seconds, at which Milvus automatically | Integer | 1 (s) |
# | flushes data to disk. | | |
# | 0 means disable the regular flush. | | |
#----------------------+------------------------------------------------------------+------------+-----------------+
db_config:
backend_url: sqlite://:@:/
preload_table:
preload_collection:
auto_flush_interval: 1

#----------------------+------------------------------------------------------------+------------+-----------------+
# Storage Config | Description | Type | Default |
Expand Down
4 changes: 2 additions & 2 deletions shards/all_in_one_with_mysql/all_in_one.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ services:
milvus_wr:
runtime: nvidia
restart: always
image: milvusdb/milvus:0.7.1-gpu-d032920-3cdba5
image: milvusdb/milvus:0.8.0-gpu-d041520-464400
volumes:
- /tmp/milvus/db:/var/lib/milvus/db
- ./wr_server.yml:/var/lib/milvus/conf/server_config.yaml
Expand All @@ -29,7 +29,7 @@ services:
milvus_ro:
runtime: nvidia
restart: always
image: milvusdb/milvus:0.7.1-gpu-d032920-3cdba5
image: milvusdb/milvus:0.8.0-gpu-d041520-464400
volumes:
- /tmp/milvus/db:/var/lib/milvus/db
- ./ro_server.yml:/var/lib/milvus/conf/server_config.yaml
Expand Down
13 changes: 9 additions & 4 deletions shards/all_in_one_with_mysql/ro_server.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
# is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
# or implied. See the License for the specific language governing permissions and limitations under the License.

version: 0.2
version: 0.3

#----------------------+------------------------------------------------------------+------------+-----------------+
# Server Config | Description | Type | Default |
Expand Down Expand Up @@ -42,14 +42,19 @@ server_config:
# | Keep 'dialect://:@:/', 'dialect' can be either 'sqlite' or | | |
# | 'mysql', replace other texts with real values. | | |
#----------------------+------------------------------------------------------------+------------+-----------------+
# preload_table | A comma-separated list of table names that need to be pre- | StringList | |
# | loaded when Milvus server starts up. | | |
# preload_collection | A comma-separated list of collection names that need to | StringList | |
# | be pre-loaded when Milvus server starts up. | | |
# | '*' means preload all existing tables (single-quote or | | |
# | double-quote required). | | |
#----------------------+------------------------------------------------------------+------------+-----------------+
# auto_flush_interval | The interval, in seconds, at which Milvus automatically | Integer | 1 (s) |
# | flushes data to disk. | | |
# | 0 means disable the regular flush. | | |
#----------------------+------------------------------------------------------------+------------+-----------------+
db_config:
backend_url: mysql://root:milvusroot@milvus-mysql:3306/milvus
preload_table:
preload_collection:
auto_flush_interval: 1

#----------------------+------------------------------------------------------------+------------+-----------------+
# Storage Config | Description | Type | Default |
Expand Down
13 changes: 9 additions & 4 deletions shards/all_in_one_with_mysql/wr_server.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
# is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
# or implied. See the License for the specific language governing permissions and limitations under the License.

version: 0.2
version: 0.3

#----------------------+------------------------------------------------------------+------------+-----------------+
# Server Config | Description | Type | Default |
Expand Down Expand Up @@ -42,14 +42,19 @@ server_config:
# | Keep 'dialect://:@:/', 'dialect' can be either 'sqlite' or | | |
# | 'mysql', replace other texts with real values. | | |
#----------------------+------------------------------------------------------------+------------+-----------------+
# preload_table | A comma-separated list of table names that need to be pre- | StringList | |
# | loaded when Milvus server starts up. | | |
# preload_collection | A comma-separated list of collection names that need to | StringList | |
# | be pre-loaded when Milvus server starts up. | | |
# | '*' means preload all existing tables (single-quote or | | |
# | double-quote required). | | |
#----------------------+------------------------------------------------------------+------------+-----------------+
# auto_flush_interval | The interval, in seconds, at which Milvus automatically | Integer | 1 (s) |
# | flushes data to disk. | | |
# | 0 means disable the regular flush. | | |
#----------------------+------------------------------------------------------------+------------+-----------------+
db_config:
backend_url: mysql://root:milvusroot@milvus-mysql:3306/milvus
preload_table:
preload_collection:
auto_flush_interval: 1

#----------------------+------------------------------------------------------------+------------+-----------------+
# Storage Config | Description | Type | Default |
Expand Down
2 changes: 1 addition & 1 deletion shards/requirements.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ py==1.8.0
pyasn1==0.4.7
pyasn1-modules==0.2.6
pylint==2.3.1
pymilvus==0.2.9
pymilvus==0.2.10
#pymilvus-test==0.3.3
pyparsing==2.4.0
pytest==4.6.3
Expand Down

0 comments on commit 423098d

Please sign in to comment.