Kye Gomez
7 months ago
parent
0fc0971d98
commit
25adc2c360
@ -1,89 +1,131 @@
|
|||||||
<div align="center">
|
# Swarms Documentation
|
||||||
<p>
|
|
||||||
<a align="center" href="" target="_blank">
|
Cutting-edge framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, Swarms empowers agents to work together seamlessly, tackling complex tasks.
|
||||||
<img
|
|
||||||
width="850"
|
<div style="display:flex; margin:0 auto; justify-content: center;">
|
||||||
src="https://github.com/kyegomez/swarms/raw/master/images/swarmslogobanner.png"
|
<div style="width:25%">
|
||||||
>
|
<h2>Core Concepts</h2>
|
||||||
</a>
|
<ul>
|
||||||
</p>
|
<li>
|
||||||
</div>
|
<a href="./core-concepts/Agents">
|
||||||
|
Agents
|
||||||
## 👋 Hello
|
</a>
|
||||||
|
</li>
|
||||||
Swarms provides you with all the building blocks you need to build reliable, production-grade, and scalable multi-agent apps!
|
<li>
|
||||||
|
<a href="./core-concepts/Tasks">
|
||||||
## 💻 Install
|
Tasks
|
||||||
|
</a>
|
||||||
You can install `swarms` with pip in a
|
</li>
|
||||||
[**Python>=3.10**](https://www.python.org/) environment.
|
<li>
|
||||||
|
<a href="./core-concepts/Tools">
|
||||||
!!! example "pip install (recommended)"
|
Tools
|
||||||
|
</a>
|
||||||
=== "headless"
|
</li>
|
||||||
The headless installation of `swarms` is designed for environments where graphical user interfaces (GUI) are not needed, making it more lightweight and suitable for server-side applications.
|
<li>
|
||||||
|
<a href="./core-concepts/Processes">
|
||||||
```bash
|
Processes
|
||||||
pip install swarms
|
</a>
|
||||||
```
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href="./core-concepts/Crews">
|
||||||
!!! example "git clone (for development)"
|
Crews
|
||||||
|
</a>
|
||||||
=== "virtualenv"
|
</li>
|
||||||
|
<li>
|
||||||
```bash
|
<a href="./core-concepts/Memory">
|
||||||
# clone repository and navigate to root directory
|
Memory
|
||||||
git clone https://github.com/kyegomez/swarms.git
|
</a>
|
||||||
cd swarms
|
</li>
|
||||||
|
</ul>
|
||||||
# setup python environment and activate it
|
</div>
|
||||||
python3 -m venv venv
|
<div style="width:30%">
|
||||||
source venv/bin/activate
|
<h2>How-To Guides</h2>
|
||||||
pip install --upgrade pip
|
<ul>
|
||||||
|
<li>
|
||||||
# headless install
|
<a href="./how-to/Installing-Swarms">
|
||||||
pip install -e "."
|
Installing Swarms
|
||||||
|
</a>
|
||||||
# desktop install
|
</li>
|
||||||
pip install -e ".[desktop]"
|
<li>
|
||||||
```
|
<a href="./how-to/Creating-a-Crew-and-kick-it-off">
|
||||||
|
Getting Started
|
||||||
=== "poetry"
|
</a>
|
||||||
|
</li>
|
||||||
```bash
|
<li>
|
||||||
# clone repository and navigate to root directory
|
<a href="./how-to/Create-Custom-Tools">
|
||||||
git clone https://github.com/kyegomez/swarms.git
|
Create Custom Tools
|
||||||
cd swarms
|
</a>
|
||||||
|
</li>
|
||||||
# setup python environment and activate it
|
<li>
|
||||||
poetry env use python3.10
|
<a href="./how-to/Sequential">
|
||||||
poetry shell
|
Using Sequential Process
|
||||||
|
</a>
|
||||||
# headless install
|
</li>
|
||||||
poetry install
|
<li>
|
||||||
|
<a href="./how-to/Hierarchical">
|
||||||
# desktop install
|
Using Hierarchical Process
|
||||||
poetry install --extras "desktop"
|
</a>
|
||||||
```
|
</li>
|
||||||
|
<li>
|
||||||
!!! example "NPM install |WIP|"
|
<a href="./how-to/LLM-Connections">
|
||||||
|
Connecting to LLMs
|
||||||
=== "headless"
|
</a>
|
||||||
Get started with the NPM implementation of Swarms with this command:
|
</li>
|
||||||
|
<li>
|
||||||
```bash
|
<a href="./how-to/Customizing-Agents">
|
||||||
npm install swarms-js
|
Customizing Agents
|
||||||
```
|
</a>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
## Documentation
|
<a href="./how-to/Human-Input-on-Execution">
|
||||||
|
Human Input on Execution
|
||||||
[Learn more about swarms →](swarms/)
|
</a>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
## Examples
|
<a href="./how-to/AgentOps-Observability">
|
||||||
|
Agent Monitoring with AgentOps
|
||||||
Check out Swarms examples for building agents, data retrieval, and more.
|
</a>
|
||||||
|
</li>
|
||||||
[Checkout Swarms examples →](examples/)
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div style="width:30%">
|
||||||
|
<h2>Examples</h2>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
<a target='_blank' href="https://github.com/joaomdmoura/Swarms-examples/tree/main/prep-for-a-meeting">
|
||||||
|
Prepare for meetings
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a target='_blank' href="https://github.com/joaomdmoura/Swarms-examples/tree/main/trip_planner">
|
||||||
|
Trip Planner Crew
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a target='_blank' href="https://github.com/joaomdmoura/Swarms-examples/tree/main/instagram_post">
|
||||||
|
Create Instagram Post
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a target='_blank' href="https://github.com/joaomdmoura/Swarms-examples/tree/main/stock_analysis">
|
||||||
|
Stock Analysis
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a target='_blank' href="https://github.com/joaomdmoura/Swarms-examples/tree/main/game-builder-crew">
|
||||||
|
Game Generator
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a target='_blank' href="https://github.com/joaomdmoura/Swarms-examples/tree/main/Swarms-LangGraph">
|
||||||
|
Drafting emails with LangGraph
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a target='_blank' href="https://github.com/joaomdmoura/Swarms-examples/tree/main/landing_page_generator">
|
||||||
|
Landing Page Generator
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
Loading…
Reference in new issue