Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sintefneodroid/neo

Python interface for the Neodroid platform 💻
https://github.com/sintefneodroid/neo

agent api blazing deep-learning droid fast hacktoberfest interface ml neo neodroid neural-network python reinforcement-learning rl serves unity

Last synced: 3 months ago
JSON representation

Python interface for the Neodroid platform 💻

Awesome Lists containing this project

README

        


header

Neo

Neo is a python package that enables deserialisation, serialisation 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))_

---




Build Status




Coverage Status




GitHub Issues




Documentation Status






GitHub Forks




GitHub Stars




GitHub License




Python 3






Pypi Version




Pypi Downloads




Pypi Wheel




Updates




python


flatbuffers


pyzmq

## Installation
```bash
pip3 install -U neodroid
```

## Usage
```py
import neodroid as neo
```

## 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.
![neo](.github/images/neo.png)

# 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.