Skip to content

Update README.md #558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 24 commits into from
May 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .github/workflows/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Generate TOC
on:
push:
paths:
- 'README.md'
- 'README_ZH.md'
- 'README_JA.md'
branches-ignore:
- 'main'

jobs:
generateTOC:
name: TOC Generator
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2

- uses: technote-space/toc-generator@v4
with:
TOC_TITLE: "## 📑 Table of Contents"
CREATE_PR: false
TARGET_PATHS: "README.md,README_ZH.md,README_JA.md"
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
TOC_TITLE_MAP: |
README.md: ## 📑 Table of Contents
README_ZH.md: ## 📑 目录
README_JA.md: ## 📑 目次
701 changes: 397 additions & 304 deletions README.md

Large diffs are not rendered by default.

646 changes: 380 additions & 266 deletions README_JA.md

Large diffs are not rendered by default.

649 changes: 383 additions & 266 deletions README_ZH.md

Large diffs are not rendered by default.

14 changes: 10 additions & 4 deletions docs/ROADMAP.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Roadmap

---

## Long-term Goals

Offering **agent-oriented programming (AOP)** as a new programming model to organize the design and implementation of next-generation LLM-empowered applications.
Expand All @@ -12,14 +10,15 @@ Offering **agent-oriented programming (AOP)** as a new programming model to orga
2. Support tools API.
3. Refactor the current AgentScope studio, including Dashboard and Workstation.
4. Improve the current RAG module.
5. Re-factor the `AgentBase` class to support more flexible serialization.

## Task

1. Documentation

- 🚧 Re-write the tutorial.
- Re-write the tutorial.
- 📝 Correct the typographical errors in API documents.
- 📝 Refine the README.md.
- 🚧 Refine the README.md.

2. Tools Calling

Expand Down Expand Up @@ -61,3 +60,10 @@ Offering **agent-oriented programming (AOP)** as a new programming model to orga
- 🚧 Provide a set of query rewrite strategies for retrieval.
- ✅ Support online search engine (Google/Bing search) based RAG.
- 🚧 Support multi-RAG agent routing efficiently.

5. AgentBase

- 🚧 Decouple the data and service layer of the `MemoryBase` class to support more customized implementations.
- 📝 Provide a new base class `Serializable` to
- support automatic serialization/deserialization of agents.
- support state registration
10 changes: 10 additions & 0 deletions docs/news_en.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@

# News

- **[2024-12-12]** We have updated the [roadmap of AgentScope](https://github.com/modelscope/agentscope/blob/main/docs/ROADMAP.md).

- **[2024-09-06]** AgentScope version 0.1.0 is released now.

- **[2024-09-03]** AgentScope supports **Web Browser Control** now! Refer to our [example](https://github.com/modelscope/agentscope/tree/main/examples/conversation_with_web_browser_agent) for more details.

<h5 align="left">
<video src="https://github.com/user-attachments/assets/6d03caab-6193-4ac6-8b1c-36f152ec02ec" width="45%" alt="web browser control" controls></video>
</h5>

- **[2024-07-18]** AgentScope supports streaming mode now! Refer to our [tutorial](https://doc.agentscope.io/build_tutorial/streaming.html) and example [conversation in stream mode](https://github.com/modelscope/agentscope/tree/main/examples/conversation_in_stream_mode) for more details.

<h5 align="left">
Expand Down
4 changes: 1 addition & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,8 @@
"requests",
"inputimeout",
"numpy",
"Flask==3.0.0",
"Flask-Cors==4.0.0",
"Flask-SocketIO==5.3.6",
"flask_sqlalchemy",
"python-socketio",
"flake8",
"psutil",
"shortuuid",
Expand Down
6 changes: 0 additions & 6 deletions src/agentscope/constants.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,3 @@ class ShrinkPolicy(IntEnum):
DEFAULT_CHUNK_SIZE = 1024
DEFAULT_CHUNK_OVERLAP = 20
DEFAULT_TOP_K = 5

# flask server
EXPIRATION_SECONDS = 604800 # One week
TOKEN_EXP_TIME = 1440 # One day long
FILE_SIZE_LIMIT = 1024 * 1024 # 10 MB
FILE_COUNT_LIMIT = 10
2 changes: 1 addition & 1 deletion src/agentscope/models/openai_model.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ def __init__(
self.max_length = get_openai_max_length(self.model_name)
except Exception as e:
logger.warning(
f"fail to get max_length for {self.model_name}: " f"{e}",
f"Fail to get max_length for {self.model_name}: " f"{e}",
)
self.max_length = None

Expand Down