Merge pull request #1 from eltociear/add_ja-readme

docs: add Japanese README
modelscope · Feb 12, 2024 · 2fe8af0 · 2fe8af0
2 parents baf05ec + 6bd92de
commit 2fe8af0
Show file tree

Hide file tree

Showing 3 changed files with 100 additions and 3 deletions.
diff --git a/README-ja_JP.md b/README-ja_JP.md
@@ -0,0 +1,97 @@
+<h1>Modelscope Studio</h1>
+
+<p align="center">
+    <img src="https://modelscope.oss-cn-beijing.aliyuncs.com/modelscope.gif" height="60" style="vertical-align: middle;"/>
+    <span style="font-size: 30px; vertical-align: middle;">
+    ✖️
+    </span>
+    <img src="https://www.gradio.app/_app/immutable/assets/gradio.8a5e8876.svg" height="60" style="vertical-align: middle;">
+<p>
+
+<p align="center">
+<a href="https://github.com/modelscope/modelscope-studio">GitHub</a> | 🤖 <a href="https://modelscope.cn/studios/modelscope/modelscope-studio/summary">Modelscope Studio</a> ｜ 🤗 <a href="https://huggingface.co/spaces/modelscope/modelscope-studio">Hugging Face Space</a>
+<br>
+  <a href="README-zh_CN.md">中文</a>&nbsp ｜ &nbsp<a href="README.md">English</a>&nbsp ｜ &nbsp日本語
+</p>
+
+`modelscope_studio` は、gradio 4.x をベースにした拡張コンポーネントライブラリのセットで、ModelScope Studio 内の gradio アプリケーションの様々な拡張ニーズに対応するためのものになります。こちらは主に会話シナリオの強化、マルチモーダルコンテキストのサポート、その他様々な特殊シナリオの支援に重点を置いています。
+
+## インストール
+
+```sh
+pip install modelscope_studio
+```
+
+## クイックスタート
+
+```python
+import time
+import gradio as gr
+import modelscope_studio as mgr
+
+def submit(_input, _chatbot):
+    print('text：', _input.text)
+    print('files: ', _input.files)
+    _chatbot.append([_input, None])
+    yield _chatbot
+    time.sleep(1)
+    _chatbot[-1][1] = [{
+        "flushing": False,
+        "text": 'bot1: ' + _input.text + '!'
+    }, {
+        "text": 'bot2: ' + _input.text + '!'
+    }]
+    yield {
+        chatbot: _chatbot,
+    }
+
+with gr.Blocks() as demo:
+    chatbot = mgr.Chatbot(height=400)
+
+    input = mgr.MultimodalInput()
+    input.submit(fn=submit, inputs=[input, chatbot], outputs=[chatbot])
+
+demo.queue().launch()
+```
+
+![quickstart](./resources/quickstart.png)
+
+## コンポーネントドキュメント
+
+現在サポートされているコンポーネントは以下の通りです:
+
+- Chatbot: gradio チャットボット拡張コンポーネントは、マルチモーダルコンテンツ出力、マルチボットシナリオ、会話コンテンツ内のカスタムレンダリングコンポーネントやイベントインタラクションをサポートします。
+- MultimodalInput: ファイルアップロード、録画、写真撮影などの機能をサポートするマルチモーダル入力ボックス。
+- Markdown: gradio Markdown 拡張コンポーネントは、マルチモーダルコンテンツ（オーディオ、ビデオ、音声、ファイル、テキスト）の出力をサポートします。
+- ImageGallery (WIP): gradio Gallery 拡張コンポーネントは、ウォーターフォール形式の画像表示をサポートします。
+- その他のコンポーネント...
+
+詳しい使い方は[ドキュメントと例](https://modelscope.cn/studios/modelscope/modelscope-studio/summary)を参照して下さい
+
+## 開発
+
+このリポジトリをローカルにクローンする:
+
+```sh
+git clone [email protected]:modelscope/modelscope-studio.git
+cd modelscope-studio
+# バックエンド用
+pip install -e '.'
+# フロントエンド用
+npm install pnpm -g
+
+pnpm install
+pnpm build
+```
+
+デモを実行!
+
+```sh
+gradio docs/app.py
+```
+
+または、次のような単一のデモを実行:
+
+```sh
+gradio docs/components/Chatbot/demos/basic.py
+```
diff --git a/README-zh_CN.md b/README-zh_CN.md
@@ -11,7 +11,7 @@
 <p align="center">
 <a href="https://github.com/modelscope/modelscope-studio">Github</a> | 🤖 <a href="https://modelscope.cn/studios/modelscope/modelscope-studio/summary">Modelscope Studio</a> ｜ 🤗 <a href="https://huggingface.co/spaces/modelscope/modelscope-studio">HuggingFace Space</a>
 <br>
-    中文&nbsp ｜ &nbsp<a href="README.md">English</a>
+    中文&nbsp ｜ &nbsp<a href="README.md">English</a>&nbsp ｜ &nbsp<a href="README-ja_JP.md">日本語</a>
 </p>
 
 `modelscope_studio` 是一套基于 gradio 4.x 的扩展组件库，致力于服务于 ModelScope 创空间中对于 gradio 应用的各类扩展需求，目前主要聚集在对话场景增强、多模态场景以及一些其他垂直场景支持。

diff --git a/README.md b/README.md
@@ -9,9 +9,9 @@
 <p>
 
 <p align="center">
-<a href="https://github.com/modelscope/modelscope-studio">Github</a> | 🤖 <a href="https://modelscope.cn/studios/modelscope/modelscope-studio/summary">Modelscope Studio</a> ｜ 🤗 <a href="https://huggingface.co/spaces/modelscope/modelscope-studio">HuggingFace Space</a>
+<a href="https://github.com/modelscope/modelscope-studio">GitHub</a> | 🤖 <a href="https://modelscope.cn/studios/modelscope/modelscope-studio/summary">Modelscope Studio</a> ｜ 🤗 <a href="https://huggingface.co/spaces/modelscope/modelscope-studio">Hugging Face Space</a>
 <br>
-  <a href="README-zh_CN.md">中文</a>&nbsp ｜ &nbspEnglish
+  <a href="README-zh_CN.md">中文</a>&nbsp ｜ &nbspEnglish&nbsp ｜ &nbsp<a href="README-ja_JP.md">日本語</a>
 </p>
 
 `modelscope_studio` is a set of extension component libraries based on gradio 4.x, dedicated to serving the various extension needs of gradio applications within the ModelScope Studio. It mainly focuses on enhancing conversational scenarios, supporting multimodal contexts, and providing assistance for various other specialized scenarios.