Skip to main content

A framework to research MARL agents in various setings.

Project description

EDYS

Tackling emergent dysfunctions (EDYs) in cooperation with Fraunhofer-IKS

Setup

Just install this environment by pip install marl-factory-grid.

First Steps

Quickstart

Most of the env. objects (entites, rules and assets) can be loaded automatically. Just define what your environment needs in a yaml-configfile like:

Example ConfigFile General: level_name: rooms env_seed: 69 verbose: !!bool False pomdp_r: 5 individual_rewards: !!bool True
Entities:
    Defaults: {}
    Doors:
        closed_on_init: True
        auto_close_interval: 10
        indicate_area: False
    Destinations: {}

Agents:
    Wolfgang:
        Actions:
            - Move8
            - Noop
            - DoorUse
            - ItemAction
        Observations:
            - All
            - Placeholder
            - Walls
            - Items
            - Placeholder
            - Doors
            - Doors
    Armin:
        Actions:
            - Move4
            - ItemAction
            - DoorUse
        Observations:
            - Combined:
                - Agent['Wolfgang']
                - Walls
                - Doors
                - Items
Rules:
    Defaults: {}
    Collision:
        done_at_collisions: !!bool True
    ItemRespawn:
        spawn_freq: 5
    DoorAutoClose: {}

Assets:
- Defaults
- Items
- Doors

Have a look in \quickstart for further configuration examples.

Make it your own

Levels

Varying levels are created by defining Walls, Floor or Doors in .txt-files (see ./environment/levels for examples). Define which level to use in your configfile as:

General:
    level_name: rooms  # 'double', 'large', 'simple', ...

... or create your own , maybe with the help of asciiflow.com. Be sure to use '#' as Walls, '-' as free (walkable) Floor-Tiles, 'D' for Doors. Custom Entites (define you own) may bring their own "Symbol"

Entites

Entites are either Objects for tracking stats or env. Entity which can interact. Abstract Entities are provided.

Groups

Groups are entity Sets that provide administrative access to all group members. All Entites are available at runtime as EnvState property.

Rules

Rules define how the environment behaves on micro-scale. Each of the hookes ('on_init', 'pre-step', 'on_step', 'post_step', 'on_done') provide env-access to implement customn logic, calculate rewards, or gather information.

Results provide a way to return 'rule' evaluations such as rewards and state reports back to the environment.

Assets

Make sure to bring your own assets for each Entity, that is living in the Gridworld, the 'Renderer' relies on it. PNG-files (transparent background) of square aspect-ratio should do the job, in general.

|

Project details


Download files

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

Source Distribution

Marl-Factory-Grid-0.0.6.tar.gz (176.4 kB view details)

Uploaded Source

File details

Details for the file Marl-Factory-Grid-0.0.6.tar.gz.

File metadata

  • Download URL: Marl-Factory-Grid-0.0.6.tar.gz
  • Upload date:
  • Size: 176.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for Marl-Factory-Grid-0.0.6.tar.gz
Algorithm Hash digest
SHA256 14832147c0f1941a9468d22406bc1ba8d1f5b9250f3f3f7099943e1539d4175c
MD5 dc9806b4fe364e50a9b44570ea2d0c38
BLAKE2b-256 3c9403eeef3c3f3858466572ec22629c8766265c4629b76b16cd26bd24208efe

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