[readme links]

pull/1020/head
Kye Gomez 4 months ago
parent dc891a8cac
commit 578252542a

@ -8,92 +8,106 @@
</p> </p>
<p align="center"> <p align="center">
<a href="https://pypi.org/project/swarms/" target="_blank"> <a href="https://pypi.org/project/swarms/" target="_blank">
<img alt="Python" src="https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54" /> <picture>
<img alt="Version" src="https://img.shields.io/pypi/v/swarms?style=for-the-badge&color=3670A0"> <source srcset="https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54" media="(prefers-color-scheme: dark)">
</a> <img alt="Python" src="https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54" />
</p> </picture>
<picture>
<p align="center"> <source srcset="https://img.shields.io/pypi/v/swarms?style=for-the-badge&color=3670A0" media="(prefers-color-scheme: dark)">
<a href="https://twitter.com/swarms_corp/">🐦 Twitter</a> <img alt="Version" src="https://img.shields.io/pypi/v/swarms?style=for-the-badge&color=3670A0">
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span> </picture>
<a href="https://discord.gg/EamjgSaEQf">📢 Discord</a> </a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="https://swarms.ai">Swarms Website</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="https://docs.swarms.world">📙 Documentation</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="https://swarms.world"> Swarms Marketplace</a>
</p> </p>
<p align="center"> <p align="center">
<!-- Social Media --> <a href="https://twitter.com/swarms_corp/">🐦 Twitter</a>
<a href="https://discord.gg/jHnrkH5y"> <span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<img src="https://img.shields.io/badge/Discord-Join%20our%20server-5865F2?style=for-the-badge&logo=discord&logoColor=white" alt="Discord"> <a href="https://discord.gg/EamjgSaEQf">📢 Discord</a>
</a> <span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="https://www.youtube.com/@kyegomez3242"> <a href="https://swarms.ai">Swarms Website</a>
<img src="https://img.shields.io/badge/YouTube-Subscribe-red?style=for-the-badge&logo=youtube&logoColor=white" alt="YouTube"> <span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
</a> <a href="https://docs.swarms.world">📙 Documentation</a>
<a href="https://www.linkedin.com/in/kye-g-38759a207/"> <span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<img src="https://img.shields.io/badge/LinkedIn-Connect-blue?style=for-the-badge&logo=linkedin&logoColor=white" alt="LinkedIn"> <a href="https://swarms.world"> Swarms Marketplace</a>
</a>
<a href="https://x.com/swarms_corp">
<img src="https://img.shields.io/badge/X.com-Follow-1DA1F2?style=for-the-badge&logo=x&logoColor=white" alt="X.com">
</a>
</p> </p>
<p align="center"> <p align="center">
<!-- Project Stats --> <!-- Social Media -->
<a href="https://github.com/kyegomez/swarms/issues"> <a href="https://www.youtube.com/@kyegomez3242">
<img src="https://img.shields.io/github/issues/kyegomez/swarms" alt="GitHub issues"> <picture>
</a> <source srcset="https://img.shields.io/badge/YouTube-Subscribe-red?style=for-the-badge&logo=youtube&logoColor=white" media="(prefers-color-scheme: dark)">
<a href="https://github.com/kyegomez/swarms/network"> <img src="https://img.shields.io/badge/YouTube-Subscribe-red?style=for-the-badge&logo=youtube&logoColor=white" alt="YouTube">
<img src="https://img.shields.io/github/forks/kyegomez/swarms" alt="GitHub forks"> </picture>
</a> </a>
<a href="https://github.com/kyegomez/swarms/stargazers"> <a href="https://www.linkedin.com/in/kye-g-38759a207/">
<img src="https://img.shields.io/github/stars/kyegomez/swarms" alt="GitHub stars"> <picture>
</a> <source srcset="https://img.shields.io/badge/LinkedIn-Connect-blue?style=for-the-badge&logo=linkedin&logoColor=white" media="(prefers-color-scheme: dark)">
<a href="https://github.com/kyegomez/swarms/blob/main/LICENSE"> <img src="https://img.shields.io/badge/LinkedIn-Connect-blue?style=for-the-badge&logo=linkedin&logoColor=white" alt="LinkedIn">
<img src="https://img.shields.io/github/license/kyegomez/swarms" alt="GitHub license"> </picture>
</a> </a>
<a href="https://star-history.com/#kyegomez/swarms"> <a href="https://x.com/swarms_corp">
<img src="https://img.shields.io/github/stars/kyegomez/swarms?style=social" alt="GitHub star chart"> <picture>
</a> <source srcset="https://img.shields.io/badge/X.com-Follow-1DA1F2?style=for-the-badge&logo=x&logoColor=white" media="(prefers-color-scheme: dark)">
<a href="https://libraries.io/github/kyegomez/swarms"> <img src="https://img.shields.io/badge/X.com-Follow-1DA1F2?style=for-the-badge&logo=x&logoColor=white" alt="X.com">
<img src="https://img.shields.io/librariesio/github/kyegomez/swarms" alt="Dependency Status"> </picture>
</a> </a>
<a href="https://pepy.tech/project/swarms">
<img src="https://static.pepy.tech/badge/swarms/month" alt="Downloads">
</a>
</p> </p>
<p align="center"> <p align="center">
<!-- Share Buttons --> <!-- Project Stats -->
<a href="https://twitter.com/intent/tweet?text=Check%20out%20this%20amazing%20AI%20project:%20&url=https%3A%2F%2Fgithub.com%2Fkyegomez%2Fswarms"> <a href="https://github.com/kyegomez/swarms/issues">
<img src="https://img.shields.io/twitter/url/https/twitter.com/cloudposse.svg?style=social&label=Share%20%40kyegomez/swarms" alt="Share on Twitter"> <picture>
</a> <source srcset="https://img.shields.io/github/issues/kyegomez/swarms?style=for-the-badge" media="(prefers-color-scheme: dark)">
<a href="https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Fgithub.com%2Fkyegomez%2Fswarms"> <img src="https://img.shields.io/github/issues/kyegomez/swarms?style=for-the-badge" alt="GitHub issues">
<img src="https://img.shields.io/badge/Share-%20facebook-blue" alt="Share on Facebook"> </picture>
</a> </a>
<a href="https://www.linkedin.com/shareArticle?mini=true&url=https%3A%2F%2Fgithub.com%2Fkyegomez%2Fswarms&title=&summary=&source="> <a href="https://github.com/kyegomez/swarms/network">
<img src="https://img.shields.io/badge/Share-%20linkedin-blue" alt="Share on LinkedIn"> <picture>
</a> <source srcset="https://img.shields.io/github/forks/kyegomez/swarms?style=for-the-badge" media="(prefers-color-scheme: dark)">
<img src="https://img.shields.io/github/forks/kyegomez/swarms?style=for-the-badge" alt="GitHub forks">
</picture>
</a>
<a href="https://github.com/kyegomez/swarms/stargazers">
<picture>
<source srcset="https://img.shields.io/github/stars/kyegomez/swarms?style=for-the-badge" media="(prefers-color-scheme: dark)">
<img src="https://img.shields.io/github/stars/kyegomez/swarms?style=for-the-badge" alt="GitHub stars">
</picture>
</a>
<a href="https://github.com/kyegomez/swarms/blob/main/LICENSE">
<picture>
<source srcset="https://img.shields.io/github/license/kyegomez/swarms?style=for-the-badge" media="(prefers-color-scheme: dark)">
<img src="https://img.shields.io/github/license/kyegomez/swarms?style=for-the-badge" alt="GitHub license">
</picture>
</a>
<a href="https://libraries.io/github/kyegomez/swarms">
<picture>
<source srcset="https://img.shields.io/librariesio/github/kyegomez/swarms?style=for-the-badge" media="(prefers-color-scheme: dark)">
<img src="https://img.shields.io/librariesio/github/kyegomez/swarms?style=for-the-badge" alt="Dependency Status">
</picture>
</a>
<a href="https://pepy.tech/project/swarms">
<picture>
<source srcset="https://static.pepy.tech/badge/swarms/month" media="(prefers-color-scheme: dark)">
<img src="https://static.pepy.tech/badge/swarms/month" alt="Downloads">
</picture>
</a>
</p> </p>
<p align="center"> <p align="center">
<!-- Additional Share Buttons --> <!-- Share Buttons -->
<a href="https://www.reddit.com/submit?url=https%3A%2F%2Fgithub.com%2Fkyegomez%2Fswarms&title=Swarms%20-%20the%20future%20of%20AI"> <a href="https://twitter.com/intent/tweet?text=Check%20out%20this%20amazing%20AI%20project:%20&url=https%3A%2F%2Fgithub.com%2Fkyegomez%2Fswarms">
<img src="https://img.shields.io/badge/-Share%20on%20Reddit-orange" alt="Share on Reddit"> <picture>
</a> <source srcset="https://img.shields.io/badge/Share%20on%20Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white" media="(prefers-color-scheme: dark)">
<a href="https://news.ycombinator.com/submitlink?u=https%3A%2F%2Fgithub.com%2Fkyegomez%2Fswarms&t=Swarms%20-%20the%20future%20of%20AI"> <img src="https://img.shields.io/badge/Share%20on%20Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white" alt="Share on Twitter">
<img src="https://img.shields.io/badge/-Share%20on%20Hacker%20News-orange" alt="Share on Hacker News"> </picture>
</a> </a>
<a href="https://pinterest.com/pin/create/button/?url=https%3A%2F%2Fgithub.com%2Fkyegomez%2Fswarms&media=https%3A%2F%2Fexample.com%2Fimage.jpg&description=Swarms%20-%20the%20future%20of%20AI"> <a href="https://www.linkedin.com/shareArticle?mini=true&url=https%3A%2F%2Fgithub.com%2Fkyegomez%2Fswarms&title=&summary=&source=">
<img src="https://img.shields.io/badge/-Share%20on%20Pinterest-red" alt="Share on Pinterest"> <picture>
</a> <source srcset="https://img.shields.io/badge/Share%20on%20LinkedIn-blue?style=for-the-badge" media="(prefers-color-scheme: dark)">
<a href="https://api.whatsapp.com/send?text=Check%20out%20Swarms%20-%20the%20future%20of%20AI%20%23swarms%20%23AI%0A%0Ahttps%3A%2F%2Fgithub.com%2Fkyegomez%2Fswarms"> <img src="https://img.shields.io/badge/Share%20on%20LinkedIn-blue?style=for-the-badge" alt="Share on LinkedIn">
<img src="https://img.shields.io/badge/-Share%20on%20WhatsApp-green" alt="Share on WhatsApp"> </picture>
</a> </a>
</p> </p>
## ✨ Features ## ✨ Features
@ -122,7 +136,6 @@ $ pip3 install -U swarms
[uv](https://github.com/astral-sh/uv) is a fast Python package installer and resolver, written in Rust. [uv](https://github.com/astral-sh/uv) is a fast Python package installer and resolver, written in Rust.
```bash ```bash
# Install swarms using uv
$ uv pip install swarms $ uv pip install swarms
``` ```
@ -168,7 +181,7 @@ from swarms import Agent
# Initialize a new agent # Initialize a new agent
agent = Agent( agent = Agent(
model_name="gpt-4o-mini", # Specify the LLM model_name="gpt-4o-mini", # Specify the LLM
max_loops=1, # Set the number of interactions max_loops="auto", # Set the number of interactions
interactive=True, # Enable interactive mode for real-time feedback interactive=True, # Enable interactive mode for real-time feedback
) )
@ -348,7 +361,7 @@ print(results)
### AgentRearrange ### AgentRearrange
Inspired by `einsum`, `AgentRearrange` lets you define complex, non-linear relationships between agents using a simple string-based syntax. [Learn more](https://docs.swarms.world/en/latest/swarms/structs/agent_rearrange/). This architecture is Perfect for orchestrating dynamic workflows where agents might work in parallel, sequence, or a combination of both. Inspired by `einsum`, `AgentRearrange` lets you define complex, non-linear relationships between agents using a simple string-based syntax. [Learn more](https://docs.swarms.world/en/latest/swarms/structs/agent_rearrange/). This architecture is perfect for orchestrating dynamic workflows where agents might work in parallel, in sequence, or in any combination you choose.
```python ```python
from swarms import Agent, AgentRearrange from swarms import Agent, AgentRearrange
@ -721,7 +734,7 @@ By joining us, you have the opportunity to:
* **Work on the Frontier of Agents:** Shape the future of autonomous agent technology and help build a production-grade, open-source framework. * **Work on the Frontier of Agents:** Shape the future of autonomous agent technology and help build a production-grade, open-source framework.
* **Join a Vibrant Community:** Collaborate with a passionate and growing group of agent developers, researchers, and AI enthusiasts. * **Join a Vibrant Community:** Collaborate with a passionate and growing group of agent developers, researchers, and agent enthusasits.
* **Make a Tangible Impact:** Whether you're fixing a bug, adding a new feature, or improving documentation, your work will be used in real-world applications. * **Make a Tangible Impact:** Whether you're fixing a bug, adding a new feature, or improving documentation, your work will be used in real-world applications.

Loading…
Cancel
Save