diff --git a/docs/apis/api_main.md b/docs/apis/api_main.md index 3de4f3e..d2f32c0 100644 --- a/docs/apis/api_main.md +++ b/docs/apis/api_main.md @@ -4,4 +4,11 @@ --- maxdepth: 3 --- +llm_agent +module_llm +memory +reasoning +tools +recording +parallel_stepping ``` \ No newline at end of file diff --git a/docs/examples.md b/docs/examples.md index 5cf9c48..c023c60 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -1,12 +1,27 @@ +# Examples -# Mesa-LLM Core Examples -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. +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. This folder contains both basic and advanced examples that demonstrate different aspects of Mesa-LLM. -### Epstein Civil Violence Model +## Epstein Civil Violence Model + 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. -### Negotiation Model +**Location:** [examples/epstein_civil_violence](https://github.com/projectmesa/mesa-llm/tree/main/examples/epstein_civil_violence) + +This example demonstrates: +- Agent decision-making based on social dynamics +- LLM-powered agent reasoning in conflict scenarios +- Integration of multiple agent types with different behaviors + +## Negotiation Model + Implementation of a negotiation model where two types of agents (buyer and seller) negotiate over a product. +**Location:** [examples/negotiation](https://github.com/projectmesa/mesa-llm/tree/main/examples/negotiation) + +This example demonstrates: +- Agent-to-agent communication +- LLM-based negotiation strategies +- Dynamic pricing and offer-counteroffer mechanisms diff --git a/docs/index.md b/docs/index.md index 88a6463..f8c200e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -66,6 +66,7 @@ hidden: true --- Introduction API Documentation +Examples ``` ## Indices and tables