From 2862aabc6017c825d708513955b634818373ea0f Mon Sep 17 00:00:00 2001
From: Rafael Fernandes Cunha <r.f.cunha@rug.nl>
Date: Wed, 18 Dec 2024 11:00:42 +0000
Subject: [PATCH] Update file README.md
---
README.md | 157 +++++++++++++++++++++++++++++++++++-------------------
1 file changed, 101 insertions(+), 56 deletions(-)
diff --git a/README.md b/README.md
index 60d4965..ed819f1 100644
--- a/README.md
+++ b/README.md
@@ -1,93 +1,138 @@
# osarsa-aaai-25
+# Optimally Solving Simultaneous-Move Dec-POMDPs: The Sequential Central Planning Approach
-## Getting started
+This repository contains the C++ implementation accompanying the AAAI-25 conference paper:
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+**"Optimally Solving Simultaneous-Move Dec-POMDPs: The Sequential Central Planning Approach"**
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+## Overview
-## Add your files
+This project provides the source code and example experiments used to implement and evaluate the proposed Sequential Central Planning (SCP) approach for optimally solving Simultaneous-Move Decentralized Partially Observable Markov Decision Processes (Dec-POMDPs).
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+The repository is organized to enable researchers and practitioners to:
+- Reproduce the results presented in the paper.
+- Apply the SCP approach to custom Dec-POMDP problems.
+- Explore and extend the provided implementation for further research.
-```
-cd existing_repo
-git remote add origin https://git.lwp.rug.nl/ml-rug/osarsa-aaai-25.git
-git branch -M main
-git push -uf origin main
-```
+---
-## Integrate with your tools
+## Contents
-- [ ] [Set up project integrations](https://git.lwp.rug.nl/ml-rug/osarsa-aaai-25/-/settings/integrations)
+- `src/`: Main C++ source code for the SCP approach.
+- `examples/`: Example Dec-POMDP problems and configurations used in the experiments.
+- `docs/`: Documentation for setup, implementation, and usage.
+- `tests/`: Unit tests for key components.
+- `data/`: Input data and sample results for the experiments.
+- `results/`: Outputs and performance metrics for reproduced experiments.
+- `README.md`: Repository documentation (this file).
-## Collaborate with your team
+---
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
+## Requirements
-## Test and Deploy
+### Dependencies
+- **C++ Compiler**: GCC (>= 9.0) or Clang (>= 10.0) recommended.
+- **CMake**: Version 3.15 or higher.
+- **Libraries**:
+ - [Eigen](https://eigen.tuxfamily.org): Linear algebra library.
+ - [Boost](https://www.boost.org): General-purpose C++ library.
+ - [GTest](https://github.com/google/googletest): For running unit tests.
-Use the built-in continuous integration in GitLab.
+### Installation
+1. Clone this repository:
+ ```bash
+ git clone https://gitlab.example.com/yourusername/optimally-solving-dec-pomdps.git
+ cd optimally-solving-dec-pomdps
+ ```
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+2. Build the project using CMake:
+ ```bash
+ mkdir build
+ cd build
+ cmake ..
+ make
+ ```
-***
+3. Run the example:
+ ```bash
+ ./scp_solver examples/sample_problem.json
+ ```
-# Editing this README
+---
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
+## Usage
+
+### Running the Solver
+To solve a Dec-POMDP problem:
+```bash
+./scp_solver <path-to-problem-file>
+```
-## Suggestions for a good README
+Example:
+```bash
+./scp_solver examples/grid_world.json
+```
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+### Customizing Input
+Input files should be in JSON format, specifying the Dec-POMDP parameters. See `examples/sample_problem.json` for an annotated template.
-## Name
-Choose a self-explaining name for your project.
+### Reproducing Results
+Reproducing results from the paper:
+```bash
+./scripts/reproduce_experiments.sh
+```
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+Outputs will be saved in the `results/` directory.
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+---
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+## Results
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+Reproduced results from the paper, including solution quality and computational efficiency metrics, can be found in the `results/` directory. Visualizations of key results are provided in `docs/visualizations`.
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+---
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+## Citing This Work
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+If you find this repository helpful, please cite the following paper:
+
+```
+@inproceedings{YourLastName2025,
+ title={Optimally Solving Simultaneous-Move Dec-POMDPs: The Sequential Central Planning Approach},
+ author={Your Name and Co-Authors},
+ booktitle={Proceedings of the 39th AAAI Conference on Artificial Intelligence (AAAI-25)},
+ year={2025}
+}
+```
+
+---
## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+Contributions are welcome! Please follow the guidelines below:
+1. Fork the repository and create a feature branch.
+2. Submit a pull request with a detailed description of your changes.
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+For significant contributions, please contact us via email.
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
+---
## License
-For open source projects, say how it is licensed.
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+This project is licensed under the [MIT License](LICENSE).
+
+---
+
+## Contact
+
+For questions, comments, or collaboration opportunities, please reach out to:
+- **Your Name**: your_email@example.com
+- **GitLab Issues**: Use the [Issues tab](https://gitlab.example.com/yourusername/optimally-solving-dec-pomdps/-/issues).
+
+---
+
+Thank you for exploring the Sequential Central Planning approach!
+
+
--
GitLab