Merge branch 'update_README' of github.com:ZiTao-Li/agentscope into z…

…t/update_readme

docs/sphinx_doc/en/source/tutorial/203-model.md

@@ -381,11 +381,11 @@ directory.
 
 Specifically, AgentScope provides the following model service scripts:
 
-- CPU inference engine **ollama**
-- Model service based on **Flask + HuggingFace**
-- Model service based on **Flask + ModelScope**
-- **FastChat** inference engine
-- **vllm** inference engine
+- [CPU inference engine **ollama**](https://github.com/modelscope/agentscope/blob/main/scripts/README.md#ollama)
+- [Model service based on **Flask + Transformers**](https://github.com/modelscope/agentscope/blob/main/scripts/README.md#with-transformers-library)
+- [Model service based on **Flask + ModelScope**](https://github.com/modelscope/agentscope/blob/main/scripts/README.md#with-modelscope-library)
+- [**FastChat** inference engine](https://github.com/modelscope/agentscope/blob/main/scripts/README.md#fastchat)
+- [**vllm** inference engine](https://github.com/modelscope/agentscope/blob/main/scripts/README.md#vllm)
 
 About how to quickly start these model services, users can refer to the [README.md](https://github.com/modelscope/agentscope/blob/main/scripts/README.md) file under the [scripts](https://github.com/modelscope/agentscope/blob/main/scripts/) directory.
 
@@ -396,7 +396,7 @@ The new model wrapper class should
 - inherit from `ModelWrapperBase` class,
 - provide a `model_type` field to identify this model wrapper in the model configuration, and
 - implement its `__init__` and `__call__` functions.
--
+
 The following is an example for creating a new model wrapper class.
 
 ```python
@@ -406,8 +406,9 @@ class MyModelWrapper(ModelWrapperBase):
 
     model_type: str = "my_model"
 
-    def __init__(self, my_arg1, my_arg2, **kwargs):
+    def __init__(self, config_name, my_arg1, my_arg2, **kwargs):
         # Initialize the model instance
+        super().__init__(config_name=config_name)
         # ...
 
     def __call__(self, input, **kwargs) -> str:

docs/sphinx_doc/en/source/tutorial/main.md

@@ -12,24 +12,24 @@ AgentScope is an innovative multi-agent platform designed to empower developers
 
 ### Getting Started
 
-- [Installation Guide](102-installation-en)
-- [Fundamental Concepts](101-agentscope-en)
-- [Getting Started with a Simple Example](103-start-en)
+- [About AgentScope](101-agentscope-en)
+- [Installation](102-installation-en)
+- [Quick Start](103-start-en)
 - [Crafting Your First Application](104-usecase-en)
 - [Logging and WebUI](105-logging-en)
 
 ### Advanced Exploration
 
 - [Customizing Your Own Agent](201-agent-en)
-- [Agent Interactions: Dive deeper into Pipelines and Message Hub](202-pipeline-en)
-- [Using Different Model Sources with Model API](203-model-en)
-- [Enhancing Agent Capabilities with Service Functions](204-service-en)
-- [Memory and Message Management](205-memory-en)
+- [Pipeline and MsgHub](202-pipeline-en)
+- [Model](203-model-en)
+- [Service](204-service-en)
+- [Memory](205-memory-en)
 - [Prompt Engine](206-prompt-en)
-- [Monitoring](207-monitor-en)
-- [Distributed Deployment](208-distribute-en)
+- [Monitor](207-monitor-en)
+- [Distribution](208-distribute-en)
 
 ### Getting Involved
 
-- [Joining The AgentScope Community](301-community-en)
-- [Contributing to AgentScope](302-contribute-en)
+- [Joining AgentScope Community](301-community-en)
+- [Contribute to AgentScope](302-contribute-en)

docs/sphinx_doc/en/source/tutorial/quick_start.rst

@@ -4,8 +4,8 @@ Getting Started
 .. toctree::
    :maxdepth: 2
 
-   102-installation.md
    101-agentscope.md
+   102-installation.md
    103-example.md
    104-usecase.md
    105-logging.md

docs/sphinx_doc/zh_CN/source/tutorial/203-model.md

@@ -398,11 +398,11 @@ openai_chat_config = {
 
 具体而言，AgentScope提供了以下模型服务的脚本：
 
-- CPU推理引擎ollama
-- 基于Flask + HuggingFace的模型服务
-- 基于Flask + ModelScope的模型服务
-- FastChat推理引擎
-- vllm推理引擎
+- [CPU推理引擎ollama](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)
 
 关于如何快速启动这些模型服务，用户可以参考[scripts](https://github.com/modelscope/agentscope/blob/main/scripts/)目录下的[README.md](https://github.com/modelscope/agentscope/blob/main/scripts/README.md)文件。
 
@@ -420,8 +420,9 @@ class MyModelWrapper(ModelWrapperBase):
 
     model_type: str = "my_model"
 
-    def __init__(self, my_arg1, my_arg2, **kwargs):
+    def __init__(self, config_name, my_arg1, my_arg2, **kwargs):
         # 初始化模型实例
+        super().__init__(config_name=config_name)
         # ...
 
     def __call__(self, input, **kwargs) -> str:

docs/sphinx_doc/zh_CN/source/tutorial/main.md

@@ -12,24 +12,24 @@ AgentScope是一款全新的Multi-Agent框架，专为应用开发者打造，
 
 ### 快速上手
 
+- [关于AgentScope](101-agentscope-zh)
 - [安装](102-installation-zh)
-- [基础概念](101-agentscope-zh)
-- [快速上手案例](103-example-zh)
-- [创建您的第一个应用](104-usecase-zh)
+- [快速开始](103-example-zh)
+- [创造您的第一个应用](104-usecase-zh)
 - [日志和WebUI](105-logging-zh)
 
 ### 进阶使用
 
-- [定制自己的Agent](201-agent-zh)
-- [智能体间交互](202-pipeline-zh)
-- [关于模型](203-model-zh)
-- [关于服务](204-service-zh)
-- [关于记忆](205-memory-zh)
+- [定制你自己的Agent](201-agent-zh)
+- [Pipeline和MsgHub](202-pipeline-zh)
+- [模型](203-model-zh)
+- [服务函数](204-service-zh)
+- [记忆](205-memory-zh)
 - [提示工程](206-prompt-zh)
 - [监控器](207-monitor-zh)
-- [关于分布式](208-distribute-zh)
+- [分布式](208-distribute-zh)
 
 ### 参与贡献
 
-- [加入 AgentScope 社区](301-community-zh)
-- [为 AgentScope 做贡献](302-contribute-zh)
+- [加入AgentScope社区](301-community-zh)
+- [贡献到AgentScope](302-contribute-zh)

docs/sphinx_doc/zh_CN/source/tutorial/quick_start.rst

@@ -4,8 +4,8 @@
 .. toctree::
    :maxdepth: 2
 
-   102-installation.md
    101-agentscope.md
+   102-installation.md
    103-example.md
    104-usecase.md
    105-logging.md