modified accordingly

modelscope · Mar 18, 2024 · be90d6d · be90d6d
1 parent bb44b72
commit be90d6d
Show file tree

Hide file tree

Showing 4 changed files with 64 additions and 64 deletions.
diff --git a/README.md b/README.md
@@ -28,7 +28,7 @@ Welcome to join our community on
 ## News
 - ![new](https://img.alicdn.com/imgextra/i4/O1CN01kUiDtl1HVxN6G56vN_!!6000000000764-2-tps-43-19.png)
 [2024-03-15] We release **AgentScope** v0.0.2 now! In this new version,
-AgentScope supports [DashScope](), [ollama]() and [Gemini]() APIs.
+AgentScope supports [DashScope](https://modelscope.github.io/agentscope/en/tutorial/203-model.html#supported-models), [ollama](https://modelscope.github.io/agentscope/en/tutorial/203-model.html#supported-models) and [Gemini](https://modelscope.github.io/agentscope/en/tutorial/203-model.html#supported-models) APIs.
 
 - ![new](https://img.alicdn.com/imgextra/i4/O1CN01kUiDtl1HVxN6G56vN_!!6000000000764-2-tps-43-19.png)
 [2024-03-15] The [Chinese tutorial](https://modelscope.github.io/agentscope/zh_CN/index.html) of AgentScope is online now!
@@ -46,7 +46,7 @@ AgentScope is an innovative multi-agent platform designed to empower developers
 to build multi-agent applications with large-scale models.
 It features three high-level capabilities:
 
-- 🤝 **Easy-to-Use**: Designed for developers, with [fruitful components](),
+- 🤝 **Easy-to-Use**: Designed for developers, with [fruitful components](https://modelscope.github.io/agentscope/en/tutorial/204-service.html#),
 [comprehensive documentation](https://modelscope.github.io/agentscope/en/index.html), and broad compatibility.
 
 - ✅ **High Robustness**: Supporting customized fault-tolerance controls and
@@ -60,32 +60,32 @@ applications in a centralized programming manner for streamlined development.
 AgentScope provides a list of `ModelWrapper` to support both local model
 services and third-party model APIs.
 
-| API                    | Task            | Model Wrapper                    |
-|------------------------|-----------------|----------------------------------|
-| ollama                 | Chat            | `OllamaChatWrapper`              |
-|                        | Embedding       | `OllamaEmbedding`                |
-|                        | Generation      | `OllamaGenerationWrapper`        |
-| OpenAI API             | Chat            | `OpenAIChatWrapper`              |
-|                        | Embedding       | `OpenAIEmbeddingWrapper`         |
-|                        | DALL·E          | `OpenAIDALLEWrapper`             |
-| Gemini API             | Chat            | `GeminiChatWrapper`              |
-|                        | Embedding       | `GeminiEmbeddingWrapper`         |
-| DashScope API          | Chat            | `DashScopeChatWrapper`           |
-|                        | Image Synthesis | `DashScopeImageSynthesisWrapper` |
-|                        | Text Embedding  | `DashScopeTextEmbeddingWrapper`  |
-| Post Request based API | -               | `PostAPIModelWrapper`            |
+| API                    | Task            | Model Wrapper                                                                                                                   |
+|------------------------|-----------------|---------------------------------------------------------------------------------------------------------------------------------|
+| OpenAI API             | Chat            | [`OpenAIChatWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/openai_model.py)                 |
+|                        | Embedding       | [`OpenAIEmbeddingWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/openai_model.py)            |
+|                        | DALL·E          | [`OpenAIDALLEWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/openai_model.py)                |
+| DashScope API          | Chat            | [`DashScopeChatWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/dashscope_model.py)           |
+|                        | Image Synthesis | [`DashScopeImageSynthesisWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/dashscope_model.py) |
+|                        | Text Embedding  | [`DashScopeTextEmbeddingWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/dashscope_model.py)  |
+| Gemini API             | Chat            | [`GeminiChatWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/gemini_model.py)                 |
+|                        | Embedding       | [`GeminiEmbeddingWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/gemini_model.py)            |
+| ollama                 | Chat            | [`OllamaChatWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/ollama_model.py)                 |
+|                        | Embedding       | [`OllamaEmbedding`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/ollama_model.py)                   |
+|                        | Generation      | [`OllamaGenerationWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/ollama_model.py)           |
+| Post Request based API | -               | [`PostAPIModelWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/post_model.py)                 |
 
 
 **Supported Local Model Deployment**
 
 AgentScope enables developers to rapidly deploy local model services using
 the following libraries.
 
-- [ollama (CPU inference)]()
-- [Flask + Transformers]()
-- [Flask + ModelScope]()
-- [FastChat]()
-- [vllm]()
+- [ollama (CPU inference)](https://github.com/modelscope/agentscope/blob/main/scripts/README.md#ollama)
+- [Flask + Transformers](https://github.com/modelscope/agentscope/blob/main/scripts/README.md#with-transformers-library)
+- [Flask + ModelScope](https://github.com/modelscope/agentscope/blob/main/scripts/README.md#with-modelscope-library)
+- [FastChat](https://github.com/modelscope/agentscope/blob/main/scripts/README.md#fastchat)
+- [vllm](https://github.com/modelscope/agentscope/blob/main/scripts/README.md#vllm)
 
 
 **Supported Services**

diff --git a/README_ZH.md b/README_ZH.md
@@ -25,7 +25,7 @@
 ## 新闻
 
 - ![new](https://img.alicdn.com/imgextra/i4/O1CN01kUiDtl1HVxN6G56vN_!!6000000000764-2-tps-43-19.png)
-[2024-03-15] 我们现在发布了**AgentScope** v0.0.2版本！在这个新版本中，AgentScope支持了[DashScope](), [ollama]() 和 [Gemini]() APIs。
+[2024-03-15] 我们现在发布了**AgentScope** v0.0.2版本！在这个新版本中，AgentScope支持了[DashScope](https://modelscope.github.io/agentscope/en/tutorial/203-model.html#supported-models), [ollama](https://modelscope.github.io/agentscope/en/tutorial/203-model.html#supported-models) 和 [Gemini](https://modelscope.github.io/agentscope/en/tutorial/203-model.html#supported-models) APIs。
 
 - ![new](https://img.alicdn.com/imgextra/i4/O1CN01kUiDtl1HVxN6G56vN_!!6000000000764-2-tps-43-19.png)
 [2024-03-15] AgentScope的[中文教程](https://modelscope.github.io/agentscope/zh_CN/index.html)上线了！
@@ -42,7 +42,7 @@ Multi-Agent Platform"](https://arxiv.org/abs/2402.14034)!
 
 AgentScope是一个创新的多智能体开发平台，旨在赋予开发人员使用大模型轻松构建多智能体应用的能力。
 
-- 🤝 **高易用**： AgentScope专为开发人员设计，提供了[丰富的组件](), [全面的文档](https://modelscope.github.io/agentscope/zh_CN/index.html)和广泛的兼容性。
+- 🤝 **高易用**： AgentScope专为开发人员设计，提供了[丰富的组件](https://modelscope.github.io/agentscope/en/tutorial/204-service.html#), [全面的文档](https://modelscope.github.io/agentscope/zh_CN/index.html)和广泛的兼容性。
 
 - ✅ **高鲁棒**：支持自定义的容错控制和重试机制，以提高应用程序的稳定性。
 
@@ -53,30 +53,30 @@ AgentScope是一个创新的多智能体开发平台，旨在赋予开发人员
 
 AgentScope提供了一系列`ModelWrapper`来支持本地模型服务和第三方模型API。
 
-| API                    | Task            | Model Wrapper                    |
-|------------------------|-----------------|----------------------------------|
-| ollama                 | Chat            | `OllamaChatWrapper`              |
-|                        | Embedding       | `OllamaEmbedding`                |
-|                        | Generation      | `OllamaGenerationWrapper`        |
-| OpenAI API             | Chat            | `OpenAIChatWrapper`              |
-|                        | Embedding       | `OpenAIEmbeddingWrapper`         |
-|                        | DALL·E          | `OpenAIDALLEWrapper`             |
-| Gemini API             | Chat            | `GeminiChatWrapper`              |
-|                        | Embedding       | `GeminiEmbeddingWrapper`         |
-| DashScope API          | Chat            | `DashScopeChatWrapper`           |
-|                        | Image Synthesis | `DashScopeImageSynthesisWrapper` |
-|                        | Text Embedding  | `DashScopeTextEmbeddingWrapper`  |
-| Post Request based API | -               | `PostAPIModelWrapper`            |
+| API                    | Task            | Model Wrapper                                                                                                                   |
+|------------------------|-----------------|---------------------------------------------------------------------------------------------------------------------------------|
+| OpenAI API             | Chat            | [`OpenAIChatWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/openai_model.py)                 |
+|                        | Embedding       | [`OpenAIEmbeddingWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/openai_model.py)            |
+|                        | DALL·E          | [`OpenAIDALLEWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/openai_model.py)                |
+| DashScope API          | Chat            | [`DashScopeChatWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/dashscope_model.py)           |
+|                        | Image Synthesis | [`DashScopeImageSynthesisWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/dashscope_model.py) |
+|                        | Text Embedding  | [`DashScopeTextEmbeddingWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/dashscope_model.py)  |
+| Gemini API             | Chat            | [`GeminiChatWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/gemini_model.py)                 |
+|                        | Embedding       | [`GeminiEmbeddingWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/gemini_model.py)            |
+| ollama                 | Chat            | [`OllamaChatWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/ollama_model.py)                 |
+|                        | Embedding       | [`OllamaEmbedding`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/ollama_model.py)                   |
+|                        | Generation      | [`OllamaGenerationWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/ollama_model.py)           |
+| Post Request based API | -               | [`PostAPIModelWrapper`](https://github.com/modelscope/agentscope/blob/main/src/agentscope/models/post_model.py)                 |
 
 **支持的本地模型部署**
 
 AgentScope支持使用以下库快速部署本地模型服务。
 
-- [ollama (CPU inference)]()
-- [Flask + Transformers]()
-- [Flask + ModelScope]()
-- [FastChat]()
-- [vllm]()
+- [ollama (CPU inference)](https://github.com/modelscope/agentscope/blob/main/scripts/README.md#ollama)
+- [Flask + Transformers](https://github.com/modelscope/agentscope/blob/main/scripts/README.md#with-transformers-library)
+- [Flask + ModelScope](https://github.com/modelscope/agentscope/blob/main/scripts/README.md#with-modelscope-library)
+- [FastChat](https://github.com/modelscope/agentscope/blob/main/scripts/README.md#fastchat)
+- [vllm](https://github.com/modelscope/agentscope/blob/main/scripts/README.md#vllm)
 
 **支持的服务**
 

diff --git a/docs/sphinx_doc/en/source/tutorial/203-model.md b/docs/sphinx_doc/en/source/tutorial/203-model.md
@@ -350,7 +350,7 @@ openai_chat_config = {
     "model_type": "post_api",
 
     # Required parameters
-    "api_url": "https://xxx.com",
+    "api_url": "https://xxx.xxx",
     "headers": {
         # e.g. "Authorization": "Bearer xxx",
     },

diff --git a/docs/sphinx_doc/zh_CN/source/tutorial_zh/203-model.md b/docs/sphinx_doc/zh_CN/source/tutorial_zh/203-model.md
@@ -128,12 +128,12 @@ openai_chat_config = {
     "api_key": "{your_api_key}",                # OpenAI API Key，如果没有提供，将从环境变量中读取
     "organization": "{your_organization}",      # Organization name，如果没有提供，将从环境变量中读取
     "client_args": {                            # 用于初始化OpenAI API Client的参数
-        # e.g. "max_retries": 3,
+        # 例如："max_retries": 3,
     },
     "generate_args": {                          # 模型API接口被调用时传入的参数
-        # e.g. "temperature": 0.0
+        # 例如："temperature": 0.0
     },
-    "budget": 100                               # API budget
+    "budget": 100                               # API费用预算
 }
 ```
 
@@ -148,16 +148,16 @@ openai_chat_config = {
     "model_type": "openai_dall_e",
 
     # 必要参数
-    "model_name": "{model_name}",               # OpenAI model name, e.g. dall-e-2, dall-e-3
+    "model_name": "{model_name}",               # OpenAI model name, 例如：dall-e-2, dall-e-3
 
     # 可选参数
     "api_key": "{your_api_key}",                # OpenAI API Key，如果没有提供，将从环境变量中读取
     "organization": "{your_organization}",      # Organization name，如果没有提供，将从环境变量中读取
     "client_args": {                            # 用于初始化OpenAI API Client的参数
-        # e.g. "max_retries": 3,
+        # 例如："max_retries": 3,
     },
     "generate_args": {                          # 模型API接口被调用时传入的参数
-        # e.g. "n": 1, "size": "512x512"
+        # 例如："n": 1, "size": "512x512"
     }
 }
 ```
@@ -173,16 +173,16 @@ openai_chat_config = {
     "model_type": "openai_embedding",
 
     # 必要参数
-    "model_name": "{model_name}",               # OpenAI model name, e.g. text-embedding-ada-002, text-embedding-3-small
+    "model_name": "{model_name}",               # OpenAI model name, 例如：text-embedding-ada-002, text-embedding-3-small
 
     # 可选参数
     "api_key": "{your_api_key}",                # OpenAI API Key，如果没有提供，将从环境变量中读取
     "organization": "{your_organization}",      # Organization name，如果没有提供，将从环境变量中读取
     "client_args": {                            # 用于初始化OpenAI API Client的参数
-        # e.g. "max_retries": 3,
+        # 例如："max_retries": 3,
     },
     "generate_args": {                          # 模型API接口被调用时传入的参数
-        # e.g. "encoding_format": "float"
+        # 例如："encoding_format": "float"
     }
 }
 ```
@@ -200,12 +200,12 @@ openai_chat_config = {
     "model_type": "dashscope_chat",
 
     # 必要参数
-    "model_name": "{model_name}",               # DashScope Chat API中的模型名， e.g. qwen-max
+    "model_name": "{model_name}",               # DashScope Chat API中的模型名， 例如：qwen-max
 
     # 可选参数
     "api_key": "{your_api_key}",                # DashScope API Key，如果没有提供，将从环境变量中读取
     "generate_args": {
-        # e.g. "temperature": 0.5
+        # 例如："temperature": 0.5
     },
 }
 ```
@@ -221,7 +221,7 @@ openai_chat_config = {
     "model_type": "dashscope_image_synthesis",
 
     # 必要参数
-    "model_name": "{model_name}",               # DashScope Image Synthesis API中的模型名， e.g. wanx-v1
+    "model_name": "{model_name}",               # DashScope Image Synthesis API中的模型名， 例如：wanx-v1
 
     # 可选参数
     "api_key": "{your_api_key}",
@@ -244,7 +244,7 @@ openai_chat_config = {
     "model_type": "dashscope_text_embedding",
 
     # 必要参数
-    "model_name": "{model_name}",               # DashScope Text Embedding API中的模型名, e.g. text-embedding-v1
+    "model_name": "{model_name}",               # DashScope Text Embedding API中的模型名, 例如：text-embedding-v1
 
     # 可选参数
     "api_key": "{your_api_key}",
@@ -267,7 +267,7 @@ openai_chat_config = {
     "model_type": "gemini_chat",
 
     # 必要参数
-    "model_name": "{model_name}",               # Gemini Chat API中的模型名，e.g. gemini-prp
+    "model_name": "{model_name}",               # Gemini Chat API中的模型名，例如：gemini-prp
 
     # 可选参数
     "api_key": "{your_api_key}",                # 如果没有提供，将从环境变量GEMINI_API_KEY中读取
@@ -285,7 +285,7 @@ openai_chat_config = {
     "model_type": "gemini_embedding",
 
     # 必要参数
-    "model_name": "{model_name}",               # Gemini Embedding API中的模型名，e.g. gemini-prp
+    "model_name": "{model_name}",               # Gemini Embedding API中的模型名，例如：gemini-prp
 
     # 可选参数
     "api_key": "{your_api_key}",                # 如果没有提供，将从环境变量GEMINI_API_KEY中读取
@@ -305,11 +305,11 @@ openai_chat_config = {
     "model_type": "ollama_chat",
 
     # 必要参数
-    "model": "{model_name}",                    # ollama Chat API中的模型名, e.g. llama2
+    "model": "{model_name}",                    # ollama Chat API中的模型名, 例如：llama2
 
     # 可选参数
     "options": {                                # 模型API接口被调用时传入的参数
-        # e.g. "temperature": 0., "seed": "123",
+        # 例如："temperature": 0., "seed": "123",
     },
     "keep_alive": "5m",                         # 控制一次调用后模型在内存中的存活时间
 }
@@ -326,7 +326,7 @@ openai_chat_config = {
     "model_type": "ollama_generate",
 
     # 必要参数
-    "model": "{model_name}",                    # ollama Generate API, e.g. llama2
+    "model": "{model_name}",                    # ollama Generate API, 例如：llama2
 
     # 可选参数
     "options": {                                # 模型API接口被调用时传入的参数
@@ -347,7 +347,7 @@ openai_chat_config = {
     "model_type": "ollama_embedding",
 
     # 必要参数
-    "model": "{model_name}",                    # ollama Embedding API, e.g. llama2
+    "model": "{model_name}",                    # ollama Embedding API, 例如：llama2
 
     # 可选参数
     "options": {                                # 模型API接口被调用时传入的参数
@@ -370,9 +370,9 @@ openai_chat_config = {
     "model_type": "post_api",
 
     # 必要参数
-    "api_url": "https://xxx.com",
+    "api_url": "https://xxx.xxx",
     "headers": {
-        # e.g. "Authorization": "Bearer xxx",
+        # 例如："Authorization": "Bearer xxx",
     },
 
     # 可选参数