Skip to content

Commit efca9b8

Browse files
committed
link to readthedocs and small fixes
1 parent b8b74bf commit efca9b8

File tree

3 files changed

+27
-4
lines changed

3 files changed

+27
-4
lines changed

docs/apis/api_main.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,11 @@
44
---
55
maxdepth: 3
66
---
7+
llm_agent
8+
module_llm
9+
memory
10+
reasoning
11+
tools
12+
recording
13+
parallel_stepping
714
```

docs/examples.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,27 @@
1+
# Examples
12

2-
# Mesa-LLM Core Examples
3-
The examples folder contains a curated set of classic llm-agent-based models implemented using Mesa-LLM. These core examples are maintained by the Mesa-LLM development team and serve as both demonstrations of Mesa-LLM's capabilities and starting points for your own models.
3+
The examples folder contains LLM agent-based models implemented using Mesa-LLM. They serve as demonstrations of Mesa-LLM's capabilities and starting points for your own models.
44

55
This folder contains both basic and advanced examples that demonstrate different aspects of Mesa-LLM.
66

7-
### Epstein Civil Violence Model
7+
## Epstein Civil Violence Model
8+
89
Joshua Epstein's [model](https://www.pnas.org/doi/10.1073/pnas.092080199) of how a decentralized uprising can be suppressed or reach a critical mass of support.
910

10-
### Negotiation Model
11+
**Location:** [examples/epstein_civil_violence](https://github.com/projectmesa/mesa-llm/tree/main/examples/epstein_civil_violence)
12+
13+
This example demonstrates:
14+
- Agent decision-making based on social dynamics
15+
- LLM-powered agent reasoning in conflict scenarios
16+
- Integration of multiple agent types with different behaviors
17+
18+
## Negotiation Model
19+
1120
Implementation of a negotiation model where two types of agents (buyer and seller) negotiate over a product.
1221

22+
**Location:** [examples/negotiation](https://github.com/projectmesa/mesa-llm/tree/main/examples/negotiation)
23+
24+
This example demonstrates:
25+
- Agent-to-agent communication
26+
- LLM-based negotiation strategies
27+
- Dynamic pricing and offer-counteroffer mechanisms

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ hidden: true
6666
---
6767
Introduction <self>
6868
API Documentation <apis/api_main>
69+
Examples <examples>
6970
```
7071

7172
## Indices and tables

0 commit comments

Comments
 (0)