| Name | Signal8 JSON |
| Version |
5.1.1
JSON |
| download |
| home_page | https://github.com/ethanmclark1/signal8 |
| Summary | A multi-agent environment inspired by the Lewis Signaling Game, featuring eight unique problem configurations with both static and dynamic obstacles. |
| upload_time | 2024-02-12 07:56:44 |
| maintainer | |
| docs_url | None |
| author | Ethan Clark |
| requires_python | |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# An Extension of Multi-Agent Particle Environment
signal8 is an enhancement on top of the Simple environment, originally developed by the [Farama Foundation](https://farama.org/) as part of their [Multi-Agent Particle Environment (MPE)](https://pettingzoo.farama.org/environments/mpe/).
# signal8
signal8 is an open-source research project aimed at advancing the development of communication strategies in multi-agent systems. The project proposes a unique environment that emphasizes the principles of the Lewis signaling game. This distinct setting serves as a testing ground for advancing robot-to-robot communication protocols.
Each problem set within signal8 introduces different constraints on entity positioning such as start points, goals, and obstacles. This dynamic aspect encourages the investigation of communication strategies in diverse settings, enhancing the environment's adaptability and realism.
A notable characteristic of signal8 is its incorporation of asymmetric information, whereby two types of agents – an 'eye in the sky' agent with global information and ground agents with only local information – operate simultaneously. This asymmetry replicates real-world situations, presenting challenges for the development of efficient communication strategies. It also provides intriguing prospects for the generation of context-dependent language and high-level directives.
For additional information on utilizing the environment API, please refer to the [PettingZoo API documentation](https://pettingzoo.farama.org/content/basic_usage/).
## Installation
```
git clone https://github.com/ethanmclark1/signal8.git
cd signal8
pip install -r requirements.txt
pip install -e .
```
## Usage
```
import signal8
env = signal8.env()
env.reset(options={'problem_instance': 'bisect'}))
observation, _, terminations, truncations, _ = env.last()
env.step(action)
env.close()
```
## List of Problem Instances
| Problem Instance | Visualization |
| :--------------: | :--------------------------------------------: |
| ``bisect`` |  |
| ``circle`` |  |
| ``corners``Â |  |
| ``cross`` |  |
| ``staggered`` |  |
| ``quarters`` |  |
| ``stellaris`` |  |
| ``scatter`` |  |
The red zones denote regions where large obstacles can be spawned, while the remaining space designates areas eligible for agent deployment, goal placement, and generation of small obstacles.
## Contributing
We welcome contributions to signal8! If you're interested in contributing, you can do so in the following ways:
* **Bug Reports** : If you discover a bug when using signal8, please submit a report via the issues tab. When submitting an issue, please do your best to include a detailed description of the problem and a code sample, if applicable.
* **Feature Requests** : If you have a great idea that you think would improve signal8, don't hesitate to post your suggestions in the issues tab. Please be as detailed as possible in your explanation.
* **Pull Requests** : If you have made enhancements to signal8, please feel free to submit a pull request. We appreciate all the help we can get to make signal8 better!
## Support
If you encounter any issues or have questions about signal8, please feel free to contact us. You can either create an issue in the GitHub repository or reach out to us directly at [eclark715@gmail.com](mailto:eclark715@gmail.com).
## License
signal8 is open-source software licensed under the [MIT license](https://chat.openai.com/LINK_TO_YOUR_LICENSE).
## Paper Citation
If you used this environment for your experiments or found it helpful, consider citing the following papers:
Environments in this repo:
<pre>
@article{lowe2017multi,
title={Multi-Agent Actor-Critic for Mixed Cooperative-Competitive Environments},
author={Lowe, Ryan and Wu, Yi and Tamar, Aviv and Harb, Jean and Abbeel, Pieter and Mordatch, Igor},
journal={Neural Information Processing Systems (NIPS)},
year={2017}
}
</pre>
Original particle world environment:
<pre>
@article{mordatch2017emergence,
title={Emergence of Grounded Compositional Language in Multi-Agent Populations},
author={Mordatch, Igor and Abbeel, Pieter},
journal={arXiv preprint arXiv:1703.04908},
year={2017}
}
</pre>
Raw data
{
"_id": null,
"home_page": "https://github.com/ethanmclark1/signal8",
"name": "Signal8",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Ethan Clark",
"author_email": "eclark715@gmail.com.com",
"download_url": "https://files.pythonhosted.org/packages/81/f1/93de365db68303d52b8084f402c2a6584b5f2f8e6288ac2cfdd57d7eb570/Signal8-5.1.1.tar.gz",
"platform": null,
"description": "# An Extension of Multi-Agent Particle Environment\r\n\r\nsignal8 is an enhancement on top of the Simple environment, originally developed by the [Farama Foundation](https://farama.org/) as part of their [Multi-Agent Particle Environment (MPE)](https://pettingzoo.farama.org/environments/mpe/).\r\n\r\n# signal8\r\n\r\nsignal8 is an open-source research project aimed at advancing the development of communication strategies in multi-agent systems. The project proposes a unique environment that emphasizes the principles of the Lewis signaling game. This distinct setting serves as a testing ground for advancing robot-to-robot communication protocols.\r\n\r\nEach problem set within signal8 introduces different constraints on entity positioning such as start points, goals, and obstacles. This dynamic aspect encourages the investigation of communication strategies in diverse settings, enhancing the environment's adaptability and realism.\r\n\r\nA notable characteristic of signal8 is its incorporation of asymmetric information, whereby two types of agents \u00e2\u20ac\u201c an 'eye in the sky' agent with global information and ground agents with only local information \u00e2\u20ac\u201c operate simultaneously. This asymmetry replicates real-world situations, presenting challenges for the development of efficient communication strategies. It also provides intriguing prospects for the generation of context-dependent language and high-level directives.\r\n\r\nFor additional information on utilizing the environment API, please refer to the [PettingZoo API documentation](https://pettingzoo.farama.org/content/basic_usage/).\r\n\r\n## Installation\r\n\r\n```\r\ngit clone https://github.com/ethanmclark1/signal8.git\r\ncd signal8\r\npip install -r requirements.txt\r\npip install -e .\r\n```\r\n\r\n## Usage\r\n\r\n```\r\nimport signal8\r\n\r\nenv = signal8.env()\r\nenv.reset(options={'problem_instance': 'bisect'}))\r\nobservation, _, terminations, truncations, _ = env.last()\r\nenv.step(action)\r\nenv.close()\r\n```\r\n\r\n## List of Problem Instances\r\n\r\n| Problem Instance | Visualization |\r\n| :--------------: | :--------------------------------------------: |\r\n| ``bisect`` |  |\r\n| ``circle`` |  |\r\n| ``corners``\u00c2\u00a0 |  |\r\n| ``cross`` |  |\r\n| ``staggered`` |  |\r\n| ``quarters`` |  |\r\n| ``stellaris`` |  |\r\n| ``scatter`` |  |\r\n\r\nThe red zones denote regions where large obstacles can be spawned, while the remaining space designates areas eligible for agent deployment, goal placement, and generation of small obstacles.\r\n\r\n## Contributing\r\n\r\nWe welcome contributions to signal8! If you're interested in contributing, you can do so in the following ways:\r\n\r\n* **Bug Reports** : If you discover a bug when using signal8, please submit a report via the issues tab. When submitting an issue, please do your best to include a detailed description of the problem and a code sample, if applicable.\r\n* **Feature Requests** : If you have a great idea that you think would improve signal8, don't hesitate to post your suggestions in the issues tab. Please be as detailed as possible in your explanation.\r\n* **Pull Requests** : If you have made enhancements to signal8, please feel free to submit a pull request. We appreciate all the help we can get to make signal8 better!\r\n\r\n## Support\r\n\r\nIf you encounter any issues or have questions about signal8, please feel free to contact us. You can either create an issue in the GitHub repository or reach out to us directly at [eclark715@gmail.com](mailto:eclark715@gmail.com).\r\n\r\n## License\r\n\r\nsignal8 is open-source software licensed under the [MIT license](https://chat.openai.com/LINK_TO_YOUR_LICENSE).\r\n\r\n## Paper Citation\r\n\r\nIf you used this environment for your experiments or found it helpful, consider citing the following papers:\r\n\r\nEnvironments in this repo:\r\n\r\n<pre>\r\n@article{lowe2017multi,\r\n title={Multi-Agent Actor-Critic for Mixed Cooperative-Competitive Environments},\r\n author={Lowe, Ryan and Wu, Yi and Tamar, Aviv and Harb, Jean and Abbeel, Pieter and Mordatch, Igor},\r\n journal={Neural Information Processing Systems (NIPS)},\r\n year={2017}\r\n}\r\n</pre>\r\n\r\nOriginal particle world environment:\r\n\r\n<pre>\r\n@article{mordatch2017emergence,\r\n title={Emergence of Grounded Compositional Language in Multi-Agent Populations},\r\n author={Mordatch, Igor and Abbeel, Pieter},\r\n journal={arXiv preprint arXiv:1703.04908},\r\n year={2017}\r\n}\r\n</pre>\r\n",
"bugtrack_url": null,
"license": "",
"summary": "A multi-agent environment inspired by the Lewis Signaling Game, featuring eight unique problem configurations with both static and dynamic obstacles.",
"version": "5.1.1",
"project_urls": {
"Homepage": "https://github.com/ethanmclark1/signal8"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5a7d33c2d6a1fef83bdfcb2ebd1b27ecc9f6d9cd9e50253ade4364c9015e61a0",
"md5": "ade481c22ab9bfabb56857871dc6441e",
"sha256": "233f7bcd643c0af68201c6e39ad845c12d9e476a7fa7e55ba4ddd4ecbadd94f9"
},
"downloads": -1,
"filename": "Signal8-5.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ade481c22ab9bfabb56857871dc6441e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 14303,
"upload_time": "2024-02-12T07:56:42",
"upload_time_iso_8601": "2024-02-12T07:56:42.364280Z",
"url": "https://files.pythonhosted.org/packages/5a/7d/33c2d6a1fef83bdfcb2ebd1b27ecc9f6d9cd9e50253ade4364c9015e61a0/Signal8-5.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "81f193de365db68303d52b8084f402c2a6584b5f2f8e6288ac2cfdd57d7eb570",
"md5": "81238e1f99b69a8cb69b6da23e43f792",
"sha256": "7583b7e9f0e2bcfe0ba772fbeed55617be654ec140ae6946fa0e6cec40d77cb8"
},
"downloads": -1,
"filename": "Signal8-5.1.1.tar.gz",
"has_sig": false,
"md5_digest": "81238e1f99b69a8cb69b6da23e43f792",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 14897,
"upload_time": "2024-02-12T07:56:44",
"upload_time_iso_8601": "2024-02-12T07:56:44.434402Z",
"url": "https://files.pythonhosted.org/packages/81/f1/93de365db68303d52b8084f402c2a6584b5f2f8e6288ac2cfdd57d7eb570/Signal8-5.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-12 07:56:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ethanmclark1",
"github_project": "signal8",
"github_not_found": true,
"lcname": "signal8"
}
