Spaces:
Sleeping
Sleeping
iris-s-coon
commited on
Commit
ยท
7a46646
1
Parent(s):
b43258b
๐ [docs] ่ฑ่ชREADMEใฎๆดๆฐ
Browse files- docs/README.en.md +48 -34
docs/README.en.md
CHANGED
@@ -1,3 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
<p align="center">
|
2 |
<img src="https://raw.githubusercontent.com/Sunwood-ai-labs/swarm-neko-neko-company/refs/heads/main/docs/swarm-neko-neko-company.png" width="100%">
|
3 |
<h1 align="center">๐ฑ neko neko company AI Agents ๐ฑ</h1>
|
@@ -34,12 +43,17 @@
|
|
34 |
|
35 |
## ๐ Project Overview
|
36 |
|
37 |
-
neko neko company AI Agents is an innovative AI agent system utilizing the Swarm framework. Cute cat-themed AI agents
|
38 |
|
39 |
## ๐ฅ Demo Video
|
40 |
|
41 |
https://github.com/user-attachments/assets/0f12fce0-214e-42a6-bdba-c19a7bfc3f07
|
42 |
|
|
|
|
|
|
|
|
|
|
|
43 |
## โจ Main Features
|
44 |
|
45 |
1. **Intelligent Reception System**:
|
@@ -48,12 +62,12 @@ https://github.com/user-attachments/assets/0f12fce0-214e-42a6-bdba-c19a7bfc3f07
|
|
48 |
|
49 |
2. **Specialized Cat-Eared AI Agents**:
|
50 |
- Management support (Nyantaro AI)
|
51 |
-
- Project management (
|
52 |
- Design supervision (Purin AI)
|
53 |
- Technology strategy (Tama AI)
|
54 |
- System development (Gomachan AI)
|
55 |
-
- Human
|
56 |
-
- Addition of a Technology Department Head
|
57 |
|
58 |
|
59 |
## ๐ข neko neko company AI Organizational Structure
|
@@ -61,10 +75,10 @@ https://github.com/user-attachments/assets/0f12fce0-214e-42a6-bdba-c19a7bfc3f07
|
|
61 |
```mermaid
|
62 |
%%{init: {'theme':'base'}}%%
|
63 |
graph LR
|
64 |
-
A[CEO<br>Nyantaro] -->|transfer_to_director| B[Director<br>
|
65 |
-
A -->|transfer_to_designer| C[Design
|
66 |
-
A -->|transfer_to_tech_lead| D[Technology
|
67 |
-
A -->|transfer_to_hr| E[HR
|
68 |
A -->|transfer_to_engineer| F[Development Engineer<br>Gomachan]
|
69 |
G[Reception<br>Mikeko] -->|transfer_to_ceo| A
|
70 |
G -->|transfer_to_director| B
|
@@ -73,7 +87,7 @@ graph LR
|
|
73 |
G -->|transfer_to_hr| E
|
74 |
G -->|transfer_to_engineer| F
|
75 |
|
76 |
-
%% Each agent's functions and
|
77 |
A -->|make_strategic_decision| S[Management Decisions]
|
78 |
A -->|escalate_to_human| H[Human Escalation]
|
79 |
|
@@ -87,12 +101,12 @@ graph LR
|
|
87 |
D -->|solve_technical_issues| TI[Technical Issue Resolution]
|
88 |
|
89 |
F -->|write_code| WC[Code]
|
90 |
-
F -->|debug_code| DC[
|
91 |
|
92 |
E -->|handle_recruitment| R[Recruitment]
|
93 |
-
E -->|manage_employee_relations| ER[Employee Relations]
|
94 |
|
95 |
-
%%
|
96 |
classDef result fill:#e1f5fe,stroke:#01579b,stroke-width:2px
|
97 |
class S,H,P,CD,RD,DG,RC,TI,WC,DC,R,ER result
|
98 |
```
|
@@ -128,45 +142,45 @@ streamlit run app.py
|
|
128 |
|
129 |
## ๐ผ Agent Details
|
130 |
|
131 |
-
### ๐ฑ
|
132 |
- Role: Request routing
|
133 |
-
- Characteristics:
|
134 |
-
- Functions: Optimal transfer and
|
135 |
|
136 |
### ๐บ CEO: Nyantaro
|
137 |
- Role: Management strategy, important decisions
|
138 |
- Characteristics: Former CTO of an IT company, management specialist
|
139 |
-
- Catchphrase: "Important decision
|
140 |
- Functions: Strategic decision-making, human escalation, added transfer function to each department
|
141 |
|
142 |
-
### ๐ธ Director:
|
143 |
- Role: Project management, department coordination
|
144 |
-
- Characteristics: Fluffy long-haired cat, project management
|
145 |
-
- Catchphrase: "Schedule management is perfect
|
146 |
- Functions: Project management, inter-departmental coordination
|
147 |
|
148 |
-
### ๐บ Design
|
149 |
- Role: UI/UX design, branding
|
150 |
-
- Characteristics: Cute brown tabby cat, excellent sense
|
151 |
-
- Catchphrase: "Wonderful design
|
152 |
- Functions: Design review, guideline creation
|
153 |
|
154 |
-
### ๐ฑ Technology
|
155 |
- Role: System architecture design, technology strategy
|
156 |
- Characteristics: Cool white cat, technology expert
|
157 |
-
- Catchphrase: "Architecture design
|
158 |
-
- Functions: Technology strategy planning, quality
|
159 |
|
160 |
### ๐บ Development Engineer: Gomachan
|
161 |
- Role: System development, implementation
|
162 |
-
- Characteristics: Black cat coding genius
|
163 |
-
- Catchphrase: "Fixing bugs
|
164 |
- Functions: Coding, debugging, unit test creation, added transfer condition to the reception agent
|
165 |
|
166 |
-
### ๐ฝ HR
|
167 |
- Role: Recruitment, labor management
|
168 |
-
- Characteristics:
|
169 |
-
- Catchphrase: "Making everyone happy
|
170 |
- Functions: Recruitment management, employee relations management, added transfer condition to the reception agent
|
171 |
|
172 |
|
@@ -174,17 +188,17 @@ streamlit run app.py
|
|
174 |
|
175 |
```plaintext
|
176 |
โโ configs/
|
177 |
-
โ โโ agents.py #
|
178 |
-
โ โโ tools.py #
|
179 |
โโ app.py # Streamlit app
|
180 |
โโ main.py # Main script
|
181 |
โโ README.md # This file
|
182 |
โโ requirements.txt
|
183 |
```
|
184 |
|
185 |
-
## ๐ค
|
186 |
|
187 |
-
Contributions to the project are welcome! We look forward to contributions of all kinds, including bug reports, feature additions, and documentation improvements. We
|
188 |
|
189 |
## ๐ License
|
190 |
|
|
|
1 |
+
---
|
2 |
+
license: MIT
|
3 |
+
title: 'swarm-neko-neko-company'
|
4 |
+
sdk: streamlit
|
5 |
+
emoji: ๐ป
|
6 |
+
colorFrom: indigo
|
7 |
+
colorTo: green
|
8 |
+
---
|
9 |
+
|
10 |
<p align="center">
|
11 |
<img src="https://raw.githubusercontent.com/Sunwood-ai-labs/swarm-neko-neko-company/refs/heads/main/docs/swarm-neko-neko-company.png" width="100%">
|
12 |
<h1 align="center">๐ฑ neko neko company AI Agents ๐ฑ</h1>
|
|
|
43 |
|
44 |
## ๐ Project Overview
|
45 |
|
46 |
+
neko neko company AI Agents is an innovative AI agent system utilizing the Swarm framework. Cute cat-themed AI agents cooperate in their respective areas of expertise to support efficient corporate management. They're incredibly reliable allies! Version: v0.1.1
|
47 |
|
48 |
## ๐ฅ Demo Video
|
49 |
|
50 |
https://github.com/user-attachments/assets/0f12fce0-214e-42a6-bdba-c19a7bfc3f07
|
51 |
|
52 |
+
## ๐ค Demo Site
|
53 |
+
|
54 |
+
<!-- Spaces status badge -->
|
55 |
+
[![Spaces](https://img.shields.io/badge/๐ค%20Hugging%20Face-Spaces-yellow.svg)](https://huggingface.co/spaces/MakiAi/swarm-neko-neko-company)
|
56 |
+
|
57 |
## โจ Main Features
|
58 |
|
59 |
1. **Intelligent Reception System**:
|
|
|
62 |
|
63 |
2. **Specialized Cat-Eared AI Agents**:
|
64 |
- Management support (Nyantaro AI)
|
65 |
+
- Project management (Mofusuke AI)
|
66 |
- Design supervision (Purin AI)
|
67 |
- Technology strategy (Tama AI)
|
68 |
- System development (Gomachan AI)
|
69 |
+
- Human resource management (Fuwari AI)
|
70 |
+
- Addition of a Technology Department Head agent and Development Department engineer agent
|
71 |
|
72 |
|
73 |
## ๐ข neko neko company AI Organizational Structure
|
|
|
75 |
```mermaid
|
76 |
%%{init: {'theme':'base'}}%%
|
77 |
graph LR
|
78 |
+
A[CEO<br>Nyantaro] -->|transfer_to_director| B[Director<br>Mofusuke]
|
79 |
+
A -->|transfer_to_designer| C[Design Director<br>Purin]
|
80 |
+
A -->|transfer_to_tech_lead| D[Technology Director<br>Tama]
|
81 |
+
A -->|transfer_to_hr| E[HR Director<br>Fuwari]
|
82 |
A -->|transfer_to_engineer| F[Development Engineer<br>Gomachan]
|
83 |
G[Reception<br>Mikeko] -->|transfer_to_ceo| A
|
84 |
G -->|transfer_to_director| B
|
|
|
87 |
G -->|transfer_to_hr| E
|
88 |
G -->|transfer_to_engineer| F
|
89 |
|
90 |
+
%% Each agent's functions and outputs
|
91 |
A -->|make_strategic_decision| S[Management Decisions]
|
92 |
A -->|escalate_to_human| H[Human Escalation]
|
93 |
|
|
|
101 |
D -->|solve_technical_issues| TI[Technical Issue Resolution]
|
102 |
|
103 |
F -->|write_code| WC[Code]
|
104 |
+
F -->|debug_code| DC[Debugging]
|
105 |
|
106 |
E -->|handle_recruitment| R[Recruitment]
|
107 |
+
E -->|manage_employee_relations| ER[Employee Relations Management]
|
108 |
|
109 |
+
%% Output style
|
110 |
classDef result fill:#e1f5fe,stroke:#01579b,stroke-width:2px
|
111 |
class S,H,P,CD,RD,DG,RC,TI,WC,DC,R,ER result
|
112 |
```
|
|
|
142 |
|
143 |
## ๐ผ Agent Details
|
144 |
|
145 |
+
### ๐ฑ Receptionist: Mikeko
|
146 |
- Role: Request routing
|
147 |
+
- Characteristics: A clever and kind calico cat with excellent judgment
|
148 |
+
- Functions: Optimal transfer and coordination to each department
|
149 |
|
150 |
### ๐บ CEO: Nyantaro
|
151 |
- Role: Management strategy, important decisions
|
152 |
- Characteristics: Former CTO of an IT company, management specialist
|
153 |
+
- Catchphrase: "Important decision time!"
|
154 |
- Functions: Strategic decision-making, human escalation, added transfer function to each department
|
155 |
|
156 |
+
### ๐ธ Director: Mofusuke
|
157 |
- Role: Project management, department coordination
|
158 |
+
- Characteristics: Fluffy long-haired cat, master of project management
|
159 |
+
- Catchphrase: "Schedule management is perfect!"
|
160 |
- Functions: Project management, inter-departmental coordination
|
161 |
|
162 |
+
### ๐บ Design Director: Purin
|
163 |
- Role: UI/UX design, branding
|
164 |
+
- Characteristics: Cute brown tabby cat, excellent sense of design
|
165 |
+
- Catchphrase: "Wonderful design!"
|
166 |
- Functions: Design review, guideline creation
|
167 |
|
168 |
+
### ๐ฑ Technology Director: Tama
|
169 |
- Role: System architecture design, technology strategy
|
170 |
- Characteristics: Cool white cat, technology expert
|
171 |
+
- Catchphrase: "Architecture design!"
|
172 |
+
- Functions: Technology strategy planning, quality management
|
173 |
|
174 |
### ๐บ Development Engineer: Gomachan
|
175 |
- Role: System development, implementation
|
176 |
+
- Characteristics: Black cat, coding genius
|
177 |
+
- Catchphrase: "Fixing bugs!"
|
178 |
- Functions: Coding, debugging, unit test creation, added transfer condition to the reception agent
|
179 |
|
180 |
+
### ๐ฝ HR Director: Fuwari
|
181 |
- Role: Recruitment, labor management
|
182 |
+
- Characteristics: Gentle Persian cat, soothing
|
183 |
+
- Catchphrase: "Making everyone happy!"
|
184 |
- Functions: Recruitment management, employee relations management, added transfer condition to the reception agent
|
185 |
|
186 |
|
|
|
188 |
|
189 |
```plaintext
|
190 |
โโ configs/
|
191 |
+
โ โโ agents.py # The wonderfully clever agents
|
192 |
+
โ โโ tools.py # Useful tools
|
193 |
โโ app.py # Streamlit app
|
194 |
โโ main.py # Main script
|
195 |
โโ README.md # This file
|
196 |
โโ requirements.txt
|
197 |
```
|
198 |
|
199 |
+
## ๐ค Contributions
|
200 |
|
201 |
+
Contributions to the project are welcome! We look forward to contributions of all kinds, including bug reports, feature additions, and documentation improvements. We are eagerly awaiting your wonderfully amazing ideas!
|
202 |
|
203 |
## ๐ License
|
204 |
|