From 8b7ed4dd0abff99348f23942968b74c082304667 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Sun, 2 Jun 2024 09:33:55 -0600 Subject: [PATCH 01/43] update Devin example to work with Anthropic --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f59b58f0..42274f59 100644 --- a/README.md +++ b/README.md @@ -280,7 +280,7 @@ agent = Agent( ) # Run the agent -out = agent("Create a new file for a plan to take over the world.") +out = agent("Create a new file for a plan to create abundance in the world. Save the file and also display the contents of the file.") print(out) ``` From 4bc66401883d926d4af5bdbb5af19a5c69fd0981 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Sun, 2 Jun 2024 14:35:37 -0600 Subject: [PATCH 02/43] Fix agentrearrange docs --- docs/swarms/structs/agent_rearrange.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/swarms/structs/agent_rearrange.md b/docs/swarms/structs/agent_rearrange.md index 967b69f7..904c2304 100644 --- a/docs/swarms/structs/agent_rearrange.md +++ b/docs/swarms/structs/agent_rearrange.md @@ -117,11 +117,16 @@ Here's an example of how to use the `AgentRearrange` class and the `rearrange` f from swarms import Agent, AgentRearrange, rearrange from typing import List +llm = Anthropic( + temperature=0.1, + anthropic_api_key = anthropic_api_key +) + # Initialize the director agent director = Agent( agent_name="Director", system_prompt="Directs the tasks for the workers", - llm=Anthropic(), + llm=llm, max_loops=1, dashboard=False, streaming_on=True, @@ -135,7 +140,7 @@ director = Agent( worker1 = Agent( agent_name="Worker1", system_prompt="Generates a transcript for a youtube video on what swarms are", - llm=Anthropic(), + llm=llm, max_loops=1, dashboard=False, streaming_on=True, @@ -149,7 +154,7 @@ worker1 = Agent( worker2 = Agent( agent_name="Worker2", system_prompt="Summarizes the transcript generated by Worker1", - llm=Anthropic(), + llm=llm, max_loops=1, dashboard=False, streaming_on=True, From a7f6bcaa16033e1a14fdcc920bd0b8aedc72764b Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Thu, 6 Jun 2024 15:12:23 -0600 Subject: [PATCH 03/43] Codacy gh action remove --- --- .github/workflows/codacy.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/codacy.yml b/.github/workflows/codacy.yml index 195ec00e..81be09a8 100644 --- a/.github/workflows/codacy.yml +++ b/.github/workflows/codacy.yml @@ -1,4 +1,3 @@ ---- name: Codacy on: push: From b41ba8a0c8cf781b0946341959b6813733e2f803 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Thu, 6 Jun 2024 15:17:40 -0600 Subject: [PATCH 04/43] remove --- lint.yml gh actions --- .github/workflows/lint.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index f2295d07..8525c34e 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -1,4 +1,3 @@ ---- name: Lint on: [push, pull_request] # yamllint disable-line rule:truthy jobs: From 21f54f3b73120d622d2228cda2f738e8214475fe Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Thu, 6 Jun 2024 15:44:42 -0600 Subject: [PATCH 05/43] cronjob --- .github/workflows/codacy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/codacy.yml b/.github/workflows/codacy.yml index 81be09a8..798b26cd 100644 --- a/.github/workflows/codacy.yml +++ b/.github/workflows/codacy.yml @@ -5,7 +5,7 @@ on: pull_request: branches: ["master"] schedule: - - cron: "0 0 * * " + - cron: '0 0 * * *' permissions: contents: read From 23bfb0b27551b7a1c57b4fb1d6a608ccf3f50bba Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Thu, 6 Jun 2024 19:02:44 -0600 Subject: [PATCH 06/43] Update dataroom with typo and new pitch deck --- docs/corporate/data_room.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/corporate/data_room.md b/docs/corporate/data_room.md index 31ee9b7f..7fe4d84d 100644 --- a/docs/corporate/data_room.md +++ b/docs/corporate/data_room.md @@ -49,7 +49,7 @@ - Case Studies and Use Cases -## **Introdution** +## **Introduction** Swarms provides automation-as-a-service through swarms of autonomous agents that work together as a team. We enable our customers to build, deploy, and scale production-grade multi-agent applications to automate real-world tasks. ### **Vision** @@ -69,7 +69,7 @@ The team has thousands of hours building and optimizing autonomous agents. Leade Key milestones: get 80K framework users in January 2024, start contracts in target verticals, introduce commercial products in 2025 with various pricing models. ### **Resources** -- [Swarm Pre-Seed Deck](https://drive.google.com/file/d/1n8o2mjORbG96uDfx4TabjnyieludYaZz/view?usp=sharing) +- [Swarm Pre-Seed Deck](https://www.dropbox.com/scl/fi/qglgu970d921zbuge3rig/Swarms_Pitch_Deck_compressed.pdf?rlkey=2b6mbv4k4pfn44xwr5h3dzra2&e=1&st=0rp0mst4&dl=0) - [Swarm Memo](https://docs.google.com/document/d/1hS_nv_lFjCqLfnJBoF6ULY9roTbSgSuCkvXvSUSc7Lo/edit?usp=sharing) From 6a58c7dc5e47d386cec9bbf831f2422ef2e7c01b Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Thu, 6 Jun 2024 19:54:33 -0600 Subject: [PATCH 07/43] trying docs with python 3.10 --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 17e8b500..c97796f1 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -12,7 +12,7 @@ jobs: - uses: actions/checkout@v4 - uses: actions/setup-python@v5 with: - python-version: 3.11 + python-version: 3.10 - run: pip install mkdocs-material - run: pip install mkdocs-glightbox - run: pip install "mkdocstrings[python]" From 1a44f3396b3234b7993c8849834fa5590402a522 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Thu, 6 Jun 2024 19:55:40 -0600 Subject: [PATCH 08/43] typo --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index c97796f1..9770e5a9 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -12,7 +12,7 @@ jobs: - uses: actions/checkout@v4 - uses: actions/setup-python@v5 with: - python-version: 3.10 + python-version: "3.10" - run: pip install mkdocs-material - run: pip install mkdocs-glightbox - run: pip install "mkdocstrings[python]" From f8302236460cf19581c56d95eca931a7b238cd84 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Thu, 6 Jun 2024 20:01:06 -0600 Subject: [PATCH 09/43] added quotes, docs dir --- docs/mkdocs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index df0abaa6..ff53aa1f 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,9 +1,9 @@ -docs_dir: '.' # replace with the correct path if your documentation files are not in the same directory as mkdocs.yml +docs_dir: 'docs' # replace with the correct path if your documentation files are not in the same directory as mkdocs.yml site_name: Swarms Documentation site_url: https://swarms.apac.ai site_author: Swarms -site_description: Orchestrate Swarms of Agents From Any Framework Like OpenAI, Langchain, and Etc for Real World Workflow Automation. +site_description: "Orchestrate Swarms of Agents From Any Framework Like OpenAI, Langchain, and Etc for Real World Workflow Automation." repo_name: kyegomez/swarms repo_url: https://github.com/kyegomez/swarms edit_uri: https://github.com/kyegomez/swarms/tree/main/docs From aa6d811044dcd4c244df77c8c6dd5e5077a7bd56 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Thu, 6 Jun 2024 20:04:23 -0600 Subject: [PATCH 10/43] quotes, site url --- docs/mkdocs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index ff53aa1f..878cff36 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,7 +1,7 @@ docs_dir: 'docs' # replace with the correct path if your documentation files are not in the same directory as mkdocs.yml -site_name: Swarms Documentation -site_url: https://swarms.apac.ai +site_name: "Swarms Documentation" +site_url: https://swarms.world site_author: Swarms site_description: "Orchestrate Swarms of Agents From Any Framework Like OpenAI, Langchain, and Etc for Real World Workflow Automation." repo_name: kyegomez/swarms From dc5c26175631a8e540cf814df2ccda183dce1d1f Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Thu, 6 Jun 2024 20:09:41 -0600 Subject: [PATCH 11/43] removed initial blank line --- docs/mkdocs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 878cff36..0e8c88f3 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,4 +1,3 @@ - docs_dir: 'docs' # replace with the correct path if your documentation files are not in the same directory as mkdocs.yml site_name: "Swarms Documentation" site_url: https://swarms.world From 189f9d343dd52ff516e8d80b9e016d23b03a6958 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Thu, 6 Jun 2024 20:22:31 -0600 Subject: [PATCH 12/43] mkdocs same dir --- .github/workflows/docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 9770e5a9..d2a2e498 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -14,6 +14,7 @@ jobs: with: python-version: "3.10" - run: pip install mkdocs-material + - run: pip install mkdocs-same-dir - run: pip install mkdocs-glightbox - run: pip install "mkdocstrings[python]" - run: pip3 install mkdocs-git-authors-plugin From a026e326a124b1da0b93ed81242cb30bb4524c3d Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Thu, 6 Jun 2024 20:25:10 -0600 Subject: [PATCH 13/43] indent from line 117 to eof mkdocs.yml --- docs/mkdocs.yml | 114 ++++++++++++++++++++++++------------------------ 1 file changed, 57 insertions(+), 57 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 0e8c88f3..57ce1a77 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -114,60 +114,60 @@ nav: - List of The Best Multi-Agent Papers: "swarms/papers.md" - Contributors: - Contributing: "contributing.md" -- Reference: - - Overview: "swarms/index.md" - - Framework Structure: "swarms/structs/tree.md" - - swarms.models: - - How to Create A Custom Language Model: "swarms/models/custom_model.md" - - Deploying Azure OpenAI in Production A Comprehensive Guide: "swarms/models/azure_openai.md" - - Language Models: - - BaseLLM: "swarms/models/base_llm.md" - - Overview: "swarms/models/index.md" - - HuggingFaceLLM: "swarms/models/huggingface.md" - - Anthropic: "swarms/models/anthropic.md" - - OpenAIChat: "swarms/models/openai.md" - - MultiModal Models : - - BaseMultiModalModel: "swarms/models/base_multimodal_model.md" - - Fuyu: "swarms/models/fuyu.md" - - Vilt: "swarms/models/vilt.md" - - Idefics: "swarms/models/idefics.md" - - Kosmos: "swarms/models/kosmos.md" - - Nougat: "swarms/models/nougat.md" - - Dalle3: "swarms/models/dalle3.md" - - GPT4VisionAPI: "swarms/models/gpt4v.md" - - GPT4o: "swarms/models/gpt4o.md" - - swarms.structs: - - Foundational Structures: - - Agent: "swarms/structs/agent.md" - - BaseStructure: "swarms/structs/basestructure.md" - - Task: "swarms/structs/task.md" - - YamlModel: "swarms/structs/yaml_model.md" - # - BaseSwarm: "swarms/structs/base_swarm.md" - - BaseWorkflow: "swarms/structs/baseworkflow.md" - - Workflows: - - ConcurrentWorkflow: "swarms/structs/concurrentworkflow.md" - - SequentialWorkflow: "swarms/structs/sequential_workflow.md" - - Multi Agent Architectures: - - Conversation: "swarms/structs/conversation.md" - - SwarmNetwork: "swarms/structs/swarmnetwork.md" - - 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: - # - Building Custom Vector Memory Databases with the BaseVectorDatabase Class: "swarms/memory/diy_memory.md" - - Models: - - How to Create A Custom Language Model: "swarms/models/custom_model.md" - - Deploying Azure OpenAI in Production, A Comprehensive Guide: "swarms/models/azure_openai.md" - - Agents: - - Agent: "examples/flow.md" - - DIY Build Your Own Agent: "diy_your_own_agent.md" - - Equipping Autonomous Agents with Tools: "examples/tools_agent.md" - - Swarms: - - SequentialWorkflow: "examples/reliable_autonomous_agents.md" + - Reference: + - Overview: "swarms/index.md" + - Framework Structure: "swarms/structs/tree.md" + - swarms.models: + - How to Create A Custom Language Model: "swarms/models/custom_model.md" + - Deploying Azure OpenAI in Production A Comprehensive Guide: "swarms/models/azure_openai.md" + - Language Models: + - BaseLLM: "swarms/models/base_llm.md" + - Overview: "swarms/models/index.md" + - HuggingFaceLLM: "swarms/models/huggingface.md" + - Anthropic: "swarms/models/anthropic.md" + - OpenAIChat: "swarms/models/openai.md" + - MultiModal Models : + - BaseMultiModalModel: "swarms/models/base_multimodal_model.md" + - Fuyu: "swarms/models/fuyu.md" + - Vilt: "swarms/models/vilt.md" + - Idefics: "swarms/models/idefics.md" + - Kosmos: "swarms/models/kosmos.md" + - Nougat: "swarms/models/nougat.md" + - Dalle3: "swarms/models/dalle3.md" + - GPT4VisionAPI: "swarms/models/gpt4v.md" + - GPT4o: "swarms/models/gpt4o.md" + - swarms.structs: + - Foundational Structures: + - Agent: "swarms/structs/agent.md" + - BaseStructure: "swarms/structs/basestructure.md" + - Task: "swarms/structs/task.md" + - YamlModel: "swarms/structs/yaml_model.md" + # - BaseSwarm: "swarms/structs/base_swarm.md" + - BaseWorkflow: "swarms/structs/baseworkflow.md" + - Workflows: + - ConcurrentWorkflow: "swarms/structs/concurrentworkflow.md" + - SequentialWorkflow: "swarms/structs/sequential_workflow.md" + - Multi Agent Architectures: + - Conversation: "swarms/structs/conversation.md" + - SwarmNetwork: "swarms/structs/swarmnetwork.md" + - 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: + # - Building Custom Vector Memory Databases with the BaseVectorDatabase Class: "swarms/memory/diy_memory.md" + - Models: + - How to Create A Custom Language Model: "swarms/models/custom_model.md" + - Deploying Azure OpenAI in Production, A Comprehensive Guide: "swarms/models/azure_openai.md" + - Agents: + - Agent: "examples/flow.md" + - DIY Build Your Own Agent: "diy_your_own_agent.md" + - Equipping Autonomous Agents with Tools: "examples/tools_agent.md" + - Swarms: + - SequentialWorkflow: "examples/reliable_autonomous_agents.md" From f5d7a944fc60daf78f7f007987fcf8e933b89fc9 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Thu, 6 Jun 2024 20:36:24 -0600 Subject: [PATCH 14/43] Indent two spaces --- docs/mkdocs.yml | 112 ++++++++++++++++++++++++------------------------ 1 file changed, 56 insertions(+), 56 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 57ce1a77..3fdba928 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -115,59 +115,59 @@ nav: - Contributors: - Contributing: "contributing.md" - Reference: - - Overview: "swarms/index.md" - - Framework Structure: "swarms/structs/tree.md" - - swarms.models: - - How to Create A Custom Language Model: "swarms/models/custom_model.md" - - Deploying Azure OpenAI in Production A Comprehensive Guide: "swarms/models/azure_openai.md" - - Language Models: - - BaseLLM: "swarms/models/base_llm.md" - - Overview: "swarms/models/index.md" - - HuggingFaceLLM: "swarms/models/huggingface.md" - - Anthropic: "swarms/models/anthropic.md" - - OpenAIChat: "swarms/models/openai.md" - - MultiModal Models : - - BaseMultiModalModel: "swarms/models/base_multimodal_model.md" - - Fuyu: "swarms/models/fuyu.md" - - Vilt: "swarms/models/vilt.md" - - Idefics: "swarms/models/idefics.md" - - Kosmos: "swarms/models/kosmos.md" - - Nougat: "swarms/models/nougat.md" - - Dalle3: "swarms/models/dalle3.md" - - GPT4VisionAPI: "swarms/models/gpt4v.md" - - GPT4o: "swarms/models/gpt4o.md" - - swarms.structs: - - Foundational Structures: - - Agent: "swarms/structs/agent.md" - - BaseStructure: "swarms/structs/basestructure.md" - - Task: "swarms/structs/task.md" - - YamlModel: "swarms/structs/yaml_model.md" - # - BaseSwarm: "swarms/structs/base_swarm.md" - - BaseWorkflow: "swarms/structs/baseworkflow.md" - - Workflows: - - ConcurrentWorkflow: "swarms/structs/concurrentworkflow.md" - - SequentialWorkflow: "swarms/structs/sequential_workflow.md" - - Multi Agent Architectures: - - Conversation: "swarms/structs/conversation.md" - - SwarmNetwork: "swarms/structs/swarmnetwork.md" - - 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: - # - Building Custom Vector Memory Databases with the BaseVectorDatabase Class: "swarms/memory/diy_memory.md" - - Models: - - How to Create A Custom Language Model: "swarms/models/custom_model.md" - - Deploying Azure OpenAI in Production, A Comprehensive Guide: "swarms/models/azure_openai.md" - - Agents: - - Agent: "examples/flow.md" - - DIY Build Your Own Agent: "diy_your_own_agent.md" - - Equipping Autonomous Agents with Tools: "examples/tools_agent.md" - - Swarms: - - SequentialWorkflow: "examples/reliable_autonomous_agents.md" + - Overview: "swarms/index.md" + - Framework Structure: "swarms/structs/tree.md" + - swarms.models: + - How to Create A Custom Language Model: "swarms/models/custom_model.md" + - Deploying Azure OpenAI in Production A Comprehensive Guide: "swarms/models/azure_openai.md" + - Language Models: + - BaseLLM: "swarms/models/base_llm.md" + - Overview: "swarms/models/index.md" + - HuggingFaceLLM: "swarms/models/huggingface.md" + - Anthropic: "swarms/models/anthropic.md" + - OpenAIChat: "swarms/models/openai.md" + - MultiModal Models : + - BaseMultiModalModel: "swarms/models/base_multimodal_model.md" + - Fuyu: "swarms/models/fuyu.md" + - Vilt: "swarms/models/vilt.md" + - Idefics: "swarms/models/idefics.md" + - Kosmos: "swarms/models/kosmos.md" + - Nougat: "swarms/models/nougat.md" + - Dalle3: "swarms/models/dalle3.md" + - GPT4VisionAPI: "swarms/models/gpt4v.md" + - GPT4o: "swarms/models/gpt4o.md" + - swarms.structs: + - Foundational Structures: + - Agent: "swarms/structs/agent.md" + - BaseStructure: "swarms/structs/basestructure.md" + - Task: "swarms/structs/task.md" + - YamlModel: "swarms/structs/yaml_model.md" + # - BaseSwarm: "swarms/structs/base_swarm.md" + - BaseWorkflow: "swarms/structs/baseworkflow.md" + - Workflows: + - ConcurrentWorkflow: "swarms/structs/concurrentworkflow.md" + - SequentialWorkflow: "swarms/structs/sequential_workflow.md" + - Multi Agent Architectures: + - Conversation: "swarms/structs/conversation.md" + - SwarmNetwork: "swarms/structs/swarmnetwork.md" + - 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: + # - Building Custom Vector Memory Databases with the BaseVectorDatabase Class: "swarms/memory/diy_memory.md" + - Models: + - How to Create A Custom Language Model: "swarms/models/custom_model.md" + - Deploying Azure OpenAI in Production, A Comprehensive Guide: "swarms/models/azure_openai.md" + - Agents: + - Agent: "examples/flow.md" + - DIY Build Your Own Agent: "diy_your_own_agent.md" + - Equipping Autonomous Agents with Tools: "examples/tools_agent.md" + - Swarms: + - SequentialWorkflow: "examples/reliable_autonomous_agents.md" From ed8695beae3163b970c8c0e6477ccf8305f7d746 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Thu, 6 Jun 2024 20:38:45 -0600 Subject: [PATCH 15/43] initial two spaces --- docs/mkdocs.yml | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 3fdba928..21314a33 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -153,21 +153,21 @@ 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: - # - Building Custom Vector Memory Databases with the BaseVectorDatabase Class: "swarms/memory/diy_memory.md" - - Models: - - How to Create A Custom Language Model: "swarms/models/custom_model.md" - - Deploying Azure OpenAI in Production, A Comprehensive Guide: "swarms/models/azure_openai.md" - - Agents: - - Agent: "examples/flow.md" - - DIY Build Your Own Agent: "diy_your_own_agent.md" - - Equipping Autonomous Agents with Tools: "examples/tools_agent.md" - - Swarms: - - SequentialWorkflow: "examples/reliable_autonomous_agents.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: + # - Building Custom Vector Memory Databases with the BaseVectorDatabase Class: "swarms/memory/diy_memory.md" + - Models: + - How to Create A Custom Language Model: "swarms/models/custom_model.md" + - Deploying Azure OpenAI in Production, A Comprehensive Guide: "swarms/models/azure_openai.md" + - Agents: + - Agent: "examples/flow.md" + - DIY Build Your Own Agent: "diy_your_own_agent.md" + - Equipping Autonomous Agents with Tools: "examples/tools_agent.md" + - Swarms: + - SequentialWorkflow: "examples/reliable_autonomous_agents.md" From 51f7356f0cb9c177c85d85d9a7abf1ba43849e1a Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Thu, 6 Jun 2024 20:43:36 -0600 Subject: [PATCH 16/43] indentation --- docs/mkdocs.yml | 76 ++++++++++++++++++++++++------------------------- 1 file changed, 38 insertions(+), 38 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 21314a33..57ce1a77 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -115,44 +115,44 @@ nav: - Contributors: - Contributing: "contributing.md" - Reference: - - Overview: "swarms/index.md" - - Framework Structure: "swarms/structs/tree.md" - - swarms.models: - - How to Create A Custom Language Model: "swarms/models/custom_model.md" - - Deploying Azure OpenAI in Production A Comprehensive Guide: "swarms/models/azure_openai.md" - - Language Models: - - BaseLLM: "swarms/models/base_llm.md" - - Overview: "swarms/models/index.md" - - HuggingFaceLLM: "swarms/models/huggingface.md" - - Anthropic: "swarms/models/anthropic.md" - - OpenAIChat: "swarms/models/openai.md" - - MultiModal Models : - - BaseMultiModalModel: "swarms/models/base_multimodal_model.md" - - Fuyu: "swarms/models/fuyu.md" - - Vilt: "swarms/models/vilt.md" - - Idefics: "swarms/models/idefics.md" - - Kosmos: "swarms/models/kosmos.md" - - Nougat: "swarms/models/nougat.md" - - Dalle3: "swarms/models/dalle3.md" - - GPT4VisionAPI: "swarms/models/gpt4v.md" - - GPT4o: "swarms/models/gpt4o.md" - - swarms.structs: - - Foundational Structures: - - Agent: "swarms/structs/agent.md" - - BaseStructure: "swarms/structs/basestructure.md" - - Task: "swarms/structs/task.md" - - YamlModel: "swarms/structs/yaml_model.md" - # - BaseSwarm: "swarms/structs/base_swarm.md" - - BaseWorkflow: "swarms/structs/baseworkflow.md" - - Workflows: - - ConcurrentWorkflow: "swarms/structs/concurrentworkflow.md" - - SequentialWorkflow: "swarms/structs/sequential_workflow.md" - - Multi Agent Architectures: - - Conversation: "swarms/structs/conversation.md" - - SwarmNetwork: "swarms/structs/swarmnetwork.md" - - MajorityVoting: "swarms/structs/majorityvoting.md" - - AgentRearrange: "swarms/structs/agent_rearrange.md" - - RoundRobin: "swarms/structs/round_robin_swarm.md" + - Overview: "swarms/index.md" + - Framework Structure: "swarms/structs/tree.md" + - swarms.models: + - How to Create A Custom Language Model: "swarms/models/custom_model.md" + - Deploying Azure OpenAI in Production A Comprehensive Guide: "swarms/models/azure_openai.md" + - Language Models: + - BaseLLM: "swarms/models/base_llm.md" + - Overview: "swarms/models/index.md" + - HuggingFaceLLM: "swarms/models/huggingface.md" + - Anthropic: "swarms/models/anthropic.md" + - OpenAIChat: "swarms/models/openai.md" + - MultiModal Models : + - BaseMultiModalModel: "swarms/models/base_multimodal_model.md" + - Fuyu: "swarms/models/fuyu.md" + - Vilt: "swarms/models/vilt.md" + - Idefics: "swarms/models/idefics.md" + - Kosmos: "swarms/models/kosmos.md" + - Nougat: "swarms/models/nougat.md" + - Dalle3: "swarms/models/dalle3.md" + - GPT4VisionAPI: "swarms/models/gpt4v.md" + - GPT4o: "swarms/models/gpt4o.md" + - swarms.structs: + - Foundational Structures: + - Agent: "swarms/structs/agent.md" + - BaseStructure: "swarms/structs/basestructure.md" + - Task: "swarms/structs/task.md" + - YamlModel: "swarms/structs/yaml_model.md" + # - BaseSwarm: "swarms/structs/base_swarm.md" + - BaseWorkflow: "swarms/structs/baseworkflow.md" + - Workflows: + - ConcurrentWorkflow: "swarms/structs/concurrentworkflow.md" + - SequentialWorkflow: "swarms/structs/sequential_workflow.md" + - Multi Agent Architectures: + - Conversation: "swarms/structs/conversation.md" + - SwarmNetwork: "swarms/structs/swarmnetwork.md" + - 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" From 1cd6584afeabd50bdcefe9a7b68eb595a4be1b74 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Thu, 6 Jun 2024 21:04:42 -0600 Subject: [PATCH 17/43] indentation 2 --- docs/mkdocs.yml | 85 ++++++++++++++++++++++++------------------------- 1 file changed, 42 insertions(+), 43 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 57ce1a77..482af0ed 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,4 +1,4 @@ -docs_dir: 'docs' # replace with the correct path if your documentation files are not in the same directory as mkdocs.yml +docs_dir: 'docs' site_name: "Swarms Documentation" site_url: https://swarms.world site_author: Swarms @@ -14,10 +14,10 @@ plugins: - search - git-authors - mkdocs-jupyter: - kernel_name: python3 - execute: false - include_source: True - include_requirejs: true + kernel_name: python3 + execute: false + include_source: True + include_requirejs: true - mkdocstrings: default_handler: python handlers: @@ -49,15 +49,14 @@ extra: - icon: fontawesome/brands/github link: https://github.com/kyegomez/swarms theme: - name: material - custom_dir: overrides - logo: assets/img/SwarmsLogoIcon.png - palette: - # Palette toggle for light mode + name: material + custom_dir: overrides + logo: assets/img/SwarmsLogoIcon.png + palette: # Palette toggle for light mode - scheme: default primary: black toggle: - icon: material/brightness-7 + icon: material/brightness-7 name: Switch to dark mode # Palette toggle for dark mode - scheme: slate @@ -65,14 +64,14 @@ theme: toggle: icon: material/brightness-4 name: Switch to light mode - features: - - content.code.copy - - content.code.annotate - - navigation.tabs - - navigation.sections - - navigation.expand - - navigation.top - - announce.dismiss + features: + - content.code.copy + - content.code.annotate + - navigation.tabs + - navigation.sections + - navigation.expand + - navigation.top + - announce.dismiss markdown_extensions: - pymdownx.highlight: anchor_linenums: true @@ -89,31 +88,31 @@ markdown_extensions: - footnotes nav: - Home: - - Installation: - - Overview: "index.md" - - Install: "swarms/install/install.md" - - Docker Setup: "swarms/install/docker_setup.md" - - Usage Examples: - - Models: - - How to Create A Custom Language Model: "swarms/models/custom_model.md" - - Models Available: "swarms/models/index.md" - - MultiModal Models Available: "swarms/models/multimodal_models.md" - - Agents: - - Getting started with Agents: "swarms/structs/diy_your_own_agent.md" - - Tools: - - Functions, Pydantic BaseModels, and More: "swarms/tools/main.md" - - Memory: - - Building Custom Vector Memory Databases with the BaseVectorDatabase Class: "swarms/memory/diy_memory.md" - - ShortTermMemory: "swarms/memory/short_term_memory.md" - - Multi-Agent Collaboration: - - SwarmNetwork: "swarms/structs/swarmnetwork.md" - - AgentRearrange: "swarms/structs/agent_rearrange.md" - - Why does Swarms Exist?: + - Installation: + - Overview: "index.md" + - Install: "swarms/install/install.md" + - Docker Setup: "swarms/install/docker_setup.md" + - Usage Examples: + - Models: + - How to Create A Custom Language Model: "swarms/models/custom_model.md" + - Models Available: "swarms/models/index.md" + - MultiModal Models Available: "swarms/models/multimodal_models.md" + - Agents: + - Getting started with Agents: "swarms/structs/diy_your_own_agent.md" + - Tools: + - Functions, Pydantic BaseModels, and More: "swarms/tools/main.md" + - Memory: + - Building Custom Vector Memory Databases with the BaseVectorDatabase Class: "swarms/memory/diy_memory.md" + - ShortTermMemory: "swarms/memory/short_term_memory.md" + - Multi-Agent Collaboration: + - SwarmNetwork: "swarms/structs/swarmnetwork.md" + - AgentRearrange: "swarms/structs/agent_rearrange.md" + - Why does Swarms Exist?: - References: - - Agent Glossary: "swarms/glossary.md" - - List of The Best Multi-Agent Papers: "swarms/papers.md" + - Agent Glossary: "swarms/glossary.md" + - List of The Best Multi-Agent Papers: "swarms/papers.md" - Contributors: - - Contributing: "contributing.md" + - Contributing: "contributing.md" - Reference: - Overview: "swarms/index.md" - Framework Structure: "swarms/structs/tree.md" @@ -170,4 +169,4 @@ nav: - DIY Build Your Own Agent: "diy_your_own_agent.md" - Equipping Autonomous Agents with Tools: "examples/tools_agent.md" - Swarms: - - SequentialWorkflow: "examples/reliable_autonomous_agents.md" + - SequentialWorkflow: "examples/reliable_autonomous_agents.md" \ No newline at end of file From 68d2c18747fade011e348c4ebcf208bb5230c5e1 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Thu, 6 Jun 2024 21:11:03 -0600 Subject: [PATCH 18/43] indentation 3 --- docs/mkdocs.yml | 80 ++++++++++++++++++++++++------------------------- 1 file changed, 40 insertions(+), 40 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 482af0ed..1f1e6a0c 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -113,45 +113,45 @@ nav: - List of The Best Multi-Agent Papers: "swarms/papers.md" - Contributors: - Contributing: "contributing.md" - - Reference: - - Overview: "swarms/index.md" - - Framework Structure: "swarms/structs/tree.md" - - swarms.models: - - How to Create A Custom Language Model: "swarms/models/custom_model.md" - - Deploying Azure OpenAI in Production A Comprehensive Guide: "swarms/models/azure_openai.md" - - Language Models: - - BaseLLM: "swarms/models/base_llm.md" - - Overview: "swarms/models/index.md" - - HuggingFaceLLM: "swarms/models/huggingface.md" - - Anthropic: "swarms/models/anthropic.md" - - OpenAIChat: "swarms/models/openai.md" - - MultiModal Models : - - BaseMultiModalModel: "swarms/models/base_multimodal_model.md" - - Fuyu: "swarms/models/fuyu.md" - - Vilt: "swarms/models/vilt.md" - - Idefics: "swarms/models/idefics.md" - - Kosmos: "swarms/models/kosmos.md" - - Nougat: "swarms/models/nougat.md" - - Dalle3: "swarms/models/dalle3.md" - - GPT4VisionAPI: "swarms/models/gpt4v.md" - - GPT4o: "swarms/models/gpt4o.md" - - swarms.structs: - - Foundational Structures: - - Agent: "swarms/structs/agent.md" - - BaseStructure: "swarms/structs/basestructure.md" - - Task: "swarms/structs/task.md" - - YamlModel: "swarms/structs/yaml_model.md" - # - BaseSwarm: "swarms/structs/base_swarm.md" - - BaseWorkflow: "swarms/structs/baseworkflow.md" - - Workflows: - - ConcurrentWorkflow: "swarms/structs/concurrentworkflow.md" - - SequentialWorkflow: "swarms/structs/sequential_workflow.md" - - Multi Agent Architectures: - - Conversation: "swarms/structs/conversation.md" - - SwarmNetwork: "swarms/structs/swarmnetwork.md" - - MajorityVoting: "swarms/structs/majorityvoting.md" - - AgentRearrange: "swarms/structs/agent_rearrange.md" - - RoundRobin: "swarms/structs/round_robin_swarm.md" + - Reference: + - Overview: "swarms/index.md" + - Framework Structure: "swarms/structs/tree.md" + - swarms.models: + - How to Create A Custom Language Model: "swarms/models/custom_model.md" + - Deploying Azure OpenAI in Production A Comprehensive Guide: "swarms/models/azure_openai.md" + - Language Models: + - BaseLLM: "swarms/models/base_llm.md" + - Overview: "swarms/models/index.md" + - HuggingFaceLLM: "swarms/models/huggingface.md" + - Anthropic: "swarms/models/anthropic.md" + - OpenAIChat: "swarms/models/openai.md" + - MultiModal Models : + - BaseMultiModalModel: "swarms/models/base_multimodal_model.md" + - Fuyu: "swarms/models/fuyu.md" + - Vilt: "swarms/models/vilt.md" + - Idefics: "swarms/models/idefics.md" + - Kosmos: "swarms/models/kosmos.md" + - Nougat: "swarms/models/nougat.md" + - Dalle3: "swarms/models/dalle3.md" + - GPT4VisionAPI: "swarms/models/gpt4v.md" + - GPT4o: "swarms/models/gpt4o.md" + - swarms.structs: + - Foundational Structures: + - Agent: "swarms/structs/agent.md" + - BaseStructure: "swarms/structs/basestructure.md" + - Task: "swarms/structs/task.md" + - YamlModel: "swarms/structs/yaml_model.md" + # - BaseSwarm: "swarms/structs/base_swarm.md" + - BaseWorkflow: "swarms/structs/baseworkflow.md" + - Workflows: + - ConcurrentWorkflow: "swarms/structs/concurrentworkflow.md" + - SequentialWorkflow: "swarms/structs/sequential_workflow.md" + - Multi Agent Architectures: + - Conversation: "swarms/structs/conversation.md" + - SwarmNetwork: "swarms/structs/swarmnetwork.md" + - 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" @@ -169,4 +169,4 @@ nav: - DIY Build Your Own Agent: "diy_your_own_agent.md" - Equipping Autonomous Agents with Tools: "examples/tools_agent.md" - Swarms: - - SequentialWorkflow: "examples/reliable_autonomous_agents.md" \ No newline at end of file + - SequentialWorkflow: "examples/reliable_autonomous_agents.md" From 12c0919b98bc704f0cbe945feafa586679077d02 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Thu, 6 Jun 2024 21:14:39 -0600 Subject: [PATCH 19/43] indent 4 --- docs/mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 1f1e6a0c..f7f8d2a4 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -104,7 +104,7 @@ nav: - Memory: - Building Custom Vector Memory Databases with the BaseVectorDatabase Class: "swarms/memory/diy_memory.md" - ShortTermMemory: "swarms/memory/short_term_memory.md" - - Multi-Agent Collaboration: + - Multi-Agent Collaboration: - SwarmNetwork: "swarms/structs/swarmnetwork.md" - AgentRearrange: "swarms/structs/agent_rearrange.md" - Why does Swarms Exist?: From 4f8b2720ba092dfce330b5a6b8da393f2a85ea10 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Thu, 6 Jun 2024 21:16:04 -0600 Subject: [PATCH 20/43] indent 5 --- docs/mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index f7f8d2a4..957fd8ac 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -107,7 +107,7 @@ nav: - Multi-Agent Collaboration: - SwarmNetwork: "swarms/structs/swarmnetwork.md" - AgentRearrange: "swarms/structs/agent_rearrange.md" - - Why does Swarms Exist?: + - Why does Swarms Exist?: - References: - Agent Glossary: "swarms/glossary.md" - List of The Best Multi-Agent Papers: "swarms/papers.md" From 62e6460833a73af354a130454a9501c8e9504f3a Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Thu, 6 Jun 2024 21:17:50 -0600 Subject: [PATCH 21/43] dedent --- docs/mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 957fd8ac..f4c5e446 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -108,7 +108,7 @@ nav: - SwarmNetwork: "swarms/structs/swarmnetwork.md" - AgentRearrange: "swarms/structs/agent_rearrange.md" - Why does Swarms Exist?: - - References: + - References: - Agent Glossary: "swarms/glossary.md" - List of The Best Multi-Agent Papers: "swarms/papers.md" - Contributors: From ac72c62c9e0c02f9da939ccc6c2a91bf8a20a841 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Thu, 6 Jun 2024 21:28:15 -0600 Subject: [PATCH 22/43] mkdocs cleanup --- docs/mkdocs.yml | 110 ++++++++++++++++++++++++------------------------ 1 file changed, 55 insertions(+), 55 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index f4c5e446..84329695 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -16,7 +16,7 @@ plugins: - mkdocs-jupyter: kernel_name: python3 execute: false - include_source: True + include_source: true include_requirejs: true - mkdocstrings: default_handler: python @@ -105,68 +105,68 @@ nav: - Building Custom Vector Memory Databases with the BaseVectorDatabase Class: "swarms/memory/diy_memory.md" - ShortTermMemory: "swarms/memory/short_term_memory.md" - Multi-Agent Collaboration: - - SwarmNetwork: "swarms/structs/swarmnetwork.md" - - AgentRearrange: "swarms/structs/agent_rearrange.md" + - SwarmNetwork: "swarms/structs/swarmnetwork.md" + - AgentRearrange: "swarms/structs/agent_rearrange.md" - Why does Swarms Exist?: - References: - - Agent Glossary: "swarms/glossary.md" - - List of The Best Multi-Agent Papers: "swarms/papers.md" - - Contributors: - - Contributing: "contributing.md" - - Reference: + - Agent Glossary: "swarms/glossary.md" + - List of The Best Multi-Agent Papers: "swarms/papers.md" + - Contributors: + - Contributing: "contributing.md" + - Reference: - Overview: "swarms/index.md" - Framework Structure: "swarms/structs/tree.md" - swarms.models: - - How to Create A Custom Language Model: "swarms/models/custom_model.md" - - Deploying Azure OpenAI in Production A Comprehensive Guide: "swarms/models/azure_openai.md" - - Language Models: - - BaseLLM: "swarms/models/base_llm.md" - - Overview: "swarms/models/index.md" - - HuggingFaceLLM: "swarms/models/huggingface.md" - - Anthropic: "swarms/models/anthropic.md" - - OpenAIChat: "swarms/models/openai.md" - - MultiModal Models : - - BaseMultiModalModel: "swarms/models/base_multimodal_model.md" - - Fuyu: "swarms/models/fuyu.md" - - Vilt: "swarms/models/vilt.md" - - Idefics: "swarms/models/idefics.md" - - Kosmos: "swarms/models/kosmos.md" - - Nougat: "swarms/models/nougat.md" - - Dalle3: "swarms/models/dalle3.md" - - GPT4VisionAPI: "swarms/models/gpt4v.md" - - GPT4o: "swarms/models/gpt4o.md" + - How to Create A Custom Language Model: "swarms/models/custom_model.md" + - Deploying Azure OpenAI in Production A Comprehensive Guide: "swarms/models/azure_openai.md" + - Language Models: + - BaseLLM: "swarms/models/base_llm.md" + - Overview: "swarms/models/index.md" + - HuggingFaceLLM: "swarms/models/huggingface.md" + - Anthropic: "swarms/models/anthropic.md" + - OpenAIChat: "swarms/models/openai.md" + - MultiModal Models: + - BaseMultiModalModel: "swarms/models/base_multimodal_model.md" + - Fuyu: "swarms/models/fuyu.md" + - Vilt: "swarms/models/vilt.md" + - Idefics: "swarms/models/idefics.md" + - Kosmos: "swarms/models/kosmos.md" + - Nougat: "swarms/models/nougat.md" + - Dalle3: "swarms/models/dalle3.md" + - GPT4VisionAPI: "swarms/models/gpt4v.md" + - GPT4o: "swarms/models/gpt4o.md" - swarms.structs: - Foundational Structures: - - Agent: "swarms/structs/agent.md" - - BaseStructure: "swarms/structs/basestructure.md" - - Task: "swarms/structs/task.md" - - YamlModel: "swarms/structs/yaml_model.md" - # - BaseSwarm: "swarms/structs/base_swarm.md" - - BaseWorkflow: "swarms/structs/baseworkflow.md" + - Agent: "swarms/structs/agent.md" + - BaseStructure: "swarms/structs/basestructure.md" + - Task: "swarms/structs/task.md" + - YamlModel: "swarms/structs/yaml_model.md" + # - BaseSwarm: "swarms/structs/base_swarm.md" + - BaseWorkflow: "swarms/structs/baseworkflow.md" - Workflows: - - ConcurrentWorkflow: "swarms/structs/concurrentworkflow.md" - - SequentialWorkflow: "swarms/structs/sequential_workflow.md" + - ConcurrentWorkflow: "swarms/structs/concurrentworkflow.md" + - SequentialWorkflow: "swarms/structs/sequential_workflow.md" - Multi Agent Architectures: - - Conversation: "swarms/structs/conversation.md" - - SwarmNetwork: "swarms/structs/swarmnetwork.md" - - MajorityVoting: "swarms/structs/majorityvoting.md" - - AgentRearrange: "swarms/structs/agent_rearrange.md" - - RoundRobin: "swarms/structs/round_robin_swarm.md" + - Conversation: "swarms/structs/conversation.md" + - SwarmNetwork: "swarms/structs/swarmnetwork.md" + - 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" + - 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: - # - Building Custom Vector Memory Databases with the BaseVectorDatabase Class: "swarms/memory/diy_memory.md" - - Models: - - How to Create A Custom Language Model: "swarms/models/custom_model.md" - - Deploying Azure OpenAI in Production, A Comprehensive Guide: "swarms/models/azure_openai.md" - - Agents: - - Agent: "examples/flow.md" - - DIY Build Your Own Agent: "diy_your_own_agent.md" - - Equipping Autonomous Agents with Tools: "examples/tools_agent.md" - - Swarms: - - SequentialWorkflow: "examples/reliable_autonomous_agents.md" + # - Building Custom Vector Memory Databases with the BaseVectorDatabase Class: "swarms/memory/diy_memory.md" + - Models: + - How to Create A Custom Language Model: "swarms/models/custom_model.md" + - Deploying Azure OpenAI in Production, A Comprehensive Guide: "swarms/models/azure_openai.md" + - Agents: + - Agent: "examples/flow.md" + - DIY Build Your Own Agent: "diy_your_own_agent.md" + - Equipping Autonomous Agents with Tools: "examples/tools_agent.md" + - Swarms: + - SequentialWorkflow: "examples/reliable_autonomous_agents.md" From 9544b97b16775163746b6eb3d97af3bee2a5d01f Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Thu, 6 Jun 2024 21:30:50 -0600 Subject: [PATCH 23/43] tidy mkdocs --- docs/mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 84329695..06e6dfe3 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -145,7 +145,7 @@ nav: - BaseWorkflow: "swarms/structs/baseworkflow.md" - Workflows: - ConcurrentWorkflow: "swarms/structs/concurrentworkflow.md" - - SequentialWorkflow: "swarms/structs/sequential_workflow.md" + - SequentialWorkflow: "swarms/structs/sequential_workflow.md" - Multi Agent Architectures: - Conversation: "swarms/structs/conversation.md" - SwarmNetwork: "swarms/structs/swarmnetwork.md" From a88ac53c450ebf23e54f09ed8cb0a7efb787a2c1 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Fri, 7 Jun 2024 10:22:25 -0600 Subject: [PATCH 24/43] copyright mkdocs --- docs/mkdocs.yml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index a2c41300..d2c2b582 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,4 +1,3 @@ - docs_dir: '.' # replace with the correct path if your documentation files are not in the same directory as mkdocs.yml site_name: Swarms Documentation site_url: https://swarms.world @@ -7,8 +6,7 @@ site_description: "Orchestrate Swarms of Agents From Any Framework Like OpenAI, repo_name: kyegomez/swarms repo_url: https://github.com/kyegomez/swarms edit_uri: https://github.com/kyegomez/swarms/tree/main/docs -copyright: TGSC Corp 2024. All rights reserved. - +copyright: "© TGSC Corp 2024. All rights reserved."" plugins: # - glightbox @@ -42,7 +40,7 @@ plugins: - git-revision-date-localized: enable_creation_date: true -copyright: "© TGSC, Corporation." + extra_css: - assets/css/extra.css extra: From 706174d495ce0cc0d0dc830733b18588f2cb8e0a Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Fri, 7 Jun 2024 10:25:16 -0600 Subject: [PATCH 25/43] move copyright line mkdocs --- docs/mkdocs.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index d2c2b582..ca90edb5 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,4 +1,5 @@ docs_dir: '.' # replace with the correct path if your documentation files are not in the same directory as mkdocs.yml +copyright: "© TGSC Corp 2024. All rights reserved." site_name: Swarms Documentation site_url: https://swarms.world site_author: Swarms @@ -6,7 +7,6 @@ site_description: "Orchestrate Swarms of Agents From Any Framework Like OpenAI, repo_name: kyegomez/swarms repo_url: https://github.com/kyegomez/swarms edit_uri: https://github.com/kyegomez/swarms/tree/main/docs -copyright: "© TGSC Corp 2024. All rights reserved."" plugins: # - glightbox @@ -103,7 +103,6 @@ nav: - Why does Swarms Exist?: - Why Swarms? Orchestrating Agents for Enterprise Automation: "why.md" - Limitations of Individual Agents: "limits_of_individual_agents.md" - - Swarms Cloud API: - Overview: "swarms_cloud/main.md" - Available Models: "swarms_cloud/available_models.md" From 0e5d69b71990fe6762bbbd7b79a9c7ff333d7b41 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Fri, 7 Jun 2024 10:29:25 -0600 Subject: [PATCH 26/43] indentation nav --- docs/mkdocs.yml | 198 ++++++++++++++++++++++++------------------------ 1 file changed, 99 insertions(+), 99 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index ca90edb5..2041b0ab 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -92,104 +92,104 @@ markdown_extensions: - def_list - footnotes nav: -- Home: - - Installation: - - Overview: "index.md" - - Install: "install.md" - - Docker Setup: docker_setup.md - - Usage Examples: - - Build an Agent: "diy_your_own_agent.md" - - Build an Agent with tools: "examples/tools_agents.md" - - Why does Swarms Exist?: - - Why Swarms? Orchestrating Agents for Enterprise Automation: "why.md" - - Limitations of Individual Agents: "limits_of_individual_agents.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" -- Swarms Framework [PY]: - - Overview: "swarms/index.md" - - DIY Build Your Own Agent: "diy_your_own_agent.md" - - Agents with Tools: "examples/tools_agent.md" - - swarms.models: - - How to Create A Custom Language Model: "swarms/models/custom_model.md" - - Deploying Azure OpenAI in Production A Comprehensive Guide: "swarms/models/azure_openai.md" - - Language: - - BaseLLM: "swarms/models/base_llm.md" - - Overview: "swarms/models/index.md" - - Llava3: "swarms/models/llama3.md" - - HuggingFaceLLM: "swarms/models/huggingface.md" - - Anthropic: "swarms/models/anthropic.md" - - OpenAI: "swarms/models/openai.md" - - Mistral: "swarms/models/mistral.md" - - Mixtral: "swarms/models/mixtral.md" - - MultiModal: - - BaseMultiModalModel: "swarms/models/base_multimodal_model.md" - - Fuyu: "swarms/models/fuyu.md" - - Vilt: "swarms/models/vilt.md" - - Idefics: "swarms/models/idefics.md" - - Kosmos: "swarms/models/kosmos.md" - - Nougat: "swarms/models/nougat.md" - - Dalle3: "swarms/models/dalle3.md" - - GPT4V: "swarms/models/gpt4v.md" - - DistilWhisperModel: "swarms/models/distilled_whisperx.md" - - swarms.structs: - - Foundational Structures: - - Agent: "swarms/structs/agent.md" - - BaseStructure: "swarms/structs/basestructure.md" - - Task: "swarms/structs/task.md" - - YamlModel: "swarms/structs/yaml_model.md" - - Workflows: - - ConcurrentWorkflow: "swarms/structs/concurrentworkflow.md" - - SequentialWorkflow: "swarms/structs/sequential_workflow.md" - - BaseWorkflow: "swarms/structs/baseworkflow.md" - - Multi Agent Architectures: - - Conversation: "swarms/structs/conversation.md" - - SwarmNetwork: "swarms/structs/swarmnetwork.md" - - MajorityVoting: "swarms/structs/majorityvoting.md" - - AgentRearrange: "swarms/structs/agent_rearrange.md" - - RoundRobin: "swarms/structs/round_robin_swarm.md" - - swarms.memory: - - Building Custom Vector Memory Databases with the BaseVectorDatabase Class: "swarms/memory/diy_memory.md" - - ShortTermMemory: "swarms/memory/short_term_memory.md" -- Guides: - - Agents: - - Building Custom Vector Memory Databases with the BaseVectorDatabase Class: "swarms/memory/diy_memory.md" - - How to Create A Custom Language Model: "swarms/models/custom_model.md" - - Deploying Azure OpenAI in Production, A Comprehensive Guide: "swarms/models/azure_openai.md" + - Home: + - Installation: + - Overview: "index.md" + - Install: "install.md" + - Docker Setup: docker_setup.md + - Usage Examples: + - Build an Agent: "diy_your_own_agent.md" + - Build an Agent with tools: "examples/tools_agents.md" + - Why does Swarms Exist?: + - Why Swarms? Orchestrating Agents for Enterprise Automation: "why.md" + - Limitations of Individual Agents: "limits_of_individual_agents.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" + - Swarms Framework [PY]: + - Overview: "swarms/index.md" - DIY Build Your Own Agent: "diy_your_own_agent.md" - - Equipping Autonomous Agents with Tools: "examples/tools_agent.md" - - Overview: "examples/index.md" + - Agents with Tools: "examples/tools_agent.md" + - swarms.models: + - How to Create A Custom Language Model: "swarms/models/custom_model.md" + - Deploying Azure OpenAI in Production A Comprehensive Guide: "swarms/models/azure_openai.md" + - Language: + - BaseLLM: "swarms/models/base_llm.md" + - Overview: "swarms/models/index.md" + - Llava3: "swarms/models/llama3.md" + - HuggingFaceLLM: "swarms/models/huggingface.md" + - Anthropic: "swarms/models/anthropic.md" + - OpenAI: "swarms/models/openai.md" + - Mistral: "swarms/models/mistral.md" + - Mixtral: "swarms/models/mixtral.md" + - MultiModal: + - BaseMultiModalModel: "swarms/models/base_multimodal_model.md" + - Fuyu: "swarms/models/fuyu.md" + - Vilt: "swarms/models/vilt.md" + - Idefics: "swarms/models/idefics.md" + - Kosmos: "swarms/models/kosmos.md" + - Nougat: "swarms/models/nougat.md" + - Dalle3: "swarms/models/dalle3.md" + - GPT4V: "swarms/models/gpt4v.md" + - DistilWhisperModel: "swarms/models/distilled_whisperx.md" + - swarms.structs: + - Foundational Structures: + - Agent: "swarms/structs/agent.md" + - BaseStructure: "swarms/structs/basestructure.md" + - Task: "swarms/structs/task.md" + - YamlModel: "swarms/structs/yaml_model.md" + - Workflows: + - ConcurrentWorkflow: "swarms/structs/concurrentworkflow.md" + - SequentialWorkflow: "swarms/structs/sequential_workflow.md" + - BaseWorkflow: "swarms/structs/baseworkflow.md" + - Multi Agent Architectures: + - Conversation: "swarms/structs/conversation.md" + - SwarmNetwork: "swarms/structs/swarmnetwork.md" + - MajorityVoting: "swarms/structs/majorityvoting.md" + - AgentRearrange: "swarms/structs/agent_rearrange.md" + - RoundRobin: "swarms/structs/round_robin_swarm.md" + - swarms.memory: + - Building Custom Vector Memory Databases with the BaseVectorDatabase Class: "swarms/memory/diy_memory.md" + - ShortTermMemory: "swarms/memory/short_term_memory.md" + - Guides: - Agents: - - Agent: "examples/flow.md" - - OmniAgent: "examples/omni_agent.md" - - Swarms: - - SequentialWorkflow: "examples/reliable_autonomous_agents.md" - - 2O+ Autonomous Agent Blogs: "examples/ideas.md" -- Applications: - - CustomerSupport: - - Overview: "applications/customer_support.md" - - Marketing: - - Overview: "applications/marketing_agencies.md" - - Operations: - - Intoducing The Swarm of Automated Business Analyts: "applications/business-analyst-agent.md" -- Corporate: - - Corporate Documents: - - Data Room: "corporate/data_room.md" - - The Swarm Memo: "corporate/swarm_memo.md" - - Corporate Architecture: "corporate/architecture.md" - - Flywheel: "corporate/flywheel.md" - - Sales: - - FAQ: "corporate/faq.md" - - Distribution: "corporate/distribution" - - Product: - - SwarmCloud: "corporate/swarm_cloud.md" - - Weaknesses of Langchain: "corporate/failures.md" - - Design: "corporate/design.md" - - Metric: "corporate/metric.md" - - Organization: - - FrontEnd Member Onboarding: "corporate/front_end_contributors.md" -- Contributors: - - Contributing: "contributing.md" + - Building Custom Vector Memory Databases with the BaseVectorDatabase Class: "swarms/memory/diy_memory.md" + - How to Create A Custom Language Model: "swarms/models/custom_model.md" + - Deploying Azure OpenAI in Production, A Comprehensive Guide: "swarms/models/azure_openai.md" + - DIY Build Your Own Agent: "diy_your_own_agent.md" + - Equipping Autonomous Agents with Tools: "examples/tools_agent.md" + - Overview: "examples/index.md" + - Agents: + - Agent: "examples/flow.md" + - OmniAgent: "examples/omni_agent.md" + - Swarms: + - SequentialWorkflow: "examples/reliable_autonomous_agents.md" + - 2O+ Autonomous Agent Blogs: "examples/ideas.md" + - Applications: + - CustomerSupport: + - Overview: "applications/customer_support.md" + - Marketing: + - Overview: "applications/marketing_agencies.md" + - Operations: + - Intoducing The Swarm of Automated Business Analyts: "applications/business-analyst-agent.md" + - Corporate: + - Corporate Documents: + - Data Room: "corporate/data_room.md" + - The Swarm Memo: "corporate/swarm_memo.md" + - Corporate Architecture: "corporate/architecture.md" + - Flywheel: "corporate/flywheel.md" + - Sales: + - FAQ: "corporate/faq.md" + - Distribution: "corporate/distribution" + - Product: + - SwarmCloud: "corporate/swarm_cloud.md" + - Weaknesses of Langchain: "corporate/failures.md" + - Design: "corporate/design.md" + - Metric: "corporate/metric.md" + - Organization: + - FrontEnd Member Onboarding: "corporate/front_end_contributors.md" + - Contributors: + - Contributing: "contributing.md" From 553647d82a0a0a2b1a09be88c921d486a14cb2dc Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Fri, 7 Jun 2024 10:46:16 -0600 Subject: [PATCH 27/43] move plugins comment mkdocs.yml --- docs/mkdocs.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 2041b0ab..e040b7bb 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -9,8 +9,7 @@ repo_url: https://github.com/kyegomez/swarms edit_uri: https://github.com/kyegomez/swarms/tree/main/docs plugins: - # - glightbox - - search + - search # - glightbox - git-authors - mkdocs-jupyter: kernel_name: python3 From b7bd7382ffb4e37057c52e302f1c047c8af53510 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Fri, 7 Jun 2024 10:50:50 -0600 Subject: [PATCH 28/43] trying mkdocs-search in gh actions --- .github/workflows/docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index d2a2e498..875d1582 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -22,4 +22,5 @@ jobs: - run: pip install --upgrade lxml_html_clean - run: pip install mkdocs-git-committers-plugin - run: pip3 install mkdocs-git-revision-date-localized-plugin + - run: pip install mkdocs-search - run: mkdocs gh-deploy --force -f docs/mkdocs.yml From ada6ac2d906c4bd414ae75723c79d4c24a4bbfc1 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Fri, 7 Jun 2024 10:53:22 -0600 Subject: [PATCH 29/43] revert search --- .github/workflows/docs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 875d1582..d2a2e498 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -22,5 +22,4 @@ jobs: - run: pip install --upgrade lxml_html_clean - run: pip install mkdocs-git-committers-plugin - run: pip3 install mkdocs-git-revision-date-localized-plugin - - run: pip install mkdocs-search - run: mkdocs gh-deploy --force -f docs/mkdocs.yml From ce7fdf25ecb3221ad33a015280e61e8fff7a0e0c Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Fri, 7 Jun 2024 13:03:02 -0600 Subject: [PATCH 30/43] Changed order of plugin install in gh a to match mkdocs.yml --- .github/workflows/docs.yml | 3 +-- docs/mkdocs.yml | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index d2a2e498..3bbbe63b 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -15,10 +15,9 @@ jobs: python-version: "3.10" - run: pip install mkdocs-material - run: pip install mkdocs-same-dir - - run: pip install mkdocs-glightbox - - run: pip install "mkdocstrings[python]" - run: pip3 install mkdocs-git-authors-plugin - run: pip install mkdocs-jupyter==0.16.0 + - run: pip install "mkdocstrings[python]" - run: pip install --upgrade lxml_html_clean - run: pip install mkdocs-git-committers-plugin - run: pip3 install mkdocs-git-revision-date-localized-plugin diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index e040b7bb..22d310a7 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -9,7 +9,7 @@ repo_url: https://github.com/kyegomez/swarms edit_uri: https://github.com/kyegomez/swarms/tree/main/docs plugins: - - search # - glightbox + - search - git-authors - mkdocs-jupyter: kernel_name: python3 From bdb95683e762bc67fc287d3c056bd656caa7fdd5 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Fri, 7 Jun 2024 13:10:13 -0600 Subject: [PATCH 31/43] simplify to find bad plugin conf 1 --- docs/mkdocs.yml | 56 ++++++++++++++++++++++++------------------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 22d310a7..0a20c1cc 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -10,34 +10,34 @@ edit_uri: https://github.com/kyegomez/swarms/tree/main/docs plugins: - search - - git-authors - - mkdocs-jupyter: - kernel_name: python3 - execute: false - include_source: true - include_requirejs: true - - mkdocstrings: - default_handler: python - handlers: - python: - options: - parameter_headings: true - paths: [supervision] - load_external_modules: true - allow_inspection: true - show_bases: true - group_by_category: true - docstring_style: google - show_symbol_type_heading: true - show_symbol_type_toc: true - show_category_heading: true - domains: [std, py] - - git-committers: - repository: kyegomez/swarms - branch: master - # token: !ENV ["GITHUB_TOKEN"] - - git-revision-date-localized: - enable_creation_date: true + # - git-authors + # - mkdocs-jupyter: + # kernel_name: python3 + # execute: false + # include_source: true + # include_requirejs: true + # - mkdocstrings: + # default_handler: python + # handlers: + # python: + # options: + # parameter_headings: true + # paths: [supervision] + # load_external_modules: true + # allow_inspection: true + # show_bases: true + # group_by_category: true + # docstring_style: google + # show_symbol_type_heading: true + # show_symbol_type_toc: true + # show_category_heading: true + # domains: [std, py] + # - git-committers: + # repository: kyegomez/swarms + # branch: master + # # token: !ENV ["GITHUB_TOKEN"] + # - git-revision-date-localized: + # enable_creation_date: true extra_css: From fb27273a73b6dc64d78c7275c66fea2638892c1d Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Fri, 7 Jun 2024 13:13:45 -0600 Subject: [PATCH 32/43] add same-dir to plugins --- docs/mkdocs.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 0a20c1cc..8143f065 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -9,7 +9,8 @@ repo_url: https://github.com/kyegomez/swarms edit_uri: https://github.com/kyegomez/swarms/tree/main/docs plugins: - - search + - search + - same-dir # - git-authors # - mkdocs-jupyter: # kernel_name: python3 From b4607f9f53488111f57a4bdcac41f7a9cd690d6b Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Fri, 7 Jun 2024 13:16:14 -0600 Subject: [PATCH 33/43] uncomment plugins --- docs/mkdocs.yml | 56 ++++++++++++++++++++++++------------------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 8143f065..51fb1d05 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -11,34 +11,34 @@ edit_uri: https://github.com/kyegomez/swarms/tree/main/docs plugins: - search - same-dir - # - git-authors - # - mkdocs-jupyter: - # kernel_name: python3 - # execute: false - # include_source: true - # include_requirejs: true - # - mkdocstrings: - # default_handler: python - # handlers: - # python: - # options: - # parameter_headings: true - # paths: [supervision] - # load_external_modules: true - # allow_inspection: true - # show_bases: true - # group_by_category: true - # docstring_style: google - # show_symbol_type_heading: true - # show_symbol_type_toc: true - # show_category_heading: true - # domains: [std, py] - # - git-committers: - # repository: kyegomez/swarms - # branch: master - # # token: !ENV ["GITHUB_TOKEN"] - # - git-revision-date-localized: - # enable_creation_date: true + - git-authors + - mkdocs-jupyter: + kernel_name: python3 + execute: false + include_source: true + include_requirejs: true + - mkdocstrings: + default_handler: python + handlers: + python: + options: + parameter_headings: true + paths: [supervision] + load_external_modules: true + allow_inspection: true + show_bases: true + group_by_category: true + docstring_style: google + show_symbol_type_heading: true + show_symbol_type_toc: true + show_category_heading: true + domains: [std, py] + - git-committers: + repository: kyegomez/swarms + branch: master + # token: !ENV ["GITHUB_TOKEN"] + - git-revision-date-localized: + enable_creation_date: true extra_css: From 0bbff88ef91693cdd240e291cdce3b45cda5d6ce Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Fri, 7 Jun 2024 13:19:09 -0600 Subject: [PATCH 34/43] plugin git-authors --- docs/mkdocs.yml | 54 ++++++++++++++++++++++++------------------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 51fb1d05..eaed697d 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -12,33 +12,33 @@ plugins: - search - same-dir - git-authors - - mkdocs-jupyter: - kernel_name: python3 - execute: false - include_source: true - include_requirejs: true - - mkdocstrings: - default_handler: python - handlers: - python: - options: - parameter_headings: true - paths: [supervision] - load_external_modules: true - allow_inspection: true - show_bases: true - group_by_category: true - docstring_style: google - show_symbol_type_heading: true - show_symbol_type_toc: true - show_category_heading: true - domains: [std, py] - - git-committers: - repository: kyegomez/swarms - branch: master - # token: !ENV ["GITHUB_TOKEN"] - - git-revision-date-localized: - enable_creation_date: true + # - mkdocs-jupyter: + # kernel_name: python3 + # execute: false + # include_source: true + # include_requirejs: true + # - mkdocstrings: + # default_handler: python + # handlers: + # python: + # options: + # parameter_headings: true + # paths: [supervision] + # load_external_modules: true + # allow_inspection: true + # show_bases: true + # group_by_category: true + # docstring_style: google + # show_symbol_type_heading: true + # show_symbol_type_toc: true + # show_category_heading: true + # domains: [std, py] + # - git-committers: + # repository: kyegomez/swarms + # branch: master + # # token: !ENV ["GITHUB_TOKEN"] + # - git-revision-date-localized: + # enable_creation_date: true extra_css: From cabe8668aa9653f59d168019a0e6afb13f2a8df4 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Fri, 7 Jun 2024 13:20:59 -0600 Subject: [PATCH 35/43] add mkdocs-jupyter --- docs/mkdocs.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index eaed697d..21c75544 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -12,11 +12,11 @@ plugins: - search - same-dir - git-authors - # - mkdocs-jupyter: - # kernel_name: python3 - # execute: false - # include_source: true - # include_requirejs: true + - mkdocs-jupyter: + kernel_name: python3 + execute: false + include_source: true + include_requirejs: true # - mkdocstrings: # default_handler: python # handlers: From 1e240732006bd9999120ede9720c1ebe6e1a01fb Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Fri, 7 Jun 2024 13:25:08 -0600 Subject: [PATCH 36/43] change indentation mkdocs-juypter plugin --- docs/mkdocs.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 21c75544..9473fd0d 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -13,10 +13,10 @@ plugins: - same-dir - git-authors - mkdocs-jupyter: - kernel_name: python3 - execute: false - include_source: true - include_requirejs: true + kernel_name: python3 + execute: false + include_source: true + include_requirejs: true # - mkdocstrings: # default_handler: python # handlers: From d98c42d384e613d4e78abe634ef2ea3ad3e7d84d Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Fri, 7 Jun 2024 13:29:38 -0600 Subject: [PATCH 37/43] remove unneeded option mkdocs-juypter --- docs/mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 9473fd0d..8e61290f 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -14,7 +14,7 @@ plugins: - git-authors - mkdocs-jupyter: kernel_name: python3 - execute: false + #execute: false # default include_source: true include_requirejs: true # - mkdocstrings: From 3b56cb7189562cc91247a37b3c7ef97fd149174a Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Fri, 7 Jun 2024 15:44:29 -0600 Subject: [PATCH 38/43] comment out jupyter add in mkdocstrings --- docs/mkdocs.yml | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 8e61290f..e6f881e0 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -12,27 +12,27 @@ plugins: - search - same-dir - git-authors - - mkdocs-jupyter: - kernel_name: python3 - #execute: false # default - include_source: true - include_requirejs: true - # - mkdocstrings: - # default_handler: python - # handlers: - # python: - # options: - # parameter_headings: true - # paths: [supervision] - # load_external_modules: true - # allow_inspection: true - # show_bases: true - # group_by_category: true - # docstring_style: google - # show_symbol_type_heading: true - # show_symbol_type_toc: true - # show_category_heading: true - # domains: [std, py] + # - mkdocs-jupyter: + # kernel_name: python3 + # #execute: false # default + # include_source: true + # include_requirejs: true + - mkdocstrings: + default_handler: python + handlers: + python: + options: + parameter_headings: true + paths: [supervision] + load_external_modules: true + allow_inspection: true + show_bases: true + group_by_category: true + docstring_style: google + show_symbol_type_heading: true + show_symbol_type_toc: true + show_category_heading: true + domains: [std, py] # - git-committers: # repository: kyegomez/swarms # branch: master From 6274c5948128410af525b8bcfb452046366db855 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Fri, 7 Jun 2024 15:48:23 -0600 Subject: [PATCH 39/43] add git back in --- docs/mkdocs.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index e6f881e0..4db4527b 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -33,12 +33,12 @@ plugins: show_symbol_type_toc: true show_category_heading: true domains: [std, py] - # - git-committers: - # repository: kyegomez/swarms - # branch: master - # # token: !ENV ["GITHUB_TOKEN"] - # - git-revision-date-localized: - # enable_creation_date: true + - git-committers: + repository: kyegomez/swarms + branch: master + # token: !ENV ["GITHUB_TOKEN"] + - git-revision-date-localized: + enable_creation_date: true extra_css: From 36db89f26b21e572995d83e8ff484dc83b4a610d Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Tue, 11 Jun 2024 17:00:06 -0600 Subject: [PATCH 40/43] remove mkdocs-jupyter pin --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 3bbbe63b..13a4202c 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -16,7 +16,7 @@ jobs: - run: pip install mkdocs-material - run: pip install mkdocs-same-dir - run: pip3 install mkdocs-git-authors-plugin - - run: pip install mkdocs-jupyter==0.16.0 + - run: pip install mkdocs-jupyter - run: pip install "mkdocstrings[python]" - run: pip install --upgrade lxml_html_clean - run: pip install mkdocs-git-committers-plugin From da9dbd27adab9c58fc5836d568bc4581a6d6f303 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Tue, 11 Jun 2024 17:03:06 -0600 Subject: [PATCH 41/43] add mkd-jupy back in --- docs/mkdocs.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index a624faba..618bfef3 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -12,11 +12,11 @@ plugins: - search - same-dir - git-authors - # - mkdocs-jupyter: - # kernel_name: python3 - # #execute: false # default - # include_source: true - # include_requirejs: true + - mkdocs-jupyter: + kernel_name: python3 + #execute: false # default + include_source: true + include_requirejs: true - mkdocstrings: default_handler: python handlers: From 5dc18e33f8595f3a0430d2238d4a031735676705 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Wed, 12 Jun 2024 18:36:11 -0600 Subject: [PATCH 42/43] fix some mkdocs nav warnings --- docs/mkdocs.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 618bfef3..1e4ddfdc 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -103,15 +103,15 @@ nav: - Agents with tools: "swarms/tools/main.md" - Multi-Agent Collaboration: - Overview: "swarms/structs/multi_agent_orchestration.md" - - Workflows: "swarms/structs/workflows.md" - - Multi-Agent Architectures: "swarms/structs/multi_agent_architectures.md" + - Workflows: "swarms/structs/workflow.md" + - Multi-Agent Architectures: "swarms/structs/multi_agent_orchestration.md" - Reference: - Overview: "swarms/framework_structure.md" - Models: - How to Create A Custom Language Model: "swarms/models/custom_model.md" - Models Available: "swarms/models/index.md" - - MultiModal Models Available: "swarms/models/multimodal_models.md" - - Deploying Azure OpenAI in Production A Comprehensive Guide: "swarms/models/azure_openai.md" + # - MultiModal Models Available: "swarms/models/multimodal_models.md" + # - Deploying Azure OpenAI in Production A Comprehensive Guide: "swarms/models/azure_openai.md" - Language Models: - BaseLLM: "swarms/models/base_llm.md" - HuggingFaceLLM: "swarms/models/huggingface.md" @@ -161,7 +161,7 @@ nav: - Guides: - Models: - How to Create A Custom Language Model: "swarms/models/custom_model.md" - - Deploying Azure OpenAI in Production, A Comprehensive Guide: "swarms/models/azure_openai.md" + # - Deploying Azure OpenAI in Production, A Comprehensive Guide: "swarms/models/azure_openai.md" - Agents: - Agent: "examples/flow.md" - DIY Build Your Own Agent: "diy_your_own_agent.md" From 02348fe25d86e9b36a9254ce68940f785c5b9234 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Wed, 12 Jun 2024 18:54:09 -0600 Subject: [PATCH 43/43] mkdocs nav cleanup --- docs/mkdocs.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 1e4ddfdc..21298155 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -164,10 +164,10 @@ nav: # - Deploying Azure OpenAI in Production, A Comprehensive Guide: "swarms/models/azure_openai.md" - Agents: - Agent: "examples/flow.md" - - DIY Build Your Own Agent: "diy_your_own_agent.md" - - Equipping Autonomous Agents with Tools: "examples/tools_agent.md" + - DIY Build Your Own Agent: "structs/diy_your_own_agent.md" + # - Equipping Autonomous Agents with Tools: "examples/tools_agent.md" - Swarms: - - SequentialWorkflow: "examples/reliable_autonomous_agents.md" + - SequentialWorkflow: "structs/sequential_workflow.md" - References: - Agent Glossary: "swarms/glossary.md" - List of The Best Multi-Agent Papers: "swarms/papers.md" \ No newline at end of file