Skip to content

Commit

Permalink
Merge pull request #6 from Sunwood-ai-labs/translate-readme-11308022362
Browse files Browse the repository at this point in the history
📖 [docs] 英語READMEの自動更新
  • Loading branch information
iris-s-coon authored Oct 12, 2024
2 parents 9e27a52 + d065229 commit 9456f8d
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions docs/README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
</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 were 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 were generated using the latest AI technology.

## 🚀 Project Overview
Expand All @@ -95,10 +95,10 @@ Swarm Sample Box is an AI agent experiment repository utilizing Swarm, an experi

## ✨ Key Features

1. **Diverse Agent Samples:** Provides various implementation examples of AI agents, ranging from basic interactions to complex task processing.
1. **Diverse Agent Samples:** Provides implementation examples of various AI agents, from basic interactions to complex task processing.
2. **Flexible Customization:** Each sample is easily extensible and modifiable, adaptable to unique use cases.
3. **Integrated Experimental Environment:** Offers a practical experimental environment, including Docker integration and vector database (Qdrant) connectivity.
4. **Automatic Evaluation Function:** Some samples include automated evaluation scripts for measuring agent performance.
4. **Automated Evaluation Feature:** Some samples include automated evaluation scripts for measuring agent performance.

## 🔧 Setup and Usage

Expand Down Expand Up @@ -133,11 +133,11 @@ Swarm Sample Box is an AI agent experiment repository utilizing Swarm, an experi

## 📚 Sample List

### 1. Basic
### [1. Basic](https://github.com/Sunwood-ai-labs/swarm-sample-box/tree/main/examples/basic)
A minimal implementation example showcasing basic Swarm functionality.

### 2. Airline
A multi-agent setup simulating an airline's customer service.
### [2. Airline](https://github.com/Sunwood-ai-labs/swarm-sample-box/tree/main/examples/airline)
A multi-agent setup simulating airline customer service.

### 3. Personal Shopper
An implementation example of a personal shopping assistant agent.
Expand All @@ -146,32 +146,32 @@ An implementation example of a personal shopping assistant agent.
An implementation example of a customer support bot, including document search functionality using Qdrant.

### 5. Triage Agent
An implementation example of a triage agent that routes user requests to the appropriate agents.
An implementation example of a triage agent that routes user requests to the appropriate agent.

### 6. Weather Agent
A simple agent implementation for retrieving weather information and performing related tasks.
An implementation example of a simple agent that retrieves weather information and performs related tasks.

## 🧪 Evaluation Method

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

```
pytest evals.py
```

## 🤝 Contributions
## 🤝 Contribution

Swarm Sample Box welcomes contributions from the community as an open-source project. We encourage contributions of all kinds, including adding new samples, improving existing samples, and expanding the documentation.

## 📄 License

Swarm Sample Box is released under the [MIT License](LICENSE).

## 🙏 Acknowledgements
## 🙏 Acknowledgments

This project is based on the Swarm framework developed by OpenAI. We express our deep gratitude to the Swarm developers. Contributors to this release: Maki, iris-s-coon
This project is based on the Swarm framework developed by OpenAI. We express our deep gratitude to the Swarm developers. Contributors to this release: Maki, iris-s-coon


---

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.
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.

0 comments on commit 9456f8d

Please sign in to comment.