Skip to content

Commit 623e41b

Browse files
IlumCIIlumCI
authored
Merge branch 'kyegomez:master' into master
2 parents 20ab908 + d1cb8a6 commit 623e41b

47 files changed

Lines changed: 3819 additions & 1360 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/code-quality-and-tests.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ jobs:
3434
# Step 4: Cache dependencies to speed up subsequent runs
3535
- name: Load cached venv
3636
id: cached-poetry-dependencies
37-
uses: actions/cache@v4
37+
uses: actions/cache@v5
3838
with:
3939
path: .venv
4040
key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
@@ -64,7 +64,7 @@ jobs:
6464
# Step 11: Upload test results as artifacts (optional)
6565
- name: Upload test results
6666
if: always()
67-
uses: actions/upload-artifact@v5
67+
uses: actions/upload-artifact@v6
6868
with:
6969
name: test-results-${{ matrix.python-version }}
7070
path: |

‎.github/workflows/lint.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
python-version: '3.10'
1515

1616
- name: Cache pip dependencies
17-
uses: actions/cache@v4
17+
uses: actions/cache@v5
1818
with:
1919
path: ~/.cache/pip
2020
key: ${{ runner.os }}-pip-${{ hashFiles('**/pyproject.toml') }}

‎.github/workflows/test-main-features.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
python-version: "3.10"
3333

3434
- name: Cache pip dependencies
35-
uses: actions/cache@v4
35+
uses: actions/cache@v5
3636
with:
3737
path: ~/.cache/pip
3838
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
@@ -69,7 +69,7 @@ jobs:
6969
poetry run python tests/test_main_features.py
7070
7171
- name: Upload test results
72-
uses: actions/upload-artifact@v5
72+
uses: actions/upload-artifact@v6
7373
if: always()
7474
with:
7575
name: test-results

‎docs/examples/aop_examples_overview.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# AOP Examples Overview
2+
3+
Deploy agents as network services using the Agent Orchestration Protocol (AOP). Turn your agents into distributed, scalable, and accessible services.
4+
5+
## What You'll Learn
6+
7+
| Topic | Description |
8+
|-------|-------------|
9+
| **AOP Fundamentals** | Understanding agent-as-a-service deployment |
10+
| **Server Setup** | Running agents as MCP servers |
11+
| **Client Integration** | Connecting to remote agents |
12+
| **Production Deployment** | Scaling and monitoring agents |
13+
14+
---
15+
16+
## AOP Examples
17+
18+
| Example | Description | Link |
19+
|---------|-------------|------|
20+
| **Medical AOP Example** | Healthcare agent deployment with AOP | [View Example](./aop_medical.md) |
21+
22+
---
23+
24+
## Use Cases
25+
26+
| Use Case | Description |
27+
|----------|-------------|
28+
| **Microservices** | Agent per service |
29+
| **API Gateway** | Central agent access point |
30+
| **Multi-tenant** | Shared agent infrastructure |
31+
| **Edge Deployment** | Agents at the edge |
32+
33+
---
34+
35+
## Related Resources
36+
37+
- [AOP Reference Documentation](../swarms/structs/aop.md) - Complete AOP API
38+
- [AOP Server Setup](../swarms/examples/aop_server_example.md) - Server configuration
39+
- [AOP Cluster Example](../swarms/examples/aop_cluster_example.md) - Multi-node setup
40+
- [Deployment Solutions](../deployment_solutions/overview.md) - Production deployment

‎docs/examples/applications_overview.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Applications Overview
2+
3+
Real-world multi-agent applications built with Swarms. These examples demonstrate complete solutions for business, research, finance, and automation use cases.
4+
5+
## What You'll Learn
6+
7+
| Topic | Description |
8+
|-------|-------------|
9+
| **Business Applications** | Marketing, hiring, M&A advisory swarms |
10+
| **Research Systems** | Advanced research and analysis workflows |
11+
| **Financial Analysis** | ETF research and investment analysis |
12+
| **Automation** | Browser agents and web automation |
13+
| **Industry Solutions** | Real estate, job finding, and more |
14+
15+
---
16+
17+
## Application Examples
18+
19+
| Application | Description | Industry | Link |
20+
|-------------|-------------|----------|------|
21+
| **Swarms of Browser Agents** | Automated web browsing with multiple agents | Automation | [View Example](../swarms/examples/swarms_of_browser_agents.md) |
22+
| **Hierarchical Marketing Team** | Multi-agent marketing strategy and execution | Marketing | [View Example](./marketing_team.md) |
23+
| **Gold ETF Research with HeavySwarm** | Comprehensive ETF analysis using Heavy Swarm | Finance | [View Example](./gold_etf_research.md) |
24+
| **Hiring Swarm** | Automated candidate screening and evaluation | HR/Recruiting | [View Example](./hiring_swarm.md) |
25+
| **Advanced Research** | Multi-agent research and analysis system | Research | [View Example](./av.md) |
26+
| **Real Estate Swarm** | Property analysis and market research | Real Estate | [View Example](./realestate_swarm.md) |
27+
| **Job Finding Swarm** | Automated job search and matching | Career | [View Example](./job_finding.md) |
28+
| **M&A Advisory Swarm** | Mergers & acquisitions analysis | Finance | [View Example](./ma_swarm.md) |
29+
30+
---
31+
32+
## Applications by Category
33+
34+
### Business & Marketing
35+
36+
| Application | Description | Link |
37+
|-------------|-------------|------|
38+
| **Hierarchical Marketing Team** | Complete marketing strategy system | [View Example](./marketing_team.md) |
39+
| **Hiring Swarm** | End-to-end recruiting automation | [View Example](./hiring_swarm.md) |
40+
| **M&A Advisory Swarm** | Due diligence and analysis | [View Example](./ma_swarm.md) |
41+
42+
### Financial Analysis
43+
44+
| Application | Description | Link |
45+
|-------------|-------------|------|
46+
| **Gold ETF Research** | Comprehensive ETF analysis | [View Example](./gold_etf_research.md) |
47+
48+
### Research & Automation
49+
50+
| Application | Description | Link |
51+
|-------------|-------------|------|
52+
| **Advanced Research** | Multi-source research compilation | [View Example](./av.md) |
53+
| **Browser Agents** | Automated web interaction | [View Example](../swarms/examples/swarms_of_browser_agents.md) |
54+
| **Job Finding Swarm** | Career opportunity discovery | [View Example](./job_finding.md) |
55+
56+
### Real Estate
57+
58+
| Application | Description | Link |
59+
|-------------|-------------|------|
60+
| **Real Estate Swarm** | Property market analysis | [View Example](./realestate_swarm.md) |
61+
62+
---
63+
64+
## Related Resources
65+
66+
- [HierarchicalSwarm Documentation](../swarms/structs/hierarchical_swarm.md)
67+
- [HeavySwarm Documentation](../swarms/structs/heavy_swarm.md)
68+
- [Building Custom Swarms](../swarms/structs/custom_swarm.md)
69+
- [Deployment Solutions](../deployment_solutions/overview.md)

‎docs/examples/apps_examples_overview.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Apps Examples Overview
2+
3+
Complete application examples built with Swarms. These examples show how to build practical tools and utilities with AI agents.
4+
5+
## What You'll Learn
6+
7+
| Topic | Description |
8+
|-------|-------------|
9+
| **Web Scraping** | Building intelligent web scrapers |
10+
| **Database Integration** | Smart database query agents |
11+
| **Practical Tools** | End-to-end application development |
12+
13+
---
14+
15+
## App Examples
16+
17+
| App | Description | Link |
18+
|-----|-------------|------|
19+
| **Web Scraper Agents** | Intelligent web data extraction | [View Example](../developer_guides/web_scraper.md) |
20+
| **Smart Database** | AI-powered database interactions | [View Example](./smart_database.md) |
21+
22+
---
23+
24+
## Related Resources
25+
26+
- [Tools & Integrations](./tools_integrations_overview.md) - External service connections
27+
- [Multi-Agent Architectures](./multi_agent_architectures_overview.md) - Complex agent systems
28+
- [Deployment Solutions](../deployment_solutions/overview.md) - Production deployment
29+

‎docs/examples/basic_examples_overview.md‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Basic Examples Overview
2+
3+
Start your Swarms journey with single-agent examples. Learn how to create agents, use tools, process images, integrate with different LLM providers, and publish to the marketplace.
4+
5+
## What You'll Learn
6+
7+
| Topic | Description |
8+
|-------|-------------|
9+
| **Agent Basics** | Create and configure individual agents |
10+
| **Tool Integration** | Equip agents with callable tools and functions |
11+
| **Vision Capabilities** | Process images and multi-modal inputs |
12+
| **LLM Providers** | Connect to OpenAI, Anthropic, Groq, and more |
13+
| **Utilities** | Streaming, output types, and marketplace publishing |
14+
15+
---
16+
17+
## Individual Agent Examples
18+
19+
### Core Agent Usage
20+
21+
| Example | Description | Link |
22+
|---------|-------------|------|
23+
| **Basic Agent** | Fundamental agent creation and execution | [View Example](../swarms/examples/basic_agent.md) |
24+
25+
### Tool Usage
26+
27+
| Example | Description | Link |
28+
|---------|-------------|------|
29+
| **Agents with Vision and Tool Usage** | Combine vision and tools in one agent | [View Example](../swarms/examples/vision_tools.md) |
30+
| **Agents with Callable Tools** | Equip agents with Python functions as tools | [View Example](../swarms/examples/agent_with_tools.md) |
31+
| **Agent with Structured Outputs** | Get consistent JSON/structured responses | [View Example](../swarms/examples/agent_structured_outputs.md) |
32+
| **Message Transforms** | Manage context with message transformations | [View Example](../swarms/structs/transforms.md) |
33+
34+
### Vision & Multi-Modal
35+
36+
| Example | Description | Link |
37+
|---------|-------------|------|
38+
| **Agents with Vision** | Process and analyze images | [View Example](../swarms/examples/vision_processing.md) |
39+
| **Agent with Multiple Images** | Handle multiple images in one request | [View Example](../swarms/examples/multiple_images.md) |
40+
41+
### Utilities
42+
43+
| Example | Description | Link |
44+
|---------|-------------|------|
45+
| **Agent with Streaming** | Stream responses in real-time | [View Example](./agent_stream.md) |
46+
| **Agent Output Types** | Different output formats (str, json, dict, yaml) | [View Example](../swarms/examples/agent_output_types.md) |
47+
| **Gradio Chat Interface** | Build chat UIs for your agents | [View Example](../swarms/ui/main.md) |
48+
| **Agent with Gemini Nano Banana** | Jarvis-style agent example | [View Example](../swarms/examples/jarvis_agent.md) |
49+
| **Agent Marketplace Publishing** | Publish agents to the Swarms marketplace | [View Example](./marketplace_publishing_quickstart.md) |
50+
51+
---
52+
53+
## LLM Provider Examples
54+
55+
Connect your agents to various language model providers:
56+
57+
| Provider | Description | Link |
58+
|----------|-------------|------|
59+
| **Overview** | Guide to all supported providers | [View Guide](../swarms/examples/model_providers.md) |
60+
| **OpenAI** | GPT-4, GPT-4o, GPT-4o-mini integration | [View Example](../swarms/examples/openai_example.md) |
61+
| **Anthropic** | Claude models integration | [View Example](../swarms/examples/claude.md) |
62+
| **Groq** | Ultra-fast inference with Groq | [View Example](../swarms/examples/groq.md) |
63+
| **Cohere** | Cohere Command models | [View Example](../swarms/examples/cohere.md) |
64+
| **DeepSeek** | DeepSeek models integration | [View Example](../swarms/examples/deepseek.md) |
65+
| **Ollama** | Local models with Ollama | [View Example](../swarms/examples/ollama.md) |
66+
| **OpenRouter** | Access multiple providers via OpenRouter | [View Example](../swarms/examples/openrouter.md) |
67+
| **XAI** | Grok models from xAI | [View Example](../swarms/examples/xai.md) |
68+
| **Azure OpenAI** | Enterprise Azure deployment | [View Example](../swarms/examples/azure.md) |
69+
| **Llama4** | Meta's Llama 4 models | [View Example](../swarms/examples/llama4.md) |
70+
| **Custom Base URL** | Connect to any OpenAI-compatible API | [View Example](../swarms/examples/custom_base_url_example.md) |
71+
72+
---
73+
74+
## Next Steps
75+
76+
After mastering basic agents, explore:
77+
78+
- [Multi-Agent Architectures](./multi_agent_architectures_overview.md) - Coordinate multiple agents
79+
- [Tools Documentation](../swarms/tools/main.md) - Deep dive into tool creation
80+
- [CLI Guides](./cli_guides_overview.md) - Run agents from command line

‎docs/examples/cli_guides_overview.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# CLI Guides Overview
2+
3+
Master the Swarms command-line interface with these step-by-step guides. Execute agents, run multi-agent workflows, and integrate Swarms into your DevOps pipelines—all from your terminal.
4+
5+
## What You'll Learn
6+
7+
| Topic | Description |
8+
|-------|-------------|
9+
| **CLI Basics** | Install, configure, and run your first commands |
10+
| **Agent Creation** | Create and run agents directly from command line |
11+
| **YAML Configuration** | Define agents in config files for reproducible deployments |
12+
| **Multi-Agent Commands** | Run LLM Council and Heavy Swarm from terminal |
13+
| **DevOps Integration** | Integrate into CI/CD pipelines and scripts |
14+
15+
---
16+
17+
## CLI Guides
18+
19+
| Guide | Description | Link |
20+
|-------|-------------|------|
21+
| **CLI Quickstart** | Get started with Swarms CLI in 3 steps—install, configure, and run | [View Guide](../swarms/cli/cli_quickstart.md) |
22+
| **Creating Agents from CLI** | Create, configure, and run AI agents directly from your terminal | [View Guide](../swarms/cli/cli_agent_guide.md) |
23+
| **YAML Configuration** | Run multiple agents from YAML configuration files | [View Guide](../swarms/cli/cli_yaml_guide.md) |
24+
| **LLM Council CLI** | Run collaborative multi-agent decision-making from command line | [View Guide](../swarms/cli/cli_llm_council_guide.md) |
25+
| **Heavy Swarm CLI** | Execute comprehensive task analysis swarms from terminal | [View Guide](../swarms/cli/cli_heavy_swarm_guide.md) |
26+
| **CLI Multi-Agent Commands** | Complete guide to multi-agent CLI commands | [View Guide](./cli_multi_agent_quickstart.md) |
27+
| **CLI Examples** | Additional CLI usage examples and patterns | [View Guide](../swarms/cli/cli_examples.md) |
28+
29+
---
30+
31+
## Use Cases
32+
33+
| Use Case | Recommended Guide |
34+
|----------|-------------------|
35+
| First time using CLI | [CLI Quickstart](../swarms/cli/cli_quickstart.md) |
36+
| Creating custom agents | [Creating Agents from CLI](../swarms/cli/cli_agent_guide.md) |
37+
| Team/production deployments | [YAML Configuration](../swarms/cli/cli_yaml_guide.md) |
38+
| Collaborative decision-making | [LLM Council CLI](../swarms/cli/cli_llm_council_guide.md) |
39+
| Complex research tasks | [Heavy Swarm CLI](../swarms/cli/cli_heavy_swarm_guide.md) |
40+
41+
---
42+
43+
## Related Resources
44+
45+
- [CLI Reference Documentation](../swarms/cli/cli_reference.md) - Complete command reference
46+
- [Agent Documentation](../swarms/structs/agent.md) - Agent class reference
47+
- [Environment Configuration](../swarms/install/env.md) - Environment setup guide

0 commit comments

Comments
 (0)