You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
94 lines
2.1 KiB
94 lines
2.1 KiB
9 months ago
|
<div align="center">
|
||
|
|
<p>
|
||
|
|
<a align="center" href="" target="_blank">
|
||
|
|
<img
|
||
|
|
width="850"
|
||
|
|
src="https://github.com/kyegomez/swarms/raw/master/images/swarmslogobanner.png"
|
||
|
|
>
|
||
|
|
</a>
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
# Installation Guide
|
||
|
|
|
||
|
|
You can install `swarms` with pip in a
|
||
|
|
[**Python>=3.8**](https://www.python.org/) environment.
|
||
|
|
|
||
|
|
!!! example "pip install (recommended)"
|
||
|
|
|
||
|
|
=== "headless"
|
||
|
|
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.
|
||
|
|
|
||
|
|
```bash
|
||
|
|
pip install swarms
|
||
|
|
```
|
||
|
|
|
||
|
|
!!! example "pip install (recommended)"
|
||
|
|
If the installation above doesn't work try the following with PIP3
|
||
|
|
|
||
|
|
```bash
|
||
|
|
pip3 install -U swarms
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
!!! example "git clone (for development)"
|
||
|
|
|
||
|
|
=== "virtualenv"
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# clone repository and navigate to root directory
|
||
|
|
git clone https://github.com/kyegomez/swarms.git
|
||
|
|
cd swarms
|
||
|
|
|
||
|
|
# setup python environment and activate it
|
||
|
|
python3 -m venv venv
|
||
|
|
source venv/bin/activate
|
||
|
|
pip install --upgrade pip
|
||
|
|
|
||
|
|
# headless install
|
||
|
|
pip install -e "."
|
||
|
|
|
||
|
|
# desktop install
|
||
|
|
pip install -e ".[desktop]"
|
||
|
|
```
|
||
|
|
|
||
|
|
=== "poetry"
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# clone repository and navigate to root directory
|
||
|
|
git clone https://github.com/kyegomez/swarms.git
|
||
|
|
cd swarms
|
||
|
|
|
||
|
|
# setup python environment and activate it
|
||
|
|
poetry env use python3.10
|
||
|
|
poetry shell
|
||
|
|
|
||
|
|
# headless install
|
||
|
|
poetry install
|
||
|
|
|
||
|
|
# desktop install
|
||
|
|
poetry install --extras "desktop"
|
||
|
|
```
|
||
|
|
|
||
|
|
!!! example "NPM install |WIP|"
|
||
|
|
|
||
|
|
=== "headless"
|
||
|
|
Get started with the NPM implementation of Swarms with this command:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm install swarms-js
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
[Learn more about swarms →](swarms/)
|
||
|
|
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
Check out Swarms examples for building agents, data retrieval, and more.
|
||
|
|
|
||
|
|
[Checkout Swarms examples →](examples/)
|