From f2f021bfd1f87bcbbf7b870bd3674152c156b34f Mon Sep 17 00:00:00 2001 From: Ikko Eltociear Ashimine Date: Thu, 4 Apr 2024 10:26:39 +0900 Subject: [PATCH] docs: Add Japanese README (#224) ### What problem does this PR solve? I created Japanese translated README. ### Type of change - [x] Documentation Update --- README.md | 3 +- README_ja.md | 182 +++++++++++++++++++++++++++++++++++++++++++++++++++ README_zh.md | 3 +- 3 files changed, 186 insertions(+), 2 deletions(-) create mode 100644 README_ja.md diff --git a/README.md b/README.md index 158ff8a4..3070eaf5 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,8 @@

English | - 简体中文 + 简体中文 | + 日本語

diff --git a/README_ja.md b/README_ja.md new file mode 100644 index 00000000..bd64189f --- /dev/null +++ b/README_ja.md @@ -0,0 +1,182 @@ +

+ +ragflow logo + +
+ +

+ English | + 简体中文 | + 日本語 +

+ +

+ + Static Badge + + docker pull ragflow:v1.0 + + license + +

+ +## 💡 RAGFlow とは？ + +[RAGFlow](https://demo.ragflow.io) は、深い文書理解に基づいたオープンソースの RAG (Retrieval-Augmented Generation) エンジンである。LLM（大規模言語モデル）を組み合わせることで、様々な複雑なフォーマットのデータから根拠のある引用に裏打ちされた、真実味のある質問応答機能を提供し、あらゆる規模のビジネスに合理化された RAG ワークフローを提供します。 + +## 🌟 主な特徴 + +### 🍭 **"Quality in, quality out"** + +- 複雑な形式の非構造化データからの[深い文書理解](./deepdoc/README.md)ベースの知識抽出。 +- 文字通り無限のトークンから"干し草の山の中の針"を見つける。 + +### 🍱 **テンプレートベースのチャンク化** + +- 知的で説明しやすい。 +- 豊富なテンプレートオプション。 + +### 🌱 **ハルシネーションが軽減された根拠のある引用** + +- 人間の介入を可能にするテキストチャンキングの視覚化。 +- 重要な参考文献のクイックビューと、根拠ある答えをサポートする追跡可能な引用。 + +### 🍔 **異種のデータソースとの互換性** + +- Word、スライド、Excel、txt、画像、スキャンコピー、構造化データ、Web ページなどをサポート。 + +### 🛀 **自動化された楽な RAG ワークフロー** + +- 個人から大企業まで対応する合理化されたRAGオーケストレーション。 +- 設定可能な LLM とエンベッディングモデル。 +- 複数の想起と融合された再ランク付け。 +- ビジネスとのシームレスな統合のための直感的な API。 + +## 🔎 システム構成 + +
+ +
+ +## 🎬 始める + +### 📝 必要条件 + +- CPU >= 2 cores +- RAM >= 8 GB +- Docker + > ローカルマシン（Windows、Mac、または Linux）に Docker をインストールしていない場合は、[Docker Engine のインストール](https://docs.docker.com/engine/install/)を参照してください。 + +### 🚀 サーバーを起動 + +1. `vm.max_map_count` > 65535 であることを確認する: + + > `vm.max_map_count` の値をチェックするには: + > + > ```bash + > $ sysctl vm.max_map_count + > ``` + > + > `vm.max_map_count` が 65535 より大きい値でなければリセットする。 + > + > ```bash + > # In this case, we set it to 262144: + > $ sudo sysctl -w vm.max_map_count=262144 + > ``` + > + > この変更はシステム再起動後にリセットされる。変更を恒久的なものにするには、**/etc/sysctl.conf** の `vm.max_map_count` 値を適宜追加または更新する: + > + > ```bash + > vm.max_map_count=262144 + > ``` + +2. リポジトリをクローンする: + + ```bash + $ git clone https://github.com/infiniflow/ragflow.git + ``` + +3. ビルド済みの Docker イメージをビルドし、サーバーを起動する: + + ```bash + $ cd ragflow/docker + $ docker compose up -d + ``` + + > コアイメージのサイズは約 15 GB で、ロードに時間がかかる場合があります。 + +4. サーバーを立ち上げた後、サーバーの状態を確認する: + + ```bash + $ docker logs -f ragflow-server + ``` + + _以下の出力は、システムが正常に起動したことを確認するものです:_ + + ```bash + ____ ______ __ + / __ \ ____ _ ____ _ / ____// /____ _ __ + / /_/ // __ `// __ `// /_ / // __ \| | /| / / + / _, _// /_/ // /_/ // __/ / // /_/ /| |/ |/ / + /_/ |_| \__,_/ \__, //_/ /_/ \____/ |__/|__/ + /____/ + + * Running on all addresses (0.0.0.0) + * Running on http://127.0.0.1:9380 + * Running on http://172.22.0.5:9380 + INFO:werkzeug:Press CTRL+C to quit + ``` + +5. ウェブブラウザで、プロンプトに従ってサーバーの IP アドレスを入力し、RAGFlow にログインします。 + > デフォルトの設定を使用する場合、デフォルトの HTTP サービングポート `80` は省略できるので、与えられたシナリオでは、`http://172.22.0.5`（ポート番号は省略）だけを入力すればよい。 +6. [service_conf.yaml](./docker/service_conf.yaml) で、`user_default_llm` で希望の LLM ファクトリを選択し、`API_KEY` フィールドを対応する API キーで更新する。 + + > 詳しくは [./docs/llm_api_key_setup.md](./docs/llm_api_key_setup.md) を参照してください。 + + _ショーの開幕です！_ + +## 🔧 コンフィグ + +システムコンフィグに関しては、以下のファイルを管理する必要がある: + +- [.env](./docker/.env): `SVR_HTTP_PORT`、`MYSQL_PASSWORD`、`MINIO_PASSWORD` などのシステムの基本設定を保持する。 +- [service_conf.yaml](./docker/service_conf.yaml): バックエンドのサービスを設定します。 +- [docker-compose.yml](./docker/docker-compose.yml): システムの起動は [docker-compose.yml](./docker/docker-compose.yml) に依存している。 + +[.env](./docker/.env) ファイルの変更が [service_conf.yaml](./docker/service_conf.yaml) ファイルの内容と一致していることを確認する必要があります。 + +> [./docker/README](./docker/README.md) ファイルは環境設定とサービスコンフィグの詳細な説明を提供し、[./docker/README](./docker/README.md) ファイルに記載されている全ての環境設定が [service_conf.yaml](./docker/service_conf.yaml) ファイルの対応するコンフィグと一致していることを確認することが義務付けられています。 + +デフォルトの HTTP サービングポート(80)を更新するには、[docker-compose.yml](./docker/docker-compose.yml) にアクセスして、`80:80` を `:80` に変更します。 + +> すべてのシステム設定のアップデートを有効にするには、システムの再起動が必要です: +> +> ```bash +> $ docker-compose up -d +> ``` + +## 🛠️ ソースからビルドする + +ソースからDockerイメージをビルドするには: + +```bash +$ git clone https://github.com/infiniflow/ragflow.git +$ cd ragflow/ +$ docker build -t infiniflow/ragflow:v1.0 . +$ cd ragflow/docker +$ docker compose up -d +``` + +## 📜 ロードマップ + +[RAGFlow ロードマップ 2024](https://github.com/infiniflow/ragflow/issues/162) を参照 + +## 🏄 コミュニティ + +- [Discord](https://discord.gg/uqQ4YMDf) +- [Twitter](https://twitter.com/infiniflowai) + +## 🙌 コントリビュート + +RAGFlow はオープンソースのコラボレーションによって発展してきました。この精神に基づき、私たちはコミュニティからの多様なコントリビュートを受け入れています。 参加を希望される方は、まず[コントリビューションガイド](https://github.com/infiniflow/ragflow/blob/main/docs/CONTRIBUTING.md)をご覧ください。 diff --git a/README_zh.md b/README_zh.md index 0454657d..91a0cd72 100644 --- a/README_zh.md +++ b/README_zh.md @@ -6,7 +6,8 @@

English | - 简体中文 + 简体中文 | + 日本語