From c06528341b8eee3b0b0e467a8c2b5b550abf1a8c Mon Sep 17 00:00:00 2001 From: Kye Gomez Date: Sat, 8 Jun 2024 10:19:21 -0700 Subject: [PATCH] [DOCS] --- docs/mkdocs.yml | 84 +++++++++++++++++++++++-------------------------- 1 file changed, 40 insertions(+), 44 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 9c037952..3b9f5e59 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -95,7 +95,7 @@ nav: - Install: "swarms/install/install.md" - Docker Setup: "swarms/install/docker_setup.md" - Usage Examples: - - Overview: "swarms/usage/index.md" # Explains how the framework is decomposed into agents, models, and swarms + - Overview: "swarms/usage/index.md" - Models: - How to Create A Custom Language Model: "swarms/models/custom_model.md" - Models Available: "swarms/models/index.md" @@ -116,35 +116,33 @@ 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" # Explains the tree structure of the framework and where things are located - - 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: + - Reference: + - Overview: "swarms/index.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" @@ -155,22 +153,20 @@ 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: + - 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"