# Neo
Neo is a python package that enables deserialisation and an interface to the [Droid](https://github.com/sintefneodroid/droid) counterpart of the [Neodroid](https://github.com/sintefneodroid) platform.
---
_[Neodroid](https://github.com/sintefneodroid) is developed with support from Research Council of Norway Grant #262900. ([https://www.forskningsradet.no/prosjektbanken/#/project/NFR/262900](https://www.forskningsradet.no/prosjektbanken/#/project/NFR/262900))_
---
<table>
<tr>
<td>
<a href='https://travis-ci.org/sintefneodroid/neo'>
<img src='https://travis-ci.org/sintefneodroid/neo.svg?branch=master' alt='Build Status' />
</a>
</td>
<td>
<a href='https://coveralls.io/github/sintefneodroid/neo?branch=master'>
<img src='https://coveralls.io/repos/github/sintefneodroid/neo/badge.svg?branch=master' alt='Coverage Status' />
</a>
</td>
<td>
<a href='https://github.com/sintefneodroid/neo/issues'>
<img src='https://img.shields.io/github/issues/sintefneodroid/neo.svg?style=flat' alt='GitHub Issues' />
</a>
</td>
<td>
<a href='https://documentation.neodroid.ml/?badge=latest'>
<img src='https://readthedocs.org/projects/neodroid/badge/?version=latest' alt='Documentation Status' />
</a>
</td>
</tr>
<tr>
<td>
<a href='https://github.com/sintefneodroid/neo/network'>
<img src='https://img.shields.io/github/forks/sintefneodroid/neo.svg?style=flat' alt='GitHub Forks' />
</a>
</td>
<td>
<a href='https://github.com/sintefneodroid/neo/stargazers'>
<img src='https://img.shields.io/github/stars/sintefneodroid/neo.svg?style=flat' alt='GitHub Stars' />
</a>
</td>
<td>
<a href='https://github.com/sintefneodroid/neo/blob/master/LICENSE.md'>
<img src='https://img.shields.io/github/license/sintefneodroid/neo.svg?style=flat' alt='GitHub License' />
</a>
</td>
<td>
<a href="https://pyup.io/repos/github/sintefneodroid/neo/">
<img src="https://pyup.io/repos/github/sintefneodroid/neo/python-3-shield.svg" alt="Python 3" />
</a>
</td>
</tr>
<tr>
<td>
<a href='https://pypi.python.org/pypi/Neodroid'>
<img src='https://pypip.in/v/neodroid/badge.png' alt='Pypi Version' />
</a>
</td>
<td>
<a href='https://pypi.python.org/pypi/Neodroid'>
<img src='https://pypip.in/d/neodroid/badge.png' alt='Pypi Downloads' />
</a>
</td>
<td>
<a href='https://pypi.python.org/pypi/Neodroid'>
<img src='https://pypip.in/wheel/neodroid/badge.png' alt='Pypi Wheel' />
</a>
</td>
<td>
<a href="https://pyup.io/repos/github/sintefneodroid/neo/">
<img src="https://pyup.io/repos/github/sintefneodroid/neo/shield.svg" alt="Updates" />
</a>
</td>
</tr>
</table>
<p align="center" width="100%">
<a href="https://www.python.org/">
<img alt="python" src="https://raw.githubusercontent.com/sintefneodroid/neo/master/.github/images/python.svg" height="40" align="left">
</a>
<a href="https://github.com/google/flatbuffers">
<img alt="flatbuffers" src="https://raw.githubusercontent.com/sintefneodroid/neo/master/.github/images/flatbuffers.svg" height="40" align="center">
</a>
<a href="https://github.com/zeromq/pyzmq" >
<img alt="pyzmq" src="https://media.githubusercontent.com/media/sintefneodroid/neo/master/.github/images/pyzmq.png" height="40" align="right">
</a>
</p>
## Installation
```bash
pip3 install -U neodroid
```
## Usage
```py
import neodroid as neo
```
<!---
## Features
-->
## Examples
We have included some example applications in this repository.
### Observation Generator
### Random Agent
### Curriculum
### An Example Implementation Of Using An Interface
The application displays data received from the example application of the [Droid](https://github.com/sintefneodroid/droid) project repository.
<!---
## Screenshots
-->
# To Do's
- [ ] Be able to select and/or parameterise an objective/evaluation (None,ReachGoal,Stabilise,..) function for an environment
# Contributing
See guidelines for contributing [here](.github/CONTRIBUTING.md).
# Licensing
This project is licensed under the Apache V2 License. See [LICENSE](LICENSE.md) for more information.
# Citation
For citation you may use the following bibtex entry:
````
@misc{neodroid,
author = {Heider, Christian},
title = {Neodroid Platform},
year = {2018},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/sintefneodroid}},
}
````
# Other Components Of the Neodroid Platform
- [agent](https://github.com/sintefneodroid/agent)
- [simulation](https://github.com/sintefneodroid/simulation)
- [droid](https://github.com/sintefneodroid/droid)
# FAQ
- My iterations per second are maxed out at ~60..
- Ensure that you have disabled vsync, for bumblebee users on linux you can use ```vblank_mode=0 optirun ..```.
- Why was this tool created, what does it serve and not just use Unity's own RL framework?
- This project is very similar to Unity's own project [Unity Machine Learning Agents](https://github.com/Unity-Technologies/ml-agents). The most of the efforts done in this project were made prior to their announcement, [Introducing: Unity Machine Learning Agents](https://blogs.unity3d.com/2017/09/19/introducing-unity-machine-learning-agents/). The entire Neodroid platform served and still serves as a tool for academic research specific to the authors interests, hence explaining to the existence and future direction of this project.
## Other Problems
Please contact us or add an issue if have a problem that is not listed in the FAQ
# Authors
* **Christian Heider Nielsen** - [cnheider](https://github.com/cnheider)
Here other [contributors](https://github.com/sintefneodroid/neo/contributors) to this project are listed.
Raw data
{
"_id": null,
"home_page": "https://github.com/sintefneodroid/neo",
"name": "Neodroid",
"maintainer": "Christian Heider Nielsen",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "christian.heider@alexandra.dk",
"keywords": "python reinforcement-learning interface api",
"author": "Christian Heider Nielsen",
"author_email": "christian.heider@alexandra.dk",
"download_url": "https://github.com/sintefneodroid/neo/releases",
"platform": "",
"description": "\n\n# Neo\nNeo is a python package that enables deserialisation and an interface to the [Droid](https://github.com/sintefneodroid/droid) counterpart of the [Neodroid](https://github.com/sintefneodroid) platform.\n\n---\n\n_[Neodroid](https://github.com/sintefneodroid) is developed with support from Research Council of Norway Grant #262900. ([https://www.forskningsradet.no/prosjektbanken/#/project/NFR/262900](https://www.forskningsradet.no/prosjektbanken/#/project/NFR/262900))_\n\n---\n\n<table>\n <tr>\n <td>\n <a href='https://travis-ci.org/sintefneodroid/neo'>\n <img src='https://travis-ci.org/sintefneodroid/neo.svg?branch=master' alt='Build Status' />\n </a>\n </td>\n <td>\n <a href='https://coveralls.io/github/sintefneodroid/neo?branch=master'>\n <img src='https://coveralls.io/repos/github/sintefneodroid/neo/badge.svg?branch=master' alt='Coverage Status' />\n </a>\n </td>\n <td>\n <a href='https://github.com/sintefneodroid/neo/issues'>\n <img src='https://img.shields.io/github/issues/sintefneodroid/neo.svg?style=flat' alt='GitHub Issues' />\n </a>\n </td>\n <td>\n <a href='https://documentation.neodroid.ml/?badge=latest'>\n <img src='https://readthedocs.org/projects/neodroid/badge/?version=latest' alt='Documentation Status' />\n </a>\n </td>\n </tr>\n <tr>\n <td>\n <a href='https://github.com/sintefneodroid/neo/network'>\n <img src='https://img.shields.io/github/forks/sintefneodroid/neo.svg?style=flat' alt='GitHub Forks' />\n </a>\n </td>\n <td>\n <a href='https://github.com/sintefneodroid/neo/stargazers'>\n <img src='https://img.shields.io/github/stars/sintefneodroid/neo.svg?style=flat' alt='GitHub Stars' />\n </a>\n </td>\n <td>\n <a href='https://github.com/sintefneodroid/neo/blob/master/LICENSE.md'>\n <img src='https://img.shields.io/github/license/sintefneodroid/neo.svg?style=flat' alt='GitHub License' />\n </a>\n </td>\n <td>\n <a href=\"https://pyup.io/repos/github/sintefneodroid/neo/\">\n <img src=\"https://pyup.io/repos/github/sintefneodroid/neo/python-3-shield.svg\" alt=\"Python 3\" />\n </a>\n </td>\n </tr>\n <tr>\n <td>\n <a href='https://pypi.python.org/pypi/Neodroid'>\n <img src='https://pypip.in/v/neodroid/badge.png' alt='Pypi Version' />\n </a>\n </td>\n <td>\n <a href='https://pypi.python.org/pypi/Neodroid'>\n <img src='https://pypip.in/d/neodroid/badge.png' alt='Pypi Downloads' />\n </a>\n </td>\n <td>\n <a href='https://pypi.python.org/pypi/Neodroid'>\n <img src='https://pypip.in/wheel/neodroid/badge.png' alt='Pypi Wheel' />\n </a>\n </td>\n <td>\n <a href=\"https://pyup.io/repos/github/sintefneodroid/neo/\">\n <img src=\"https://pyup.io/repos/github/sintefneodroid/neo/shield.svg\" alt=\"Updates\" />\n </a>\n </td>\n </tr>\n</table>\n\n<p align=\"center\" width=\"100%\">\n <a href=\"https://www.python.org/\">\n <img alt=\"python\" src=\"https://raw.githubusercontent.com/sintefneodroid/neo/master/.github/images/python.svg\" height=\"40\" align=\"left\">\n </a>\n <a href=\"https://github.com/google/flatbuffers\">\n <img alt=\"flatbuffers\" src=\"https://raw.githubusercontent.com/sintefneodroid/neo/master/.github/images/flatbuffers.svg\" height=\"40\" align=\"center\">\n </a>\n <a href=\"https://github.com/zeromq/pyzmq\" >\n <img alt=\"pyzmq\" src=\"https://media.githubusercontent.com/media/sintefneodroid/neo/master/.github/images/pyzmq.png\" height=\"40\" align=\"right\">\n </a>\n</p>\n\n## Installation\n```bash\npip3 install -U neodroid\n```\n\n## Usage\n```py\nimport neodroid as neo\n```\n\n<!---\n ## Features\n-->\n\n## Examples\nWe have included some example applications in this repository.\n\n### Observation Generator\n\n### Random Agent\n\n### Curriculum\n\n### An Example Implementation Of Using An Interface\n\nThe application displays data received from the example application of the [Droid](https://github.com/sintefneodroid/droid) project repository.\n\n\n<!---\n## Screenshots\n-->\n\n# To Do's\n- [ ] Be able to select and/or parameterise an objective/evaluation (None,ReachGoal,Stabilise,..) function for an environment\n\n\n# Contributing\nSee guidelines for contributing [here](.github/CONTRIBUTING.md).\n\n# Licensing\n\nThis project is licensed under the Apache V2 License. See [LICENSE](LICENSE.md) for more information.\n\n# Citation\n\nFor citation you may use the following bibtex entry:\n````\n@misc{neodroid,\n author = {Heider, Christian},\n title = {Neodroid Platform},\n year = {2018},\n publisher = {GitHub},\n journal = {GitHub repository},\n howpublished = {\\url{https://github.com/sintefneodroid}},\n}\n````\n# Other Components Of the Neodroid Platform\n\n- [agent](https://github.com/sintefneodroid/agent)\n- [simulation](https://github.com/sintefneodroid/simulation)\n- [droid](https://github.com/sintefneodroid/droid)\n\n# FAQ\n- My iterations per second are maxed out at ~60..\n - Ensure that you have disabled vsync, for bumblebee users on linux you can use ```vblank_mode=0 optirun ..```.\n- Why was this tool created, what does it serve and not just use Unity's own RL framework?\n - This project is very similar to Unity's own project [Unity Machine Learning Agents](https://github.com/Unity-Technologies/ml-agents). The most of the efforts done in this project were made prior to their announcement, [Introducing: Unity Machine Learning Agents](https://blogs.unity3d.com/2017/09/19/introducing-unity-machine-learning-agents/). The entire Neodroid platform served and still serves as a tool for academic research specific to the authors interests, hence explaining to the existence and future direction of this project.\n\n## Other Problems\nPlease contact us or add an issue if have a problem that is not listed in the FAQ\n\n# Authors\n\n* **Christian Heider Nielsen** - [cnheider](https://github.com/cnheider)\n\nHere other [contributors](https://github.com/sintefneodroid/neo/contributors) to this project are listed.\n\n\n",
"bugtrack_url": null,
"license": "Apache License, Version 2.0",
"summary": "Python interface for the Neodroid platform, an API for communicating with a Unity Game process for a feedback response loop",
"version": "0.4.9",
"split_keywords": [
"python",
"reinforcement-learning",
"interface",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "a57aadf2d7ed8b88f0b824b3bdce911b",
"sha256": "16af1454f0e57a762e66a951022dc594a3653bbeb1d5835ca7cac721375b4eec"
},
"downloads": -1,
"filename": "Neodroid-0.4.9-py36-none-any.whl",
"has_sig": false,
"md5_digest": "a57aadf2d7ed8b88f0b824b3bdce911b",
"packagetype": "bdist_wheel",
"python_version": "py36",
"requires_python": ">=3.6",
"size": 190221,
"upload_time": "2020-06-06T13:01:38",
"upload_time_iso_8601": "2020-06-06T13:01:38.414344Z",
"url": "https://files.pythonhosted.org/packages/98/11/413f8d147bdf27ee6bcfdbafd4f35ecac263644f185b89b9d4e89ede4afb/Neodroid-0.4.9-py36-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2020-06-06 13:01:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "sintefneodroid",
"github_project": "neo",
"travis_ci": true,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "neodroid"
}
JSON
