Skip to content

Commit 7f950d4

Browse files
committed
fix: add index to navigation and improve landing page design
1 parent 01a52d0 commit 7f950d4

2 files changed

Lines changed: 28 additions & 12 deletions

File tree

docs/docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
],
4040
"navigation": {
4141
"pages": [
42+
"index",
4243
"getting-started/installation",
4344
"getting-started/quickstart",
4445
"getting-started/concepts",

docs/index.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,27 @@
1+
---
2+
title: Home
3+
description: SwarmTorch - 120 Metaheuristic Optimization Algorithms for PyTorch
4+
---
5+
16
# SwarmTorch 🐝🔥
27

3-
<Callout type="info">
4-
SwarmTorch brings 120 metaheuristic optimization algorithms to PyTorch — 60 model-training optimizers and 60 hyperparameter-tuning searchers.
5-
</Callout>
8+
<Info>
9+
SwarmTorch brings 120 metaheuristic optimization algorithms to PyTorch — 60 model-training optimizers and 60 hyperparameter-tuning searchers.
10+
</Info>
611

712
SwarmTorch is a high-performance, academic-grade library that enables **gradient-free neural network training** and **intelligent hyperparameter optimization** using nature-inspired metaheuristic algorithms.
813

914
## Why SwarmTorch?
1015

11-
Traditional deep learning relies on gradient-based optimization (Adam, SGD, etc.). SwarmTorch complements these with:
16+
Traditional deep learning relies on gradient-based optimization (Adam, SGD). SwarmTorch complements these with:
1217

13-
- **Gradient-Free Training**: Optimize weights where gradients don't exist or are unreliable
14-
- **Hyperparameter Optimization**: Replace grid/random search with intelligent exploration
15-
- **60+ Algorithms**: From PSO and GWO to DE, GA, and hybrid methods
16-
- **PyTorch Native**: Drop-in replacement for standard optimizers
18+
| Scenario | Gradient (Adam/SGD) | SwarmTorch |
19+
|----------|-------------------|------------|
20+
| Standard classification | ✅ Best choice | Overkill |
21+
| Non-differentiable loss | ❌ Can't use | ✅ Perfect fit |
22+
| Discrete optimization | ❌ Can't use | ✅ Perfect fit |
23+
| Multi-modal landscapes | Gets stuck | Explores well |
24+
| Hyperparameter tuning | Manual search | Automated |
1725

1826
## Key Features
1927

@@ -24,7 +32,7 @@ Traditional deep learning relies on gradient-based optimization (Adam, SGD, etc.
2432
<Card title="60 HPO Searchers" icon="magnifying-glass">
2533
Automatically find optimal hyperparameters using nature-inspired search.
2634
</Card>
27-
<Card title="PyTorch Compatible" icon="brand-elixir">
35+
<Card title="PyTorch Native" icon="brand-elixir">
2836
Uses the standard `torch.optim.Optimizer` interface. Easy to integrate.
2937
</Card>
3038
<Card title="Research-Ready" icon="chart-line">
@@ -54,8 +62,8 @@ for _ in range(100):
5462

5563
## Algorithm Categories
5664

57-
| Category | # Algorithms | Examples |
58-
|----------|-------------|----------|
65+
| Category | # | Examples |
66+
|----------|---|----------|
5967
| **Swarm Intelligence** | 32 | PSO, GWO, WOA, HHO, SSA |
6068
| **Evolutionary** | 8 | DE, GA, CEM, PBIL |
6169
| **Physics-Based** | 3 | SA, GSA, FPA |
@@ -70,11 +78,12 @@ pip install swarmtorch
7078
```
7179

7280
For benchmarking dependencies:
81+
7382
```bash
7483
pip install swarmtorch[benchmarks]
7584
```
7685

77-
## Next Steps
86+
## Get Started
7887

7988
<CardGroup cols={2}>
8089
<Card title="Quickstart" icon="rocket" href="/getting-started/quickstart">
@@ -86,7 +95,13 @@ pip install swarmtorch[benchmarks]
8695
<Card title="Hyperparameter Tuning" icon="magnifying-glass" href="/guides/hyperparameter-tuning">
8796
Discover how to optimize model hyperparameters automatically.
8897
</Card>
98+
<Card title="Choosing an Algorithm" icon="sparkles" href="/guides/choosing-algorithm">
99+
Find the right algorithm for your problem.
100+
</Card>
89101
<Card title="API Reference" icon="code" href="/api-reference/base">
90102
Explore the full API documentation.
91103
</Card>
104+
<Card title="Benchmarks" icon="chart-bar" href="/benchmarks/benchmarks">
105+
See where swarm algorithms excel vs gradient methods.
106+
</Card>
92107
</CardGroup>

0 commit comments

Comments
 (0)