sips in protocol overview docs

pull/983/head^2
Kye Gomez 2 days ago
parent 9ed09f44b5
commit 8f3e2aef84

@ -25,16 +25,12 @@ The Swarms protocol is organized into several key layers, each responsible for a
- Agents can be specialized for different tasks (e.g., reasoning agents, tool agents, judge agents, etc.). - Agents can be specialized for different tasks (e.g., reasoning agents, tool agents, judge agents, etc.).
- Example: A `ReasoningAgent` that can analyze data and make decisions, or a `ToolAgent` that wraps external APIs. - Example: A `ReasoningAgent` that can analyze data and make decisions, or a `ToolAgent` that wraps external APIs.
- [Quickstart for Agents](https://docs.swarms.world/en/latest/swarms/agents/) - [Quickstart for Agents](https://docs.swarms.world/en/latest/swarms/agents/)
- [Agent API Reference](https://docs.swarms.world/en/latest/swarms/structs/agent/) - [Agent API Reference](https://docs.swarms.world/en/latest/swarms/structs/agent/)
2. **Tools with Memory (`swarms/tools`, `swarms/utils`)** 2. **Tools with Memory (`swarms/tools`, `swarms/utils`)**
- Tools are modular components that agents use to interact with the outside world, perform computations, or access resources (APIs, - Tools are modular components that agents use to interact with the outside world, perform computations, or access resources (APIs,
databases, files, etc.). databases, files, etc.).
@ -47,7 +43,6 @@ The Swarms protocol is organized into several key layers, each responsible for a
- [BaseTool Reference](https://docs.swarms.world/en/latest/swarms/tools/base_tool/) - [BaseTool Reference](https://docs.swarms.world/en/latest/swarms/tools/base_tool/)
3. **Reasoning & Specialized Agents (`swarms/agents`)** 3. **Reasoning & Specialized Agents (`swarms/agents`)**
- These agents build on the base agent class, adding advanced reasoning, self-consistency, and specialized logic for tasks like - These agents build on the base agent class, adding advanced reasoning, self-consistency, and specialized logic for tasks like
planning, evaluation, or multi-step workflows. planning, evaluation, or multi-step workflows.
@ -63,7 +58,6 @@ The Swarms protocol is organized into several key layers, each responsible for a
- [Agent Judge](https://docs.swarms.world/en/latest/swarms/agents/agent_judge/) - [Agent Judge](https://docs.swarms.world/en/latest/swarms/agents/agent_judge/)
4. **Multi-Agent Structures (`swarms/structs`)** 4. **Multi-Agent Structures (`swarms/structs`)**
- Agents are composed into higher-order structures for collaboration, voting, parallelism, and workflow orchestration. - Agents are composed into higher-order structures for collaboration, voting, parallelism, and workflow orchestration.
@ -82,7 +76,6 @@ The Swarms protocol is organized into several key layers, each responsible for a
- [Concurrent Workflow](https://docs.swarms.world/en/latest/swarms/structs/concurrentworkflow/) - [Concurrent Workflow](https://docs.swarms.world/en/latest/swarms/structs/concurrentworkflow/)
5. **Supporting Components** 5. **Supporting Components**
- **Communication (`swarms/communication`)**: Provides wrappers for inter-agent communication, database access, message passing, and - **Communication (`swarms/communication`)**: Provides wrappers for inter-agent communication, database access, message passing, and
@ -104,6 +97,34 @@ The Swarms protocol is organized into several key layers, each responsible for a
--- ---
## Proposing Large Improvements or Enhancements: Swarms Improvement Proposals (SIPs)
For significant changes, new agent architectures, or radical new features, Swarms uses a formal process called **Swarms Improvement Proposals (SIPs)**. SIPs are design documents that describe new features, enhancements, or changes to the Swarms framework. They ensure that major changes are well-documented, discussed, and reviewed by the community before implementation.
**When to use a SIP:**
- Proposing new agent types, swarm patterns, or coordination mechanisms
- Core framework changes or breaking changes
- New integrations (LLM providers, tools, external services)
- Any complex or multi-component feature
**SIP Process Overview:**
1. Discuss your idea in [GitHub Discussions](https://github.com/kyegomez/swarms/discussions)
2. Submit a SIP as a GitHub Issue using the SIP template
3. Engage with the community and iterate on your proposal
4. Undergo review and, if accepted, proceed to implementation
**Learn more:** See the full [SIP Guidelines and Template](https://docs.swarms.world/en/latest/protocol/sip/)
---
## Detailed Architecture Diagram ## Detailed Architecture Diagram
The following Mermaid diagram visualizes the protocol flow and the relationship between the main folders in the `swarms/` package: The following Mermaid diagram visualizes the protocol flow and the relationship between the main folders in the `swarms/` package:
@ -409,6 +430,8 @@ For more on the philosophy and architecture, see [Development Philosophy & Princ
- [Understanding Swarms Architecture](https://docs.swarms.world/en/latest/swarms/concept/framework_architecture/) - [Understanding Swarms Architecture](https://docs.swarms.world/en/latest/swarms/concept/framework_architecture/)
- [SIP Guidelines and Template](https://docs.swarms.world/en/latest/protocol/sip/)
# Conclusion # Conclusion

Loading…
Cancel
Save