Skip to content
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.

Sign up for GitHub

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

📖 [docs] 英語READMEの自動更新 #19

Merged
merged 1 commit into from
Oct 14, 2024
Merged

📖 [docs] 英語READMEの自動更新 #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
58 changes: 23 additions & 35 deletions docs/README.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,47 +3,34 @@
<h1 align="center">🌟 swarm-sample-box 🌟</h1>
</p>

<p align="center">
<a href="https://github.com/Sunwood-ai-labs/swarm-sample-box">
<img alt="GitHub Repo" src="https://img.shields.io/badge/github-swarm__sample__box-blue?logo=github">
</a>
<a href="https://github.com/Sunwood-ai-labs/swarm-sample-box/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/Sunwood-ai-labs/swarm-sample-box?color=green">
</a>
<a href="https://github.com/Sunwood-ai-labs/swarm-sample-box/stargazers">
<img alt="GitHub stars" src="https://img.shields.io/github/stars/Sunwood-ai-labs/swarm-sample-box?style=social">
</a>
<a href="https://github.com/Sunwood-ai-labs/swarm-sample-box/releases">
<img alt="GitHub release" src="https://img.shields.io/github/v/release/Sunwood-ai-labs/swarm-sample-box?include_prereleases&style=flat-square">
</a>
<a href="https://github.com/Sunwood-ai-labs/swarm-sample-box/graphs/commit-activity">
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/Sunwood-ai-labs/swarm-sample-box">
</a>
<!-- Many badges are omitted -->
</p>
[![GitHub Repo](https://img.shields.io/badge/github-swarm__sample__box-blue?logo=github)](https://github.com/Sunwood-ai-labs/swarm-sample-box)
[![License](https://img.shields.io/github/license/Sunwood-ai-labs/swarm-sample-box?color=green)](https://github.com/Sunwood-ai-labs/swarm-sample-box/blob/main/LICENSE)
[![GitHub stars](https://img.shields.io/github/stars/Sunwood-ai-labs/swarm-sample-box?style=social)](https://github.com/Sunwood-ai-labs/swarm-sample-box/stargazers)
[![GitHub release](https://img.shields.io/github/v/release/Sunwood-ai-labs/swarm-sample-box?include_prereleases&style=flat-square)](https://github.com/Sunwood-ai-labs/swarm-sample-box/releases)
... (and so on for all the badges)


<h2 align="center">
～ Experimental Playground for AI Agent Orchestration ～

<a href="https://github.com/Sunwood-ai-labs/swarm-sample-box/blob/main/README.md"><img src="https://img.shields.io/badge/ドキュメント-日本語-white.svg" alt="JA doc"/></a>
<a href="https://github.com/Sunwood-ai-labs/swarm-sample-box/blob/main/docs/README.en.md"><img src="https://img.shields.io/badge/english-document-white.svg" alt="EN doc"></a>
[![JA doc](https://img.shields.io/badge/ドキュメント-日本語-white.svg)](https://github.com/Sunwood-ai-labs/swarm-sample-box/blob/main/README.md)
[![EN doc](https://img.shields.io/badge/english-document-white.svg)](https://github.com/Sunwood-ai-labs/swarm-sample-box/blob/main/docs/README.en.md)
</h2>

> [!IMPORTANT]
> swarm-sample-box is a template repository developed using [cline (formerly Claude Dev)](https://github.com/clinebot/cline), [SourceSage](https://github.com/Sunwood-ai-labs/SourceSage), and [claude.ai](https://claude.ai/). Most of the release notes, README, and commit messages are generated using the latest AI technologies.
> swarm-sample-box is a template repository developed using [cline (formerly Claude Dev)](https://github.com/clinebot/cline), [SourceSage](https://github.com/Sunwood-ai-labs/SourceSage), and [claude.ai](https://claude.ai/). The majority of the release notes, README, and commit messages are generated using the latest AI technology.


## 🚀 Project Overview

Swarm Sample Box is an AI agent experimentation repository utilizing [Swarm, an experimental multi-agent orchestration framework developed by OpenAI](https://github.com/openai/swarm). This repository provides a lightweight and flexible solution for efficiently coordinating multiple AI agents to perform complex tasks, supporting developers' research and experimentation. Version: v1.6.0
Swarm Sample Box is an AI agent experimental repository utilizing [Swarm, an experimental multi-agent orchestration framework developed by OpenAI](https://github.com/openai/swarm). This repository provides a lightweight and flexible solution for efficiently coordinating multiple AI agents to perform complex tasks, supporting developer research and experimentation. Version: v1.6.0

## ✨ Main Features

1. Diverse Agent Samples: Provides implementation examples of various AI agents, from basic dialogue to complex task processing.
2. Flexible Customization: Each sample can be easily extended and modified to adapt to your own use cases.
3. Integrated Experimental Environment: Provides a practical experimental environment, including Docker environment and integration with vector databases (Qdrant).
4. Automated Evaluation Function: Some samples include automated evaluation scripts to measure agent performance.
3. Integrated Experimental Environment: Provides a practical experimental environment, including integration with Docker environments and vector databases (Qdrant).
4. Automatic Evaluation Function: Some samples include automatic evaluation scripts, enabling agent performance measurement.

## 🔧 Usage

Expand Down Expand Up @@ -72,17 +59,18 @@ Swarm Sample Box is an AI agent experimentation repository utilizing [Swarm, an

5. Run a specific sample:
```bash
cd examples/<sample_name>
cd examples/<sample name>
python main.py
```


## 📦 Installation Instructions

Refer to the "Usage" section for installation instructions.
Please refer to the "Usage" section for instructions on how to install and use swarm-sample-box.


## 🆕 Latest Updates

- Added ASCII art title display to the weather_agent sample.
- The weather_agent sample demo can now handle dummy weather data for multiple cities.
- Added `requirements.txt` to the weather_agent sample.
Expand All @@ -93,26 +81,26 @@ Refer to the "Usage" section for installation instructions.

### Official Samples (Translated to Japanese)

The following samples are translated from [the samples listed in the official OpenAI Swarm repository](https://github.com/openai/swarm/tree/main/examples) and modified to be operational:
The following samples are Japanese translations of the samples listed in the [official OpenAI Swarm repository](https://github.com/openai/swarm/tree/main/examples), modified to be operational:

- [Basic](https://github.com/Sunwood-ai-labs/swarm-sample-box/tree/main/examples/basic): A minimal implementation example that introduces the basic functions of Swarm.
- [Basic](https://github.com/Sunwood-ai-labs/swarm-sample-box/tree/main/examples/basic): A minimal implementation example introducing the basic functions of Swarm.
- [Airline](https://github.com/Sunwood-ai-labs/swarm-sample-box/tree/main/examples/airline): A multi-agent setup simulating airline customer service.
- [Personal Shopper](https://github.com/Sunwood-ai-labs/swarm-sample-box/tree/main/examples/personal_shopper): An implementation example of a personal shopping assistant agent.
- [Support Bot](https://github.com/Sunwood-ai-labs/swarm-sample-box/tree/main/examples/support_bot): An implementation example of a customer support bot, including document search functionality using Qdrant.
- [Support Bot](https://github.com/Sunwood-ai-labs/swarm-sample-box/tree/main/examples/support_bot): An implementation example of a customer support bot, including document retrieval functionality using Qdrant.
- [Triage Agent](https://github.com/Sunwood-ai-labs/swarm-sample-box/tree/main/examples/triage_agent): An implementation example of a triage agent that directs user requests to the appropriate agent.
- [Weather Agent](https://github.com/Sunwood-ai-labs/swarm-sample-box/tree/main/examples/weather_agent): A simple implementation example of an agent that retrieves weather information and performs related tasks.
- [Customer Service Streaming](https://github.com/Sunwood-ai-labs/swarm-sample-box/tree/main/examples/customer_service_streaming): A sample that simulates customer service in a streaming format. (🔥Under Development)
- [Customer Service Streaming](https://github.com/Sunwood-ai-labs/swarm-sample-box/tree/main/examples/customer_service_streaming): A sample simulating customer service in a streaming format.

### Original Samples

This section will introduce original samples that we have developed. Currently under preparation, so please wait for future updates.
This section will introduce originally developed samples. Currently under preparation, so please wait for future updates.

- [Under Development] New Original Sample 1: Details coming soon
- [Under Development] New Original Sample 2: Details coming soon
- [In preparation] New original sample 1: Details coming soon
- [In preparation] New original sample 2: Details coming soon

## 🧪 Evaluation Method

Some samples include automated evaluation scripts. To run the evaluation, execute the following command in the sample directory:
Some samples include automatic evaluation scripts. To run the evaluation, execute the following command in the sample directory:

```bash
pytest evals.py
Expand All @@ -131,4 +119,4 @@ This project is based on the Swarm framework developed by OpenAI. We deeply appr

---

Start developing and experimenting with innovative AI agent systems using Swarm Sample Box! For detailed usage instructions and explanations of each sample, please refer to the README file in the corresponding directory.
Start developing and experimenting with innovative AI agent systems using Swarm Sample Box! For detailed usage instructions and descriptions of each sample, please refer to the README file in the corresponding directory.