From 74a1657752c940ff9214dd9bace2d6bb15e126ac Mon Sep 17 00:00:00 2001 From: Lutkin Wang Date: Thu, 2 Apr 2020 14:13:39 +0800 Subject: [PATCH] Reorganize readme (update cn & en; delete jp) (#1850) * [skip ci] Update readme Signed-off-by: Lutkin Wang * [skip ci] Update readme Signed-off-by: Lutkin Wang * [skip ci] Delete readme Signed-off-by: Lutkin Wang --- README.md | 68 ++++++++---------------------- README_CN.md | 47 +++++++++------------ README_JP.md | 114 --------------------------------------------------- 3 files changed, 38 insertions(+), 191 deletions(-) delete mode 100644 README_JP.md diff --git a/README.md b/README.md index b260b93f..d18a9708 100644 --- a/README.md +++ b/README.md @@ -11,33 +11,27 @@ [![CodeFactor Grade](https://www.codefactor.io/repository/github/milvus-io/milvus/badge)](https://www.codefactor.io/repository/github/milvus-io/milvus) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/c4bb2ccfb51b47f99e43bfd1705edd95)](https://app.codacy.com/gh/milvus-io/milvus?utm_source=github.com&utm_medium=referral&utm_content=milvus-io/milvus&utm_campaign=Badge_Grade_Dashboard) -[中文版](README_CN.md) | [日本語版](README_JP.md) +English | [中文版](README_CN.md) ## What is Milvus -Milvus is an open source vector similarity search engine. Built with heterogeneous computing architecture for the best cost efficiency. Searches over billion-scale vectors take only milliseconds with minimum computing resources. +As an open source vector similarity search engine, Milvus is easy-to-use, highly reliable, scalable, robust, and blazing fast. Adopted by over 100 organizations and institutions worldwide, Milvus empowers applications in a variety of fields, including image processing, computer vision, natural language processing, voice recognition, recommender systems, drug discovery, etc. -For more detailed introduction of Milvus and its architecture, see [Milvus overview](https://www.milvus.io/docs/about_milvus/overview.md). +Milvus has the following architecture: -Keep up-to-date with newest releases and latest updates by reading Milvus [release notes](https://www.milvus.io/docs/releases/release_notes.md). +![arch](https://github.com/milvus-io/docs/blob/v0.7.1/assets/milvus_arch.png) -## Roadmap - -To learn what's coming up soon in Milvus, read our [Roadmap](https://github.com/milvus-io/milvus/milestones). - -It is a Work in Progress, and is subject to reasonable adjustments when necessary. And we greatly welcome any comments/requirements/suggestions regarding Milvus roadmap.:clap: +For more detailed introduction of Milvus and its architecture, see [Milvus overview](https://www.milvus.io/docs/about_milvus/overview.md). Keep up-to-date with newest releases and latest updates by reading Milvus [release notes](https://www.milvus.io/docs/releases/release_notes.md). -## Application scenarios - -Milvus is broadly applicable to a variety of areas. Below screenshot showcases our content-based image retrieval demo system built based on Milvus and VGG. +## Get started -[![image retrieval demo](https://raw.githubusercontent.com/milvus-io/docs/v0.7.0/assets/image_retrieval.png)](https://raw.githubusercontent.com/milvus-io/docs/v0.7.0/assets/image_retrieval.png) +### Install Milvus -To explore more Milvus solutions and application scenarios, see our [bootcamp](https://github.com/milvus-io/bootcamp) repository. +See the [Milvus install guide](https://www.milvus.io/docs/guides/get_started/install_milvus/install_milvus.md) to install Milvus using Docker. To install Milvus from source code, see [build from source](INSTALL.md). -## Test reports +### Try example programs -See our [test reports](https://github.com/milvus-io/milvus/tree/master/docs) for more information about performance benchmarking of different indexes in Milvus. +Try an example program with Milvus using [Python](https://www.milvus.io/docs/guides/get_started/example_code.md), [Java](https://github.com/milvus-io/milvus-sdk-java/tree/master/examples), [Go](https://github.com/milvus-io/milvus-sdk-go/tree/master/examples), or [C++ example code](https://github.com/milvus-io/milvus/tree/master/sdk/examples). ## Supported clients @@ -46,19 +40,21 @@ See our [test reports](https://github.com/milvus-io/milvus/tree/master/docs) for - [Java](https://github.com/milvus-io/milvus-sdk-java) - [C++](https://github.com/milvus-io/milvus/tree/master/sdk) - [RESTful API](https://github.com/milvus-io/milvus/tree/master/core/src/server/web_impl) -- [GUI](https://www.milvus.io/gui) - [Node.js](https://www.npmjs.com/package/@arkie-ai/milvus-client) (Provided by [arkie](https://www.arkie.cn/)) -## Get started +## Application scenarios -See the [Milvus install guide](https://www.milvus.io/docs/guides/get_started/install_milvus/install_milvus.md) for using Docker containers. To install Milvus from source code, see [build from source](INSTALL.md). +You can use Milvus to build intelligent systems in a variety of AI application scenarios. Refer to [Milvus Scenarios](https://milvus.io/scenarios) for live demos. You can also refer to [Milvus Bootcamp](https://github.com/milvus-io/bootcamp) for detailed solutions and application scenarios. -To edit Milvus settings, read [Milvus configuration](https://www.milvus.io/docs/reference/milvus_config.md). +## Benchmark + +See our [test reports](https://github.com/milvus-io/milvus/tree/master/docs) for more information about performance benchmarking of different indexes in Milvus. -### Try your first Milvus program +## Roadmap -Try running a program with Milvus using [Python](https://www.milvus.io/docs/guides/get_started/example_code.md), [Java](https://github.com/milvus-io/milvus-sdk-java/tree/master/examples), [Go](https://github.com/milvus-io/milvus-sdk-go/tree/master/examples), or [C++ example code](https://github.com/milvus-io/milvus/tree/master/sdk/examples). +To learn what's coming up soon in Milvus, read our [Roadmap](https://github.com/milvus-io/milvus/milestones). +It is a Work in Progress, and is subject to reasonable adjustments when necessary. And we greatly welcome any comments/requirements/suggestions regarding Milvus roadmap.:clap: ## Contribution guidelines @@ -72,34 +68,6 @@ We use [GitHub issues](https://github.com/milvus-io/milvus/issues) to track issu See our [community](https://github.com/milvus-io/community) repository to learn about our governance and access more community resources. -## Mailing lists - -- [Milvus TSC](https://lists.lfai.foundation/g/milvus-tsc) -- [Milvus Technical Discuss](https://lists.lfai.foundation/g/milvus-technical-discuss) -- [Milvus Announce](https://lists.lfai.foundation/g/milvus-announce) - -## Contributors - -Below is a list of Milvus contributors. We greatly appreciate your contributions! - - - - - - - - - - - - - -

zerowe-seven
💻
erdustiggen
💻
gaolizhou
💻
Sijie Zhang
📖
PizzaL
💻
levylll
💻
aaronjin2010
💻
- - - - - ## Resources diff --git a/README_CN.md b/README_CN.md index 6aed4dbe..0a4e1ff7 100644 --- a/README_CN.md +++ b/README_CN.md @@ -11,34 +11,29 @@ [![codebeat badge](https://codebeat.co/badges/e030a4f6-b126-4475-a938-4723d54ec3a7?style=plastic)](https://codebeat.co/projects/github-com-milvus-io-milvus-master) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/c4bb2ccfb51b47f99e43bfd1705edd95)](https://app.codacy.com/gh/milvus-io/milvus?utm_source=github.com&utm_medium=referral&utm_content=milvus-io/milvus&utm_campaign=Badge_Grade_Dashboard) +[English](README.md) | 中文版 + # 欢迎来到 Milvus ## Milvus 是什么 +Milvus 是一款开源的特征向量相似度搜索引擎，具有使用方便、实用可靠、易于扩展、稳定高效和搜索迅速等特点，在全球范围内被上百家组织和机构所采用。Milvus 已经被广泛应用于多个领域，其中包括图像处理、机器视觉、自然语言处理、语音识别、推荐系统以及新药发现等。 -Milvus 是一款开源的特征向量相似性搜索引擎。基于异构众核计算框架设计，成本更低，性能更好。在有限的计算资源下，十亿向量搜索仅毫秒响应。 - -若要了解 Milvus 详细介绍和整体架构，请访问 [Milvus 简介](https://www.milvus.io/cn/docs/about_milvus/overview.md)。 +Milvus 的架构如下： -通过 [版本发布说明](https://www.milvus.io/cn/docs/releases/release_notes.md) 获取最新版本的功能和更新。 +![arch](https://github.com/milvus-io/docs/raw/v0.7.1/assets/milvus_arch.png) -## 路线图 +若要了解 Milvus 详细介绍和整体架构，请访问 [Milvus 简介](https://www.milvus.io/cn/docs/about_milvus/overview.md)。您可以通过 [版本发布说明](https://www.milvus.io/cn/docs/releases/release_notes.md) 获取最新版本的功能和更新。 -您可以参考我们的[路线图](https://github.com/milvus-io/milvus/milestones)，了解 Milvus 即将实现的新特性。 +## Milvus 快速上手 -路线图尚未完成，并且可能会存在合理改动。我们欢迎各种针对路线图的意见、需求和建议。 +### 安装 Milvus -## 应用场景 - -Milvus 可以广泛应用于各类场景。下图展示了基于 Milvus 和 VGG 构建的以图搜图系统。 - -[![image retrieval demo](https://raw.githubusercontent.com/milvus-io/docs/v0.7.0/assets/image_retrieval.png)](https://raw.githubusercontent.com/milvus-io/docs/v0.7.0/assets/image_retrieval.png) - -您可以访问我们的[训练营](https://github.com/milvus-io/bootcamp)探索更多解决方案和应用场景。 +请参阅 [Milvus 安装指南](https://www.milvus.io/cn/docs/guides/get_started/install_milvus/install_milvus.md) 使用 Docker 容器安装 Milvus。若要基于源码编译，请访问 [源码安装](INSTALL.md)。 -## 测试报告 +### 尝试示例代码 -关于 Milvus 性能基准的更多信息，请参考[测试报告](https://github.com/milvus-io/milvus/tree/master/docs)。 +您可以尝试用 [Python](https://www.milvus.io/cn/docs/guides/get_started/example_code.md)，[Java](https://github.com/milvus-io/milvus-sdk-java/tree/master/examples)，[Go](https://github.com/milvus-io/milvus-sdk-go/tree/master/examples)，或者 [C++](https://github.com/milvus-io/milvus/tree/master/sdk/examples) 运行 Milvus 示例代码。 ## 支持的客户端 @@ -47,19 +42,21 @@ Milvus 可以广泛应用于各类场景。下图展示了基于 Milvus 和 VGG - [Java](https://github.com/milvus-io/milvus-sdk-java) - [C++](https://github.com/milvus-io/milvus/tree/master/sdk) - [RESTful API](https://github.com/milvus-io/milvus/tree/master/core/src/server/web_impl) -- [GUI](https://www.milvus.io/gui) - [Node.js](https://www.npmjs.com/package/@arkie-ai/milvus-client) (由 [arkie](https://www.arkie.cn/) 提供) -## 开始使用 Milvus +## 应用场景 -请参阅 [Milvus 安装指南](https://www.milvus.io/cn/docs/guides/get_started/install_milvus/install_milvus.md) 使用 Docker 容器安装 Milvus。若要基于源码编译，请访问 [源码安装](INSTALL.md)。 +Milvus 可以应用于多种 AI 场景。您可以访问 [Milvus 应用场景](https://milvus.io/scenarios) 体验在线场景展示。您也可以访问 [Milvus 训练营](https://github.com/milvus-io/bootcamp) 了解更详细的应用场景和解决方案。 -若要更改 Milvus 设置，请参阅 [Milvus 配置](https://www.milvus.io/cn/docs/reference/milvus_config.md)。 +## 性能基准测试 -### 开始您的第一个 Milvus 程序 +关于 Milvus 性能基准的更多信息，请参考[测试报告](https://github.com/milvus-io/milvus/tree/master/docs)。 -您可以尝试用 [Python](https://www.milvus.io/cn/docs/guides/get_started/example_code.md)，[Java](https://github.com/milvus-io/milvus-sdk-java/tree/master/examples)，[Go](https://github.com/milvus-io/milvus-sdk-go/tree/master/examples)，或者 [C++](https://github.com/milvus-io/milvus/tree/master/sdk/examples) 运行 Milvus 示例代码。 +## 路线图 +您可以参考我们的[路线图](https://github.com/milvus-io/milvus/milestones)，了解 Milvus 即将实现的新特性。 + +路线图尚未完成，并且可能会存在合理改动。我们欢迎各种针对路线图的意见、需求和建议。 ## 贡献者指南 @@ -79,10 +76,6 @@ Milvus 可以广泛应用于各类场景。下图展示了基于 Milvus 和 VGG - [Milvus.io](https://www.milvus.io) -- [Milvus 在线训练营](https://github.com/milvus-io/bootcamp) - -- [Milvus 测试报告](https://github.com/milvus-io/milvus/tree/master/docs) - - [Milvus 常见问题](https://www.milvus.io/cn/docs/faq/operational_faq.md) - [Milvus Medium](https://medium.com/@milvusio) @@ -97,4 +90,4 @@ Milvus 可以广泛应用于各类场景。下图展示了基于 Milvus 和 VGG ## 许可协议 -[Apache 许可协议2.0版](https://github.com/milvus-io/milvus/blob/master/LICENSE) +[Apache 许可协议 2.0 版](https://github.com/milvus-io/milvus/blob/master/LICENSE) diff --git a/README_JP.md b/README_JP.md deleted file mode 100644 index 3964d6e7..00000000 --- a/README_JP.md +++ /dev/null @@ -1,114 +0,0 @@ -![Milvuslogo](https://github.com/milvus-io/docs/blob/master/assets/milvus_logo.png) - -[![Slack](https://img.shields.io/badge/Join-Slack-orange)](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk) - -![GitHub](https://img.shields.io/github/license/milvus-io/milvus) -![Language](https://img.shields.io/github/languages/count/milvus-io/milvus) -![GitHub top language](https://img.shields.io/github/languages/top/milvus-io/milvus) -![GitHub release (latest by date)](https://img.shields.io/github/v/release/milvus-io/milvus) -![GitHub Release Date](https://img.shields.io/github/release-date/milvus-io/milvus) - -[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/milvus-io/milvus/pulse/monthly) -![OSS Lifecycle](https://img.shields.io/osslifecycle/milvus-io/milvus) -[![HitCount](http://hits.dwyl.com/milvus-io/milvus.svg)](http://hits.dwyl.com/milvus-io/milvus) -![Docker pulls](https://img.shields.io/docker/pulls/milvusdb/milvus) - -[![Build Status](http://internal.zilliz.com:18080/jenkins/job/milvus-ci/job/master/badge/icon)](http://internal.zilliz.com:18080/jenkins/job/milvus-ci/job/master/) -[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/3563/badge)](https://bestpractices.coreinfrastructure.org/projects/3563) -[![codecov](https://codecov.io/gh/milvus-io/milvus/branch/master/graph/badge.svg)](https://codecov.io/gh/milvus-io/milvus) -[![codebeat badge](https://codebeat.co/badges/e030a4f6-b126-4475-a938-4723d54ec3a7?style=plastic)](https://codebeat.co/projects/github-com-milvus-io-milvus-master) -[![Codacy Badge](https://api.codacy.com/project/badge/Grade/c4bb2ccfb51b47f99e43bfd1705edd95)](https://app.codacy.com/gh/milvus-io/milvus?utm_source=github.com&utm_medium=referral&utm_content=milvus-io/milvus&utm_campaign=Badge_Grade_Dashboard) -[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/milvus-io/milvus/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/milvus-io/milvus/) - -[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) - - -# Milvus へようこそ - -## 概要 - -Milvusは特徴ベクトルにむかうオーペンソース高性能類似性検索エンジンです。不均質な計算アーキテクチャーに基づいて効率を最大化出来ます。数十億のベクタの中に目標を検索できるまで数ミリ秒しかかからず、最低限の計算資源だけが必要です。 - -[基本紹介](https://www.milvus.io/docs/about_milvus/overview.md)を参考して詳しい情報を手に入れます。 - -Milvus [リリースノート](https://www.milvus.io/docs/releases/release_notes.md)を読んで最新バージョンや更新情報を手に入れます。 - -# ロードマップ - -[ロードマップ](https://github.com/milvus-io/milvus/milestones)を読んでMilvusの将来の特性をわかります。 - -このロードマップはまだまだ進行中なので、合理的な調整は可能です。全てのコメントや要件や提案などを歓迎です。 - -## アプリケーション - -様々な応用場合があります。MilvusとVGGで構築した画像検索のデモンストレーションです。 - -[![image retrieval demo](https://raw.githubusercontent.com/milvus-io/docs/v0.7.0/assets/image_retrieval.png)](https://raw.githubusercontent.com/milvus-io/docs/v0.7.0/assets/image_retrieval.png) - -ほかの解決方案を見たいと思うなら、[bootcamp](https://github.com/milvus-io/bootcamp)を参考してください。 - -## テスト報告 - -[テスト報告](https://github.com/milvus-io/milvus/tree/master/docs)を読んで性能基準をわかります。 - -## サポートするクライアント - -- [Go](https://github.com/milvus-io/milvus-sdk-go) -- [Python](https://github.com/milvus-io/pymilvus) -- [Java](https://github.com/milvus-io/milvus-sdk-java) -- [C++](https://github.com/milvus-io/milvus/tree/master/sdk) -- [RESTful API](https://github.com/milvus-io/milvus/tree/master/core/src/server/web_impl) -- [GUI](https://www.milvus.io/gui) -- [Node.js](https://www.npmjs.com/package/@arkie-ai/milvus-client) ([arkie](https://www.arkie.cn/)が提供した) - -## はじめに - -DockerでMilvusをインストールすることは簡単です。[Milvusインストール案内](https://www.milvus.io/docs/guides/get_started/install_milvus/install_milvus.md) を参考してください。ソースからMilvusを構築するために、[ソースから構築する](INSTALL.md)を参考してください。 - -Milvusをコンフィグするために、[Milvusコンフィグ](https://www.milvus.io/docs/reference/milvus_config.md)を読んでください。 - -### 初めてのMilvusプログラムを試す - -[Python](https://www.milvus.io/docs/guides/get_started/example_code.md)、[Java](https://github.com/milvus-io/milvus-sdk-java/tree/master/examples)、[Go](https://github.com/milvus-io/milvus-sdk-go/tree/master/examples)、または[C++](https://github.com/milvus-io/milvus/tree/master/sdk/examples)などのサンプルコードを使ってMilvusプログラムを試す。 - -## 貢献規約 - -本プロジェクトへの貢献に心より感謝いたします。 Milvusを貢献したいと思うなら、[貢献規約](CONTRIBUTING.md)を読んでください。 本プロジェクトはMilvusの[行動規範](CODE_OF_CONDUCT.md)に従います。プロジェクトに参加したい場合は、行動規範を従ってください。 - -[GitHub issues](https://github.com/milvus-io/milvus/issues) を使って問題やバッグなとを報告しでください。 一般てきな問題なら, Milvusコミュニティに参加してください。 - -## メーリングリスト - -- [Milvus TSC](https://lists.lfai.foundation/g/milvus-tsc) -- [Milvus Technical Discuss](https://lists.lfai.foundation/g/milvus-technical-discuss) -- [Milvus Announce](https://lists.lfai.foundation/g/milvus-announce) - -## Milvusコミュニティを参加する - -他の貢献者と交流したい場合は、Milvusの [slackチャンネル](https://join.slack.com/t/milvusio/shared_invite/enQtNzY1OTQ0NDI3NjMzLWNmYmM1NmNjOTQ5MGI5NDhhYmRhMGU5M2NhNzhhMDMzY2MzNDdlYjM5ODQ5MmE3ODFlYzU3YjJkNmVlNDQ2ZTk)に参加してください。 - - -## 参考情報 - -- [Milvus.io](https://www.milvus.io) - -- [Milvus](https://github.com/milvus-io/bootcamp) - -- [Milvus テストレポート](https://github.com/milvus-io/milvus/tree/master/docs) - -- [Milvus のよくある質問](https://www.milvus.io/docs/faq/operational_faq.md) - -- [Milvus Medium](https://medium.com/@milvusio) - -- [Milvus CSDN](https://zilliz.blog.csdn.net/) - -- [Milvus ツイッター](https://twitter.com/milvusio) - -- [Milvus Facebook](https://www.facebook.com/io.milvus.5) - -- [Milvus デザイン文書](DESIGN.md) - - -## ライセンス - -[Apache 2.0ライセンス](LICENSE) -- GitLab