Skip to content

Commit 0e00531

Browse files
Milvus-doc-botMilvus-doc-bot
Milvus-doc-bot
authored and
Milvus-doc-bot
committed
Release new docs
1 parent 2feb112 commit 0e00531

File tree

113 files changed

+8397
-3
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

113 files changed

+8397
-3
lines changed

v0.9.1/CHANGELOG.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
id: Changelog
3+
title: Changelog
4+
sidebar_label: Milvus Changelog
5+
---
6+
7+
# Milvus Docs Changelog
8+
9+
## [v0.6.0] 2019-12-07
10+
11+
### Improvements
12+
- \#169, #177, #183 and #184 Update Product FAQ and Operational FAQ topics.
13+
- \#174 Update Install Milvus and Milvus Configuration topics.
14+
Add Index Types, Table Partition, Data Management and Contribute topics.
15+
Update server_config.yaml.
16+
- \#192 Add release note for v0.6.0.
17+
18+
## [v0.5.3] 2019-11-14
19+
20+
### Improvements
21+
- \#155 Add the `nprobe` argument which is missing in search result filter command in Learn Milvus Operations topic.
22+
- \#157 Add release note for v0.5.3.
23+
24+
## [v0.5.1] 2019-11-04
25+
26+
### Improvements
27+
- \#129 Update some parameter descriptions in the `server_config.yaml` file for Milvus configuration.
28+
- \#132 a) Add a new parameter `gpu_search_threshold` in Milvus Configuration; b) Update Troubleshoot.
29+
- \#136 Add release note for v0.5.1.
30+
31+
32+
33+
## [v0.5.0] 2019-10-15
34+
35+
### Improvements
36+
- \#77 Add a new index type `NSG`; Update some parameter names in Milvus configuration file.
37+
- \#78 Add a new parameter `preload_table` in Milvus config file.
38+
- \#79 Add Java SDK doc.
39+
- \#83 Add table row count SDK.
40+
- \#85 Add a description about "why search results are fewer than K in top K search" in Operational FAQ.
41+
- \#87 Add a new index type `IVF_SQ8H` in Learn Milvus Operations.
42+
- \#90 Add parameter `gpu_cache_capacity` and `gpu_cache_threshold` in Milvus config file.
43+
- \#93 Update README and create CONTRIBUTING.md.
44+
- \#100 Update Milvus config file to remove doc about GPU-only search
45+
- \#107 Remove "Delete vectors by range" in Milvus operations
46+

v0.9.1/CONTRIBUTING.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing to Milvus Documentation
2+
3+
Thank you for your interest in contributing to Milvus documentation! :tada:
4+
5+
If there's anything you'd like to change in the docs, you can click the **Edit** button located on the upper right of most pages in the [website](https://www.milvus.io/docs/guides/get_started/install_milvus/install_milvus.md), and then [file an issue](https://github.com/milvus-io/docs/issues/new/choose) in the Milvus docs repository.
6+
7+
### Contributing to the Blog
8+
9+
The articles in Milvus Blog are generated from [this markdown sources](https://github.com/milvus-io/community/tree/master/blog).
10+
11+
If you want to write an article intended for the Blog, please [open an issue in the community repository](https://github.com/milvus-io/community/issues/new). In most cases, you might want to share your article on your own blog or other writing medium instead. It's worth asking, though, in case we find your article is a good fit for the Blog.
12+
13+
### Contributing to SDK reference
14+
15+
To make a change to SDK reference documentation, find the [source repository for Python SDK](https://github.com/milvus-io/pymilvus) / [source repository for Java SDK](https://github.com/milvus-io/milvus-sdk-java), and create an issue describing the update or your suggestion.
16+
17+
### About our docs
18+
19+
The Milvus documentation is written in [Markdown](https://commonmark.org/help/).
20+
21+
Not all technical content on milvus.io is located in this repo. Some projects have their own repositories and project-specific documentation.
22+
23+
The SDK reference is generated from the source code located in [pymilvus](https://github.com/milvus-io/pymilvus) and [milvus-sdk-java](https://github.com/milvus-io/milvus-sdk-java) repositories.

v0.9.1/LICENSE

+190
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
Copyright 2019 ZILLIZ
179+
180+
Licensed under the Apache License, Version 2.0 (the "License");
181+
you may not use this file except in compliance with the License.
182+
You may obtain a copy of the License at
183+
184+
http://www.apache.org/licenses/LICENSE-2.0
185+
186+
Unless required by applicable law or agreed to in writing, software
187+
distributed under the License is distributed on an "AS IS" BASIS,
188+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189+
See the License for the specific language governing permissions and
190+
limitations under the License.

v0.9.1/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Milvus Documentation
2+
3+
This repository contains the Milvus documentation for [milvus.io](https://www.milvus.io/) (Milvus official website).
4+
5+
To contribute, read the [contributing guide](CONTRIBUTING.md).
6+
7+
To file an issue, you can use the tracker in [this repository](https://github.com/milvus-io/docs/issues/new/choose) or in the [milvus-io/milvus](https://github.com/milvus-io/milvus/issues/new?assignees=&labels=&template=documentation-request.md&title=[DOC]) repo.
8+
9+
To send a pull request, please fork this repository first.
10+
11+
### Writing style
12+
13+
The Milvus documentation is written in [Markdown](https://commonmark.org/help/), and generally follow [Google Developer Documentation Style Guide](https://developers.google.com/style/).
14+
15+
### License
16+
17+
[Apache License 2.0](LICENSE)
18+

v0.9.1/assets/ads_recommend.png

47.9 KB
Loading

v0.9.1/assets/ads_recommend_cn.png

34.5 KB
Loading

v0.9.1/assets/application_arch.png

56.3 KB
Loading

v0.9.1/assets/application_arch_cn.png

50.3 KB
Loading

v0.9.1/assets/euclidean_metric.png

3.96 KB
Loading

v0.9.1/assets/image_retrieval.png

1.47 MB
Loading

v0.9.1/assets/ip_metric.png

1.67 KB
Loading

v0.9.1/assets/jaccard_coeff.png

2.81 KB
Loading

v0.9.1/assets/jaccard_dist.png

3.65 KB
Loading

v0.9.1/assets/jaegertraces.png

276 KB
Loading

v0.9.1/assets/jaegerui.png

122 KB
Loading

v0.9.1/assets/k8s_arch.png

167 KB
Loading

v0.9.1/assets/milvus_arch.png

145 KB
Loading

v0.9.1/assets/milvus_logo.png

60.1 KB
Loading

v0.9.1/assets/mishards.png

78.9 KB
Loading
+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
groups:
2+
3+
- name: alert_rules
4+
rules:
5+
# Alert for server down
6+
- alert: MilvusServerDown
7+
expr: up{job="milvus_server"}
8+
for: 1s
9+
labels:
10+
severity: page
11+
12+
# Alert on CPU temperature too high
13+
- alert: CPUTemperatureTooHigh
14+
expr: CPU_temperature{job="milvus_server"}>=80
15+
for: 1s
16+
labels:
17+
severity: page
18+
19+
# Alert on GPU temperature too high
20+
- alert: GPUTemperatureTooHigh
21+
expr: GPU_temperature{job="milvus_server"}>=80
22+
for: 1s
23+
labels:
24+
severity: page
25+

0 commit comments

Comments
 (0)