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.apac.ai
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
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
  - 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

copyright: "© TGSC, Corporation."
extra_css:
  - assets/css/extra.css
extra:
  social:
    - icon: fontawesome/solid/house
      link: assets/img/SwarmsLogoIcon.png
    - icon: fontawesome/brands/discord
      link: https://discord.gg/qUtxnK2NMf
    - icon: fontawesome/brands/github
      link: https://github.com/kyegomez/Swarms/
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/Swarms/
theme:
    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 
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: black
      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
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - admonition
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.tabbed
  - tables
  - 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"
    # Add an examples with building agents
    # Add multiple blogs on orchestrating agents with different types of frameworks
  - Why does Swarms Exist?:
    - Why Swarms? Orchestrating Agents for Enterprise Automation: "why.md"
    - Limitations of Individual Agents: "limits_of_individual_agents.md"
  - 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]:
  - Overview: "swarms/index.md"
  - DIY Build Your Own Agent: "diy_your_own_agent.md"
  - Agents with Tools: "examples/tools_agent.md"
  # - Multi-Agent Orchestration: "swarms/structs/multi_agent_orchestration.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 Available:
      - 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 Available:
      - 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"
  - 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.memory:
    - Building Custom Vector Memory Databases with the BaseVectorDatabase Class: "swarms/memory/diy_memory.md"
    - ShortTermMemory: "swarms/memory/short_term_memory.md"
  - swarms.tools:
    - The Swarms Tool System Functions, Pydantic BaseModels as Tools, and Radical Customization: "swarms/tools/main.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"
    - 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"