ai-mirow-projects
/
swarms
mirror of https://github.com/kyegomez/swarms
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS]

Browse Source
pull/491/head
Kye Gomez 8 months ago
parent c06528341b
commit ff874c7f7b
1 changed files with 67 additions and 68 deletions
Show Stats Download Patch File Download Diff File

135
docs/mkdocs.yml
Unescape View File

@ -90,83 +90,82 @@ markdown_extensions:
- footnotes - footnotes
nav: nav:
- Home: - Home:
- Installation:
- Overview: "index.md" - Overview: "index.md"
- Install: "swarms/install/install.md" - Install: "swarms/install/install.md"
- Docker Setup: "swarms/install/docker_setup.md" - Docker Setup: "swarms/install/docker_setup.md"
- Usage Examples: - Usage Examples:
- Overview: "swarms/usage/index.md" - Overview: "swarms/usage/index.md" # Explains how the framework is decomposed into agents, models, and swarms
- Models: - Models:
- How to Create A Custom Language Model: "swarms/models/custom_model.md" - How to Create A Custom Language Model: "swarms/models/custom_model.md"
- Models Available: "swarms/models/index.md" - Models Available: "swarms/models/index.md"
- MultiModal Models Available: "swarms/models/multimodal_models.md" - MultiModal Models Available: "swarms/models/multimodal_models.md"
- Agents: - Agents:
- Getting started with Agents: "swarms/structs/diy_your_own_agent.md" - Getting started with Agents: "swarms/structs/diy_your_own_agent.md"
- Tools: - Tools:
- Functions, Pydantic BaseModels, and More: "swarms/tools/main.md" - Functions, Pydantic BaseModels, and More: "swarms/tools/main.md"
- Memory: - Memory:
- Building Custom Vector Memory Databases with the BaseVectorDatabase Class: "swarms/memory/diy_memory.md" - Building Custom Vector Memory Databases with the BaseVectorDatabase Class: "swarms/memory/diy_memory.md"
- ShortTermMemory: "swarms/memory/short_term_memory.md" - ShortTermMemory: "swarms/memory/short_term_memory.md"
- Multi-Agent Collaboration: - Multi-Agent Collaboration:
- SwarmNetwork: "swarms/structs/swarmnetwork.md" - SwarmNetwork: "swarms/structs/swarmnetwork.md"
- AgentRearrange: "swarms/structs/agent_rearrange.md" - AgentRearrange: "swarms/structs/agent_rearrange.md"
- Why does Swarms Exist?: - Why does Swarms Exist?: "swarms/usage/why_swarms.md"
- References: - References:
- Agent Glossary: "swarms/glossary.md" - Agent Glossary: "swarms/glossary.md"
- List of The Best Multi-Agent Papers: "swarms/papers.md" - List of The Best Multi-Agent Papers: "swarms/papers.md"
- Contributors: - Contributors:
- Contributing: "contributing.md" - Contributing: "contributing.md"
- Reference: - Reference:
- Overview: "swarms/index.md" - Overview: "swarms/index.md"
- swarms.models: - swarms.models:
- How to Create A Custom Language Model: "swarms/models/custom_model.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" - Deploying Azure OpenAI in Production A Comprehensive Guide: "swarms/models/azure_openai.md"
- Language Models: - Language Models:
- BaseLLM: "swarms/models/base_llm.md" - BaseLLM: "swarms/models/base_llm.md"
- Overview: "swarms/models/index.md" - Overview: "swarms/models/index.md"
- HuggingFaceLLM: "swarms/models/huggingface.md" - HuggingFaceLLM: "swarms/models/huggingface.md"
- Anthropic: "swarms/models/anthropic.md" - Anthropic: "swarms/models/anthropic.md"
- OpenAIChat: "swarms/models/openai.md" - OpenAIChat: "swarms/models/openai.md"
- MultiModal Models : - MultiModal Models:
- BaseMultiModalModel: "swarms/models/base_multimodal_model.md" - BaseMultiModalModel: "swarms/models/base_multimodal_model.md"
- Fuyu: "swarms/models/fuyu.md" - Fuyu: "swarms/models/fuyu.md"
- Vilt: "swarms/models/vilt.md" - Vilt: "swarms/models/vilt.md"
- Idefics: "swarms/models/idefics.md" - Idefics: "swarms/models/idefics.md"
- Kosmos: "swarms/models/kosmos.md" - Kosmos: "swarms/models/kosmos.md"
- Nougat: "swarms/models/nougat.md" - Nougat: "swarms/models/nougat.md"
- Dalle3: "swarms/models/dalle3.md" - Dalle3: "swarms/models/dalle3.md"
- GPT4VisionAPI: "swarms/models/gpt4v.md" - GPT4VisionAPI: "swarms/models/gpt4v.md"
- GPT4o: "swarms/models/gpt4o.md" - GPT4o: "swarms/models/gpt4o.md"
- swarms.structs: - swarms.structs:
- Foundational Structures: - Foundational Structures:
- Agent: "swarms/structs/agent.md" - Agent: "swarms/structs/agent.md"
- BaseStructure: "swarms/structs/basestructure.md" - BaseStructure: "swarms/structs/basestructure.md"
- Task: "swarms/structs/task.md" - Task: "swarms/structs/task.md"
- YamlModel: "swarms/structs/yaml_model.md" - YamlModel: "swarms/structs/yaml_model.md"
- BaseWorkflow: "swarms/structs/baseworkflow.md" - BaseWorkflow: "swarms/structs/baseworkflow.md"
- Workflows: - Workflows:
- ConcurrentWorkflow: "swarms/structs/concurrentworkflow.md" - ConcurrentWorkflow: "swarms/structs/concurrentworkflow.md"
- SequentialWorkflow: "swarms/structs/sequential_workflow.md" - SequentialWorkflow: "swarms/structs/sequential_workflow.md"
- Multi Agent Architectures: - Multi Agent Architectures:
- Conversation: "swarms/structs/conversation.md" - Conversation: "swarms/structs/conversation.md"
- SwarmNetwork: "swarms/structs/swarmnetwork.md" - SwarmNetwork: "swarms/structs/swarmnetwork.md"
- MajorityVoting: "swarms/structs/majorityvoting.md" - MajorityVoting: "swarms/structs/majorityvoting.md"
- AgentRearrange: "swarms/structs/agent_rearrange.md" - AgentRearrange: "swarms/structs/agent_rearrange.md"
- RoundRobin: "swarms/structs/round_robin_swarm.md" - RoundRobin: "swarms/structs/round_robin_swarm.md"
- Swarms Cloud API: - Swarms Cloud API:
- Overview: "swarms_cloud/main.md" - Overview: "swarms_cloud/main.md"
- Available Models: "swarms_cloud/available_models.md" - Available Models: "swarms_cloud/available_models.md"
- Migrate from OpenAI to Swarms in 3 lines of code: "swarms_cloud/migrate_openai.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" - 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" - 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" - Under The Hood The Swarm Cloud Serving Infrastructure: "swarms_cloud/architecture.md"
- Guides: - Guides:
- Models: - Models:
- How to Create A Custom Language Model: "swarms/models/custom_model.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" - Deploying Azure OpenAI in Production, A Comprehensive Guide: "swarms/models/azure_openai.md"
- Agents: - Agents:
- Agent: "examples/flow.md" - Agent: "examples/flow.md"
- DIY Build Your Own Agent: "diy_your_own_agent.md" - DIY Build Your Own Agent: "diy_your_own_agent.md"
- Equipping Autonomous Agents with Tools: "examples/tools_agent.md" - Equipping Autonomous Agents with Tools: "examples/tools_agent.md"
- Swarms: - Swarms:
- SequentialWorkflow: "examples/reliable_autonomous_agents.md" - SequentialWorkflow: "examples/reliable_autonomous_agents.md"

Write Preview
Loading…
Cancel
Save