Usage

Installation

End-user installation

The package is written in pure python and is installable via pip. Optional dependencies (see further down) can be added to provide more functionality: built-in compatibility with common RL libraries, visualization tools, …

(.venv)$ pip install amaze-benchmarker

Warning

Unfortunately the name amaze is already taken by another project on PyPI. Thus the correct package name is amaze-benchmarker, the import still reference the library by its short name (e.g. import amaze and not import amaze-benchmarker)

Tutorials

The reader is first encouraged to play around with the main executable (amaze.bin.main). Without arguments, it will provide an interface where one can manipulate a maze and control an agent via the keyboard.

(.venv)$ amaze

Core functionalities

• Basic usage
• Using graphics
• Custom interfaces
• Full example: Training

Extensions

• Stable baselines 3
  • Training
  • Using

FAQ

Warning

There is a known deleterious interaction between PyQt5 and opencv (imported by stable baselines 3) with both specifying different plugins. The related error is

Error

QObject::moveToThread: Current thread (…) is not the object’s thread (…). Cannot move to target thread (..)

qt.qpa.plugin: Could not load the Qt platform plugin “xcb” in “…/site-packages/cv2/qt/plugins” even though it was found. This application failed to start because no Qt platform plugin could be initialized. Reinstalling the application may fix this problem.

Available platform plugins are: xcb, …

The class amaze.extensions.sb3.guard.CV2QTGuard is automatically called, whenever necessary, as a temporary band aid