Skip to main content

Python interface for the Neodroid platform, an API for communicating with a Unity Game process for a feedback response loop

Project description

neodroid

Neo

Neo is a python package that enables deserialisation and an interface to the Droid counterpart of the Neodroid platform.


Neodroid is developed with support from Research Council of Norway Grant #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

pip3 install -U neodroid

Usage

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 project repository. neo

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.

Licensing

This project is licensed under the Apache V2 License. See LICENSE 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

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. The most of the efforts done in this project were made prior to their announcement, 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

Here other contributors to this project are listed.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

Neodroid-0.4.9-py36-none-any.whl (190.2 kB view details)

Uploaded Python 3.6

File details

Details for the file Neodroid-0.4.9-py36-none-any.whl.

File metadata

  • Download URL: Neodroid-0.4.9-py36-none-any.whl
  • Upload date:
  • Size: 190.2 kB
  • Tags: Python 3.6
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0.post20200127 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.7.6

File hashes

Hashes for Neodroid-0.4.9-py36-none-any.whl
Algorithm Hash digest
SHA256 16af1454f0e57a762e66a951022dc594a3653bbeb1d5835ca7cac721375b4eec
MD5 a57aadf2d7ed8b88f0b824b3bdce911b
BLAKE2b-256 9811413f8d147bdf27ee6bcfdbafd4f35ecac263644f185b89b9d4e89ede4afb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page