Skip to content

Commit 87a29c8

Browse files
lightislostlightislost
committed
add new muagent content
1 parent 522ce56 commit 87a29c8

File tree

712 files changed

+27041
-21
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

712 files changed

+27041
-21
lines changed

‎LEGAL.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Legal Disclaimer
2+
3+
Within this source code, the comments in Chinese shall be the original, governing version. Any comment in other languages are for reference only. In the event of any conflict between the Chinese language version comments and other language version comments, the Chinese language version shall prevail.
4+
5+
法律免责声明
6+
7+
关于代码注释部分，中文注释为官方版本，其它语言注释仅做参考。中文注释可能与其它语言注释存在不一致，当中文注释与其它语言注释存在不一致时，请以中文注释为准。

‎LICENSE

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎LICENSE.md

Lines changed: 214 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,214 @@
1+
Copyright [2023] [Ant Group]
2+
Licensed under the Apache License, Version 2.0 (the "License");
3+
you may not use this file except in compliance with the License.
4+
You may obtain a copy of the License at
5+
http://www.apache.org/licenses/LICENSE-2.0
6+
7+
Unless required by applicable law or agreed to in writing, software
8+
distributed under the License is distributed on an "AS IS" BASIS,
9+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10+
See the License for the specific language governing permissions and
11+
limitations under the License.
12+
13+
14+
Apache License
15+
Version 2.0, January 2004
16+
http://www.apache.org/licenses/
17+
18+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
19+
20+
1. Definitions.
21+
22+
"License" shall mean the terms and conditions for use, reproduction,
23+
and distribution as defined by Sections 1 through 9 of this document.
24+
25+
"Licensor" shall mean the copyright owner or entity authorized by
26+
the copyright owner that is granting the License.
27+
28+
"Legal Entity" shall mean the union of the acting entity and all
29+
other entities that control, are controlled by, or are under common
30+
control with that entity. For the purposes of this definition,
31+
"control" means (i) the power, direct or indirect, to cause the
32+
direction or management of such entity, whether by contract or
33+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
34+
outstanding shares, or (iii) beneficial ownership of such entity.
35+
36+
"You" (or "Your") shall mean an individual or Legal Entity
37+
exercising permissions granted by this License.
38+
39+
"Source" form shall mean the preferred form for making modifications,
40+
including but not limited to software source code, documentation
41+
source, and configuration files.
42+
43+
"Object" form shall mean any form resulting from mechanical
44+
transformation or translation of a Source form, including but
45+
not limited to compiled object code, generated documentation,
46+
and conversions to other media types.
47+
48+
"Work" shall mean the work of authorship, whether in Source or
49+
Object form, made available under the License, as indicated by a
50+
copyright notice that is included in or attached to the work
51+
(an example is provided in the Appendix below).
52+
53+
"Derivative Works" shall mean any work, whether in Source or Object
54+
form, that is based on (or derived from) the Work and for which the
55+
editorial revisions, annotations, elaborations, or other modifications
56+
represent, as a whole, an original work of authorship. For the purposes
57+
of this License, Derivative Works shall not include works that remain
58+
separable from, or merely link (or bind by name) to the interfaces of,
59+
the Work and Derivative Works thereof.
60+
61+
"Contribution" shall mean any work of authorship, including
62+
the original version of the Work and any modifications or additions
63+
to that Work or Derivative Works thereof, that is intentionally
64+
submitted to Licensor for inclusion in the Work by the copyright owner
65+
or by an individual or Legal Entity authorized to submit on behalf of
66+
the copyright owner. For the purposes of this definition, "submitted"
67+
means any form of electronic, verbal, or written communication sent
68+
to the Licensor or its representatives, including but not limited to
69+
communication on electronic mailing lists, source code control systems,
70+
and issue tracking systems that are managed by, or on behalf of, the
71+
Licensor for the purpose of discussing and improving the Work, but
72+
excluding communication that is conspicuously marked or otherwise
73+
designated in writing by the copyright owner as "Not a Contribution."
74+
75+
"Contributor" shall mean Licensor and any individual or Legal Entity
76+
on behalf of whom a Contribution has been received by Licensor and
77+
subsequently incorporated within the Work.
78+
79+
2. Grant of Copyright License. Subject to the terms and conditions of
80+
this License, each Contributor hereby grants to You a perpetual,
81+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
82+
copyright license to reproduce, prepare Derivative Works of,
83+
publicly display, publicly perform, sublicense, and distribute the
84+
Work and such Derivative Works in Source or Object form.
85+
86+
3. Grant of Patent License. Subject to the terms and conditions of
87+
this License, each Contributor hereby grants to You a perpetual,
88+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
89+
(except as stated in this section) patent license to make, have made,
90+
use, offer to sell, sell, import, and otherwise transfer the Work,
91+
where such license applies only to those patent claims licensable
92+
by such Contributor that are necessarily infringed by their
93+
Contribution(s) alone or by combination of their Contribution(s)
94+
with the Work to which such Contribution(s) was submitted. If You
95+
institute patent litigation against any entity (including a
96+
cross-claim or counterclaim in a lawsuit) alleging that the Work
97+
or a Contribution incorporated within the Work constitutes direct
98+
or contributory patent infringement, then any patent licenses
99+
granted to You under this License for that Work shall terminate
100+
as of the date such litigation is filed.
101+
102+
4. Redistribution. You may reproduce and distribute copies of the
103+
Work or Derivative Works thereof in any medium, with or without
104+
modifications, and in Source or Object form, provided that You
105+
meet the following conditions:
106+
107+
(a) You must give any other recipients of the Work or
108+
Derivative Works a copy of this License; and
109+
110+
(b) You must cause any modified files to carry prominent notices
111+
stating that You changed the files; and
112+
113+
(c) You must retain, in the Source form of any Derivative Works
114+
that You distribute, all copyright, patent, trademark, and
115+
attribution notices from the Source form of the Work,
116+
excluding those notices that do not pertain to any part of
117+
the Derivative Works; and
118+
119+
(d) If the Work includes a "NOTICE" text file as part of its
120+
distribution, then any Derivative Works that You distribute must
121+
include a readable copy of the attribution notices contained
122+
within such NOTICE file, excluding those notices that do not
123+
pertain to any part of the Derivative Works, in at least one
124+
of the following places: within a NOTICE text file distributed
125+
as part of the Derivative Works; within the Source form or
126+
documentation, if provided along with the Derivative Works; or,
127+
within a display generated by the Derivative Works, if and
128+
wherever such third-party notices normally appear. The contents
129+
of the NOTICE file are for informational purposes only and
130+
do not modify the License. You may add Your own attribution
131+
notices within Derivative Works that You distribute, alongside
132+
or as an addendum to the NOTICE text from the Work, provided
133+
that such additional attribution notices cannot be construed
134+
as modifying the License.
135+
136+
You may add Your own copyright statement to Your modifications and
137+
may provide additional or different license terms and conditions
138+
for use, reproduction, or distribution of Your modifications, or
139+
for any such Derivative Works as a whole, provided Your use,
140+
reproduction, and distribution of the Work otherwise complies with
141+
the conditions stated in this License.
142+
143+
5. Submission of Contributions. Unless You explicitly state otherwise,
144+
any Contribution intentionally submitted for inclusion in the Work
145+
by You to the Licensor shall be under the terms and conditions of
146+
this License, without any additional terms or conditions.
147+
Notwithstanding the above, nothing herein shall supersede or modify
148+
the terms of any separate license agreement you may have executed
149+
with Licensor regarding such Contributions.
150+
151+
6. Trademarks. This License does not grant permission to use the trade
152+
names, trademarks, service marks, or product names of the Licensor,
153+
except as required for reasonable and customary use in describing the
154+
origin of the Work and reproducing the content of the NOTICE file.
155+
156+
7. Disclaimer of Warranty. Unless required by applicable law or
157+
agreed to in writing, Licensor provides the Work (and each
158+
Contributor provides its Contributions) on an "AS IS" BASIS,
159+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
160+
implied, including, without limitation, any warranties or conditions
161+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
162+
PARTICULAR PURPOSE. You are solely responsible for determining the
163+
appropriateness of using or redistributing the Work and assume any
164+
risks associated with Your exercise of permissions under this License.
165+
166+
8. Limitation of Liability. In no event and under no legal theory,
167+
whether in tort (including negligence), contract, or otherwise,
168+
unless required by applicable law (such as deliberate and grossly
169+
negligent acts) or agreed to in writing, shall any Contributor be
170+
liable to You for damages, including any direct, indirect, special,
171+
incidental, or consequential damages of any character arising as a
172+
result of this License or out of the use or inability to use the
173+
Work (including but not limited to damages for loss of goodwill,
174+
work stoppage, computer failure or malfunction, or any and all
175+
other commercial damages or losses), even if such Contributor
176+
has been advised of the possibility of such damages.
177+
178+
9. Accepting Warranty or Additional Liability. While redistributing
179+
the Work or Derivative Works thereof, You may choose to offer,
180+
and charge a fee for, acceptance of support, warranty, indemnity,
181+
or other liability obligations and/or rights consistent with this
182+
License. However, in accepting such obligations, You may act only
183+
on Your own behalf and on Your sole responsibility, not on behalf
184+
of any other Contributor, and only if You agree to indemnify,
185+
defend, and hold each Contributor harmless for any liability
186+
incurred by, or claims asserted against, such Contributor by reason
187+
of your accepting any such warranty or additional liability.
188+
189+
END OF TERMS AND CONDITIONS
190+
191+
APPENDIX: How to apply the Apache License to your work.
192+
193+
To apply the Apache License to your work, attach the following
194+
boilerplate notice, with the fields enclosed by brackets "[]"
195+
replaced with your own identifying information. (Don't include
196+
the brackets!) The text should be enclosed in the appropriate
197+
comment syntax for the file format. We also recommend that a
198+
file or class name and description of purpose be included on the
199+
same "printed page" as the copyright notice for easier
200+
identification within third-party archives.
201+
202+
Copyright [yyyy] [name of copyright owner]
203+
204+
Licensed under the Apache License, Version 2.0 (the "License");
205+
you may not use this file except in compliance with the License.
206+
You may obtain a copy of the License at
207+
208+
http://www.apache.org/licenses/LICENSE-2.0
209+
210+
Unless required by applicable law or agreed to in writing, software
211+
distributed under the License is distributed on an "AS IS" BASIS,
212+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
213+
See the License for the specific language governing permissions and
214+
limitations under the License.

‎README.md

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
<p align="left">
2+
<a href="README_zh.md">中文</a>&nbsp ｜ &nbsp<a>English&nbsp </a>
3+
</p>
4+
5+
# <p align="center">MuAgent: A Multi-Agent FrameWork For Faster Build Agents</p>
6+
7+
<p align="center">
8+
<a href="README.md"><img src="https://img.shields.io/badge/文档-中文版-yellow.svg" alt="ZH doc"></a>
9+
<a href="README_en.md"><img src="https://img.shields.io/badge/document-English-yellow.svg" alt="EN doc"></a>
10+
<img src="https://img.shields.io/github/license/codefuse-ai/muagent" alt="License">
11+
<a href="https://github.com/codefuse-ai/muagent/issues">
12+
<img alt="Open Issues" src="https://img.shields.io/github/issues-raw/codefuse-ai/muagent" />
13+
</a>
14+
<br><br>
15+
</p>
16+
17+
18+
19+
## 🔔 News
20+
- [2024.04.01] muagent is now open source, featuring functionalities such as knowledge base, code library, tool usage, code interpreter, and more
21+
22+
## 📜 Contents
23+
- [🤝 Introduction](#-Introduction)
24+
- [🚀 QuickStart](#-QuickStart)
25+
- [🧭 Key Technologies](#-Key-Technologies)
26+
- [🗂 Miscellaneous](#-Miscellaneous)
27+
- [📱 Contact Us](#-Contact-Us)
28+
29+
30+
## 🤝 Introduction
31+
Developed by the Ant CodeFuse Team, muagent is a Multi-Agent framework whose primary goal is to streamline the Standard Operating Procedure (SOP) orchestration for agents. muagent integrates a rich collection of toolkits, code libraries, knowledge bases, and sandbox environments, enabling users to rapidly construct complex Multi-Agent interactive applications in any field. This framework allows for the efficient execution and handling of multi-layered and multi-dimensional complex tasks.
32+
33+
![](docs/resources/agent_runtime.png)
34+
35+
## 🚀 快速使用
36+
For complete documentation, see: [muagent](docs/overview/o1.muagent.md)
37+
For more [demos](docs/overview/o3.quick-start.md)
38+
39+
1. Installation
40+
```
41+
pip install muagent
42+
```
43+
44+
2. Code answer Prepare related llm and embedding model configurations
45+
```
46+
import os
47+
48+
# set your config
49+
api_key = ""
50+
api_base_url= ""
51+
model_name = ""
52+
embed_model = ""
53+
embed_model_path = ""
54+
55+
from muagent.llm_models.llm_config import EmbedConfig, LLMConfig
56+
from muagent.connector.phase import BasePhase
57+
from muagent.connector.schema import Message, Memory
58+
from muagent.codechat.codebase_handler.codebase_handler import CodeBaseHandler
59+
60+
llm_config = LLMConfig(
61+
model_name=model_name, api_key=api_key, api_base_url=api_base_url, temperature=0.3
62+
)
63+
64+
embed_config = EmbedConfig(
65+
embed_engine="model", embed_model=embed_model, embed_model_path=embed_model_path
66+
)
67+
```
68+
69+
<br>
70+
71+
Initialize the codebase
72+
```
73+
codebase_name = 'client_local'
74+
code_path = "D://chromeDownloads/devopschat-bot/client_v2/client"
75+
76+
cbh = CodeBaseHandler(
77+
codebase_name, code_path, crawl_type='dir', use_nh=use_nh,local_graph_path=CB_ROOT_PATH,
78+
llm_config=llm_config, embed_config=embed_config
79+
)
80+
cbh.import_code(do_interpret=do_interpret)
81+
```
82+
83+
<br>
84+
85+
Start codebase Q&A
86+
```
87+
#
88+
phase_name = "codeChatPhase"
89+
phase = BasePhase(
90+
phase_name, embed_config=embed_config, llm_config=llm_config,
91+
)
92+
```
93+
94+
## Key Technologies
95+
96+
● Agent Base：Four fundamental Agent types are constructed – BaseAgent, ReactAgent, ExecutorAgent, SelectorAgent, supporting basic activities across various scenarios
97+
● Communication: Information transmission between Agents is accomplished through Message and Parse Message entities, interacting with Memory Manager and managing memories in the Memory Pool
98+
● Prompt Manager: Customized Agent Prompts are automatically assembled with the aid of Role Handler, Doc/Tool Handler, Session Handler, and Customized Handler
99+
● Memory Manager: Facilitates the management of chat history storage, information compression, and memory retrieval, culminating in storage within databases, local systems, and vector databases via the Memory Pool
100+
● Component: Auxiliary ecosystem components to construct Agents, including Retrieval, Tool, Action, Sandbox, etc.
101+
● Customized Model: Supports the integration of private LLM and Embedding models
102+
103+
## Contribution
104+
We are deeply grateful for your interest in the Codefuse project and warmly welcome any suggestions, opinions (including criticism), comments, and contributions.
105+
106+
Feel free to raise your suggestions, opinions, and comments directly through GitHub Issues. There are numerous ways to participate in and contribute to the Codefuse project: code implementation, writing tests, process tool improvements, documentation enhancements, etc.
107+
108+
We welcome any contribution and will add you to the list of contributors. See [Contribution Guide...](docs/contribution/contribute_guide.md)
109+
110+
111+
## 🗂 Miscellaneous
112+
### 📱 Contact Us
113+
<div align=center>
114+
<img src="docs/resources/wechat.png" alt="图片", width="360">
115+
</div>

0 commit comments

Comments
 (0)