@ -1,22 +1,21 @@
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. apac.ai
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.
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
copyright : TGSC Corp 2024. All rights reserved.
plugins:
# - glightbox
- search
- same-dir
- git-authors
- mkdocs-jupyter:
kernel_name : python3
execute : false
include_source : T rue
#execute: false # default
include_source : t rue
include_requirejs : true
- mkdocstrings:
default_handler : python
@ -40,6 +39,7 @@ plugins:
# token: !ENV ["GITHUB_TOKEN"]
- git-revision-date-localized:
enable_creation_date : true
extra_css:
- assets/css/extra.css
extra:
@ -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
@ -104,15 +103,15 @@ nav:
- Agents with tools : "swarms/tools/main.md"
- Multi-Agent Collaboration :
- Overview : "swarms/structs/multi_agent_orchestration.md"
- Workflows : "swarms/structs/workflow s .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"
@ -162,13 +161,13 @@ 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"
- 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"