Skip to main content

Python library for playing DFA bisimulation games and wrapping other RL environments with DFA goals.

Project description

dfa-gym

This repo implements (Multi-Agent) Reinforcement Learning environments in JAX for solving objectives given as Deteministic Finite Automata (DFAs). There are three environments:

  1. TokenEnv is a fully observable grid environment with tokens in cells. The grid can be created randomly or from a specific layout. It can be instantiated in both single- and multi-agent settings.
  2. DFAWrapper is an environment wrapper assigning tasks represented as Deterministic Finite Automata (DFAs) to the agents in the wrapped environment. DFAs are repsented as DFAx objects.
  3. DFABisimEnv is an environment for solving DFA bisimulation games to learn RAD Embeddings, provably correct latent DFA representation, as described in this paper.

Installation

Install using pip.

pip install dfa-gym

TokenEnv

Create a grid world with token and agent positions assigned randomly.

from dfa_gym import TokenEnv

env = TokenEnv(
        n_agents=1, # Single agent
        n_tokens=10, # 10 different token types
        n_token_repeat=2, # Each token repeated twice
        grid_shape=(7, 7), # Shape of the grid
        fixed_map_seed=None, # If not None, then samples the same map using the given seed
        max_steps_in_episode=100, # Episode length is 100
    )

Create a grid world from a given layout.

layout = """
    [ 0 ][   ][   ][   ][ # ][ # ][ # ][ # ][ # ]
    [   ][   ][ a ][   ][#,a][ 0 ][   ][ 2 ][ # ]
    [ A ][   ][ a ][   ][#,a][   ][ 8 ][   ][ # ]
    [   ][   ][ a ][   ][#,a][ 6 ][   ][ 4 ][ # ]
    [ 1 ][   ][   ][ 3 ][ # ][ # ][ # ][ # ][ # ]
    [   ][   ][ b ][   ][#,b][ 1 ][   ][ 3 ][ # ]
    [ B ][   ][ b ][   ][#,b][   ][ 9 ][   ][ # ]
    [   ][   ][ b ][   ][#,b][ 7 ][   ][ 5 ][ # ]
    [ 2 ][   ][   ][   ][ # ][ # ][ # ][ # ][ # ]
    """
    env = TokenEnv(
        layout=layout, # Set layout, where each [] indicates a cell, uppercase letters are
                       # agents, # are walls, and lower case letters are buttons when alone
                       # and doors when paired with a wall. For example, [#,a] is a door
                       # that is open if an agent is on a [ a ] cell and closed otherwise.
    )

DFAWrapper

Wrap a TokenEnv instance using DFAWrapper .

from dfa_gym import DFAWrapper
from dfax.samplers import ReachSampler

env = DFAWrapper(
    env=TokenEnv(layout=layout),
    sampler=ReachSampler()
)

DFABisimEnv

Create DFA bisimulation game.

from dfa_gym import DFABisimEnv
from dfax.samplers import RADSampler

env = DFABisimEnv(sampler=RADSampler())

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

dfa_gym-0.2.7.tar.gz (208.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dfa_gym-0.2.7-py3-none-any.whl (114.1 kB view details)

Uploaded Python 3

File details

Details for the file dfa_gym-0.2.7.tar.gz.

File metadata

  • Download URL: dfa_gym-0.2.7.tar.gz
  • Upload date:
  • Size: 208.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.18

File hashes

Hashes for dfa_gym-0.2.7.tar.gz
Algorithm Hash digest
SHA256 d6fa76ba8f71ed1923d521f78befe6b886e53fa62b0a1435b4a70e770a2983c3
MD5 9c74a7a15598dd931a93cd5c6cb9bc30
BLAKE2b-256 1362efaec587eac41aafc0ee5b0663d53dd84c3c47cf48f914615568e3711f55

See more details on using hashes here.

File details

Details for the file dfa_gym-0.2.7-py3-none-any.whl.

File metadata

  • Download URL: dfa_gym-0.2.7-py3-none-any.whl
  • Upload date:
  • Size: 114.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.18

File hashes

Hashes for dfa_gym-0.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 9790455029e900eadef896c8ae11391ff3227ebc8a5ad34dba72d1bfad577d4d
MD5 3f5cc25f2463c581fcdbe7298ce8d1a4
BLAKE2b-256 565ed1607f344f72ba4fcdd1888008e243a10a94f36502fc57d95182774f6fa2

See more details on using hashes here.

Supported by

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