mirror of
https://github.com/illiumst/marl-factory-grid.git
synced 2025-12-11 01:50:38 +01:00
automodules and small adjustments
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
How to modify the environment or write modules
|
||||
===============================================
|
||||
==============================================
|
||||
|
||||
Modifying levels
|
||||
----------------
|
||||
@@ -20,7 +20,7 @@ Other Entities (define your own) may bring their own `Symbols`.
|
||||
|
||||
|
||||
Modifying Entites
|
||||
----------------
|
||||
-----------------
|
||||
Entities are `Objects`_ that can additionally be assigned a position.
|
||||
Abstract Entities are provided.
|
||||
|
||||
@@ -40,7 +40,7 @@ If you add an entity, you probably also want a collection of that entity.
|
||||
.. _Entity Collections: marl_factory_grid/environment/entity/global_entities.py
|
||||
|
||||
Modifying Rules
|
||||
----------------
|
||||
---------------
|
||||
`Rules`_ define how the environment behaves on micro scale.
|
||||
Each of the hooks (`on_init`, `pre_step`, `on_step`, '`post_step`', `on_done`) provide env-access to implement custom
|
||||
logic, calculate rewards, or gather information.
|
||||
@@ -50,11 +50,11 @@ to implement your own rule logic.
|
||||
|
||||
.. _Rules: marl_factory_grid/environment/entity/object.py
|
||||
|
||||
.. image:: ./images/Hooks_FIKS.png
|
||||
.. image:: ../../images/Hooks_FIKS.png
|
||||
:alt: Hooks Image
|
||||
|
||||
Modifying Results
|
||||
----------------
|
||||
-----------------
|
||||
`Results`_ provide a way to return `rule` evaluations such as rewards and state reports back to the environment.
|
||||
|
||||
.. _Results: marl_factory_grid/utils/results.py
|
||||
@@ -64,7 +64,7 @@ Modifying Assets
|
||||
Make sure to bring your own assets for each Entity living in the Gridworld as the `Renderer` relies on it.
|
||||
PNG-files (transparent background) of square aspect-ratio should do the job, in general.
|
||||
|
||||
.. image:: ./marl_factory_grid/environment/assets/wall.png
|
||||
.. image:: ../../marl_factory_grid/environment/assets/wall.png
|
||||
:alt: Wall Image
|
||||
.. image:: ./marl_factory_grid/environment/assets/agent/agent.png
|
||||
.. image:: ../../marl_factory_grid/environment/assets/agent/agent.png
|
||||
:alt: Agent Image
|
||||
|
||||
Reference in New Issue
Block a user