diff --git a/docs/index.md b/docs/index.md index c28ab5b5..47be0eb9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,89 +1,131 @@ -
-

- - - -

-
- -## 👋 Hello - -Swarms provides you with all the building blocks you need to build reliable, production-grade, and scalable multi-agent apps! - -## 💻 Install - -You can install `swarms` with pip in a -[**Python>=3.10**](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 "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/) +# Swarms Documentation + +Cutting-edge framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, Swarms empowers agents to work together seamlessly, tackling complex tasks. + +
+
+

Core Concepts

+ +
+
+

How-To Guides

+ +
+
+

Examples

+ +
+
\ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 9655af5f..54f283f2 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -111,13 +111,6 @@ nav: - References: - Agent Glossary: "swarms/glossary.md" - List of The Best Multi-Agent Papers: "swarms/papers.md" -- Swarms Cloud API: - - Overview: "swarms_cloud/main.md" - - Available Models: "swarms_cloud/available_models.md" - - Migrate from OpenAI to Swarms in 3 lines of code: "swarms_cloud/migrate_openai.md" - - Getting Started with SOTA Vision Language Models VLM: "swarms_cloud/getting_started.md" - - Enterprise Guide to High-Performance Multi-Agent LLM Deployments: "swarms_cloud/production_deployment.md" - - Under The Hood The Swarm Cloud Serving Infrastructure: "swarms_cloud/architecture.md" - Swarms Framework [PY]: - Models: - How to Create A Custom Language Model: "swarms/models/custom_model.md" @@ -171,6 +164,13 @@ nav: - MajorityVoting: "swarms/structs/majorityvoting.md" - AgentRearrange: "swarms/structs/agent_rearrange.md" - RoundRobin: "swarms/structs/round_robin_swarm.md" +- Swarms Cloud API: + - Overview: "swarms_cloud/main.md" + - Available Models: "swarms_cloud/available_models.md" + - Migrate from OpenAI to Swarms in 3 lines of code: "swarms_cloud/migrate_openai.md" + - Getting Started with SOTA Vision Language Models VLM: "swarms_cloud/getting_started.md" + - Enterprise Guide to High-Performance Multi-Agent LLM Deployments: "swarms_cloud/production_deployment.md" + - Under The Hood The Swarm Cloud Serving Infrastructure: "swarms_cloud/architecture.md" - Guides: - Agents: - Building Custom Vector Memory Databases with the BaseVectorDatabase Class: "swarms/memory/diy_memory.md"