diff --git a/CONTRIBUTING_JA.md b/CONTRIBUTING_JA.md new file mode 100644 index 0000000000..f83c4b3fc3 --- /dev/null +++ b/CONTRIBUTING_JA.md @@ -0,0 +1,55 @@ +# コントリビュート + +[Dify](https://dify.ai) に興味を持ち、貢献したいと思うようになったことに感謝します！始める前に、 +[行動規範](https://github.com/langgenius/.github/blob/main/CODE_OF_CONDUCT.md)を読み、 +[既存の問題](https://github.com/langgenius/langgenius-gateway/issues)をチェックしてください。 +本ドキュメントは、[Dify](https://dify.ai) をビルドしてテストするための開発環境の構築方法を説明するものです。 + +### 依存関係のインストール + +[Dify](https://dify.ai)をビルドするには、お使いのマシンに以下の依存関係をインストールし、設定する必要があります: + +- [Git](http://git-scm.com/) +- [Docker](https://www.docker.com/) +- [Docker Compose](https://docs.docker.com/compose/install/) +- [Node.js v18.x (LTS)](http://nodejs.org) +- [npm](https://www.npmjs.com/) バージョン 8.x.x もしくは [Yarn](https://yarnpkg.com/) +- [Python](https://www.python.org/) バージョン 3.10.x + +## ローカル開発 + +開発環境を構築するには、プロジェクトの git リポジトリをフォークし、適切なパッケージマネージャを使用してバックエンドとフロントエンドの依存関係をインストールし、docker-compose スタックを実行するように作成します。 + +### リポジトリのフォーク + +[リポジトリ](https://github.com/langgenius/dify) をフォークする必要があります。 + +### リポジトリのクローン + +GitHub でフォークしたリポジトリのクローンを作成する: + +``` +git clone git@github.com:/dify.git +``` + +### バックエンドのインストール + +バックエンドアプリケーションのインストール方法については、[Backend README](api/README.md) を参照してください。 + +### フロントエンドのインストール + +フロントエンドアプリケーションのインストール方法については、[Frontend README](web/README.md) を参照してください。 + +### ブラウザで dify にアクセス + +[Dify](https://dify.ai) をローカル環境で見ることができるようになりました [http://localhost:3000](http://localhost:3000)。 + +## プルリクエストの作成 + +変更後、プルリクエスト (PR) をオープンしてください。プルリクエストを提出すると、Dify チーム/コミュニティの他の人があなたと一緒にそれをレビューします。 + +マージコンフリクトなどの問題が発生したり、プルリクエストの開き方がわからなくなったりしませんでしたか？ [GitHub's pull request tutorial](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests) で、マージコンフリクトやその他の問題を解決する方法をチェックしてみてください。あなたの PR がマージされると、[コントリビュータチャート](https://github.com/langgenius/langgenius-gateway/graphs/contributors)にコントリビュータとして誇らしげに掲載されます。 + +## コミュニティチャンネル + +お困りですか？何か質問がありますか？ [Discord Community サーバ](https://discord.gg/AhzKf7dNgk)に参加してください。私たちがお手伝いします！ diff --git a/README.md b/README.md index e80559bcf7..499707d2e7 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ ![](./images/describe-en.png)

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

[Website](https://dify.ai) • [Docs](https://docs.dify.ai) • [Twitter](https://twitter.com/dify_ai) • [Discord](https://discord.gg/FngNHpbcY7) diff --git a/README_CN.md b/README_CN.md index c72c03bd6a..17cd027aee 100644 --- a/README_CN.md +++ b/README_CN.md @@ -1,7 +1,8 @@ ![](./images/describe-cn.jpg)

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

diff --git a/README_JA.md b/README_JA.md new file mode 100644 index 0000000000..6b62747c9c --- /dev/null +++ b/README_JA.md @@ -0,0 +1,116 @@ +![](./images/describe-en.png) +

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

+ +[Web サイト](https://dify.ai) • [ドキュメント](https://docs.dify.ai) • [Twitter](https://twitter.com/dify_ai) • [Discord](https://discord.gg/FngNHpbcY7) + +**Dify** は、より多くの人々が持続可能な AI ネイティブアプリケーションを作成できるように設計された、使いやすい LLMOps プラットフォームです。様々なアプリケーションタイプに対応したビジュアルオーケストレーションにより Dify は Backend-as-a-Service API としても機能する、すぐに使えるアプリケーションを提供します。プラグインやデータセットを統合するための1つの API で開発プロセスを統一し、プロンプトエンジニアリング、ビジュアル分析、継続的な改善のための1つのインターフェイスを使って業務を合理化します。 + +Difyで作成したアプリケーションは以下の通りです: + +フォームモードとチャット会話モードをサポートする、すぐに使える Web サイト +プラグイン機能、コンテキストの強化などを網羅する単一の API により、バックエンドのコーディングの手間を省きます。 +アプリケーションの視覚的なデータ分析、ログレビュー、アノテーションが可能です。 +Dify は LangChain と互換性があり、複数の LLM を徐々にサポートします: + +- GPT 3 (text-davinci-003) +- GPT 3.5 Turbo(ChatGPT) +- GPT-4 + +## クラウドサービスの利用 + +[Dify.ai](https://dify.ai) をご覧ください + +## Community Edition のインストール + +### システム要件 + +Dify をインストールする前に、お使いのマシンが以下の最低システム要件を満たしていることを確認してください: + +- CPU >= 1 Core +- RAM >= 4GB + +### クイックスタート + +Dify サーバーを起動する最も簡単な方法は、[docker-compose.yml](docker/docker-compose.yaml) ファイルを実行することです。インストールコマンドを実行する前に、[Docker](https://docs.docker.com/get-docker/) と [Docker Compose](https://docs.docker.com/compose/install/) がお使いのマシンにインストールされていることを確認してください: + +```bash +cd docker +docker-compose up -d +``` + +実行後、ブラウザで [http://localhost/install](http://localhost/install) にアクセスし、初期化インストール作業を開始することができます。 + +### 構成 + +カスタマイズが必要な場合は、[docker-compose.yml](docker/docker-compose.yaml) ファイルのコメントを参照し、手動で環境設定をお願いします。変更後、再度 'docker-compose up -d' を実行してください。 + +## ロードマップ + +開発中の機能: + +- **データセット**, Notionやウェブページからのコンテンツ同期など、より多くのデータセットをサポートします +テキスト、ウェブページ、さらには Notion コンテンツなど、より多くのデータセットをサポートする予定です。ユーザーは、自分のデータソースをもとに AI アプリケーションを構築することができます。 +- **プラグイン**, アプリケーションに ChatGPT プラグイン標準のプラグインを導入する、または Dify 制作のプラグインを利用する +今後、ChatGPT 規格に準拠したプラグインや、ディファイ独自のプラグインを公開し、より多くの機能をアプリケーションで実現できるようにします。 +- **オープンソースモデル**, 例えばモデルプロバイダーとして Llama を採用したり、さらにファインチューニングを行う +Llama のような優れたオープンソースモデルを、私たちのプラットフォームのモデルオプションとして提供したり、さらなる微調整のために使用したりすることで、協力していきます。 + + +## Q&A + +**Q: Dify で何ができるのか？** + +A: Dify はシンプルでパワフルな LLM 開発・運用ツールです。商用グレードのアプリケーション、パーソナルアシスタントを構築するために使用することができます。独自のアプリケーションを開発したい場合、LangDifyGenius は OpenAI と統合する際のバックエンド作業を省き、視覚的な操作機能を提供し、GPT モデルを継続的に改善・訓練することが可能です。 + +**Q: Dify を使って、自分のモデルを「トレーニング」するにはどうすればいいのでしょうか？** + +A: プロンプトエンジニアリング、コンテキスト拡張、ファインチューニングからなる価値あるアプリケーションです。プロンプトとプログラミング言語を組み合わせたハイブリッドプログラミングアプローチ（テンプレートエンジンのようなもの）で、長文の埋め込みやユーザー入力の YouTube 動画からの字幕取り込みなどを簡単に実現し、これらはすべて LLM が処理するコンテキストとして提出される予定です。また、アプリケーションの操作性を重視し、ユーザーがアプリケーションを使用する際に生成したデータを分析、アノテーション、継続的なトレーニングに利用できるようにしました。適切なツールがなければ、これらのステップに時間がかかることがあります。 + +**Q: 自分でアプリケーションを作りたい場合、何を準備すればよいですか？** + +A: すでに OpenAI API Key をお持ちだと思いますが、お持ちでない場合はご登録ください。もし、すでにトレーニングのコンテキストとなるコンテンツをお持ちでしたら、それは素晴らしいことです！ + +**Q: インターフェイスにどの言語が使えますか？** + +A: 現在、英語と中国語に対応しており、言語パックを寄贈することも可能です。 + +## Star ヒストリー + +[![Star History Chart](https://api.star-history.com/svg?repos=langgenius/dify&type=Date)](https://star-history.com/#langgenius/dify&Date) + +## お問合せ + +ご質問、ご提案、パートナーシップに関するお問い合わせは、以下のチャンネルからお気軽にご連絡ください: + +- GitHub Repo で Issue や PR を提出する +- [Discord](https://discord.gg/FngNHpbcY7) コミュニティで議論に参加する。 +- hello@dify.ai にメールを送信します + +私たちは、皆様のお手伝いをさせていただき、より楽しく、より便利な AI アプリケーションを一緒に作っていきたいと思っています！ + +## コントリビュート + +適切なレビューを行うため、コミットへの直接アクセスが可能なコントリビュータを含むすべてのコードコントリビュータは、プルリクエストで提出し、マージされる前にコア開発チームによって承認される必要があります。 + +私たちはすべてのプルリクエストを歓迎します！協力したい方は、[コントリビューションガイド](CONTRIBUTING.md) をチェックしてみてください。 + +## セキュリティ + +プライバシー保護のため、GitHub へのセキュリティ問題の投稿は避けてください。代わりに、あなたの質問を security@dify.ai に送ってください。より詳細な回答を提供します。 + +## 引用 + +本ソフトウェアは、以下のオープンソースソフトウェアを使用しています: + +- Chase, H. (2022). LangChain [Computer software]. https://github.com/hwchase17/langchain +- Liu, J. (2022). LlamaIndex [Computer software]. doi: 10.5281/zenodo.1234. + +詳しくは、各ソフトウェアの公式サイトまたはライセンス文をご参照ください。 + +## ライセンス + +このリポジトリは、[Dify Open Source License](LICENSE) のもとで利用できます。