Skip to content

Commit

Permalink
Release new docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Milvus-doc-bot authored and Milvus-doc-bot committed Aug 23, 2023
1 parent 543b830 commit 700be8c
Show file tree
Hide file tree
Showing 83 changed files with 2,377 additions and 3,023 deletions.
21 changes: 11 additions & 10 deletions v2.2.x/Variables.json
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
{
"milvus_release_version": "2.2.14",
"milvus_release_tag": "2.2.14",
"milvus_release_version": "2.3.0",
"milvus_release_tag": "2.3.0",
"milvus_deb_name": "milvus_2.2.0-1_amd64",
"milvus_rpm_name": "milvus-2.2.0-1.el7.x86_64",
"milvus_python_sdk_version": "2.2.x",
"milvus_node_sdk_version": "2.2.x",
"milvus_go_sdk_version": "2.2.x",
"milvus_java_sdk_version": "2.2.x",
"milvus_restful_sdk_version": "2.2.x",
"milvus_python_sdk_version": "2.3.x",
"milvus_node_sdk_version": "2.3.x",
"milvus_go_sdk_version": "2.3.x",
"milvus_java_sdk_version": "2.3.x",
"milvus_restful_sdk_version": "2.3.x",
"milvus_operator_version": "0.7.17",
"milvus_helm_chart_version": "4.0.34",
"milvus_image": "2.2.14",
"milvus_helm_chart_version": "4.1.0",
"milvus_image": "2.3.0",
"attu_release": "2.2.8",
"milvus_backup_release": "0.3.2"
"milvus_backup_release": "0.3.2",
"birdwatcher_release": "1.0.3"
}
Binary file modified v2.2.x/assets/IP_formula.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added v2.2.x/assets/attu-snapshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added v2.2.x/assets/birdwatcher_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added v2.2.x/assets/cosine_similarity.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified v2.2.x/assets/euclidean_metric.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified v2.2.x/assets/substructure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified v2.2.x/assets/superstructure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 3 additions & 8 deletions v2.2.x/site/en/about/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,10 @@ Indexes are an organization unit of data. You must declare the index type and si
Most of the vector index types supported by Milvus use approximate nearest neighbors search (ANNS), including:

- **FLAT**: FLAT is best suited for scenarios that seek perfectly accurate and exact search results on a small, million-scale dataset.
- **IVF_FLAT**: IVF_FLAT is a quantization-based index and is best suited for scenarios that seek an ideal balance between accuracy and query speed.
- **IVF_FLAT**: IVF_FLAT is a quantization-based index and is best suited for scenarios that seek an ideal balance between accuracy and query speed. There is also a GPU version **GPU_IVF_FLAT**.
- **IVF_SQ8**: IVF_SQ8 is a quantization-based index and is best suited for scenarios that seek a significant reduction on disk, CPU, and GPU memory consumption as these resources are very limited.
- **IVF_PQ**: IVF_PQ is a quantization-based index and is best suited for scenarios that seek high query speed even at the cost of accuracy.
- **IVF_PQ**: IVF_PQ is a quantization-based index and is best suited for scenarios that seek high query speed even at the cost of accuracy. There is also a GPU version **GPU_IVF_PQ**.
- **HNSW**: HNSW is a graph-based index and is best suited for scenarios that have a high demand for search efficiency.
- **ANNOY**: ANNOY is a tree-based index and is best suited for scenarios that seek a high recall rate.

See [Vector Index](index.md) for more details.

Expand All @@ -73,9 +72,6 @@ The metrics that are widely used for floating point embeddings include:
The metrics that are widely used for binary embeddings include:
- **Hamming**: This metric is generally used in the field of natural language processing (NLP).
- **Jaccard**: This metric is generally used in the field of molecular similarity search.
- **Tanimoto**: This metric is generally used in the field of molecular similarity search.
- **Superstructure**: This metric is generally used to search for similar superstructure of a molecule.
- **Substructure**: This metric is generally used to search for similar substructure of a molecule.

See [Similarity Metrics](metric.md#floating) for more information.

Expand All @@ -86,10 +82,9 @@ Milvus makes it easy to add similarity search to your applications. Example appl
- [Image similarity search](image_similarity_search.md): Images made searchable and instantaneously return the most similar images from a massive database.
- [Video similarity search](video_similarity_search.md): By converting key frames into vectors and then feeding the results into Milvus, billions of videos can be searched and recommended in near real-time.
- [Audio similarity search](audio_similarity_search.md): Quickly query massive volumes of audio data such as speech, music, sound effects, and surface similar sounds.
- [Molecular similarity search](molecular_similarity_search.md): Blazing fast similarity search, substructure search, or superstructure search for a specified molecule.
- [Recommender system](recommendation_system.md): Recommend information or products based on user behaviors and needs.
- [Question answering system](question_answering_system.md): Interactive digital QA chatbot that automatically answers user questions.
- [DNA sequence classification](dna_sequence_classification.md): Accurately sort out the classification of a gene in milliseconds by comparing similar DNA sequence.
- [DNA sequence classification](dna_sequence_classification.md): Accurately sort out the classification of a gene in milliseconds by comparing similar DNA sequences.
- [Text search engine](text_search_engine.md): Help users find the information they are looking for by comparing keywords against a database of texts.

See [Milvus tutorials](https://github.com/milvus-io/bootcamp/tree/master/solutions) and [Milvus Adopters](milvus_adopters.md) for more Milvus application scenarios.
Expand Down
24 changes: 0 additions & 24 deletions v2.2.x/site/en/adminGuide/administration_guide.md

This file was deleted.

10 changes: 5 additions & 5 deletions v2.2.x/site/en/adminGuide/configure-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ In current release, all parameters take effect only after Milvus restarts.

## Download a configuration file

[Download](https://raw.githubusercontent.com/milvus-io/milvus/v2.2.14/configs/milvus.yaml) `milvus.yaml` directly or with the following command.
[Download](https://raw.githubusercontent.com/milvus-io/milvus/v2.3.0/configs/milvus.yaml) `milvus.yaml` directly or with the following command.

```
$ wget https://raw.githubusercontent.com/milvus-io/milvus/v2.2.14/configs/milvus.yaml
$ wget https://raw.githubusercontent.com/milvus-io/milvus/v2.3.0/configs/milvus.yaml
```

## Modify the configuration file
Expand Down Expand Up @@ -171,13 +171,13 @@ Sorted by:

## Download an installation file

Download the installation file for Milvus [standalone](https://github.com/milvus-io/milvus/releases/download/v2.2.14/milvus-standalone-docker-compose.yml), and save it as `docker-compose.yml`.
Download the installation file for Milvus [standalone](https://github.com/milvus-io/milvus/releases/download/v2.3.0/milvus-standalone-docker-compose.yml), and save it as `docker-compose.yml`.

You can also simply run the following command.

```
# For Milvus standalone
$ wget https://github.com/milvus-io/milvus/releases/download/v2.2.14/milvus-standalone-docker-compose.yml -O docker-compose.yml
$ wget https://github.com/milvus-io/milvus/releases/download/v2.3.0/milvus-standalone-docker-compose.yml -O docker-compose.yml
```

## Modify the installation file
Expand All @@ -190,7 +190,7 @@ Map the local path to your `milvus.yaml` file onto the corresponding docker cont
...
proxy:
container_name: milvus-proxy
image: milvusdb/milvus:v2.2.14
image: milvusdb/milvus:v2.3.0
command: ["milvus", "run", "proxy"]
volumes: # Add a volumes section.
- /local/path/to/your/milvus.yaml:/milvus/configs/milvus.yaml # Map the local path to the container path
Expand Down
Loading

0 comments on commit 700be8c

Please sign in to comment.