Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
EthicalGardeners documentation
EthicalGardeners documentation
Select a version (v: v1.0)

Branches (dev features)

  • main
  • fix_hydra_logs

Released versions

  • v1.0

Tutorials:

  • Launching the Ethical Gardeners Simulation
  • Configuration Guide for Ethical Gardeners Simulation
  • How to Extend the Ethical Gardeners Environment
  • Using Ethical Gardeners with Custom Algorithms

API

  • API Reference
    • ethicalgardeners
      • ethicalgardeners.action
        • ethicalgardeners.action.create_action_enum
      • ethicalgardeners.actionhandler
        • ethicalgardeners.actionhandler.ActionHandler
      • ethicalgardeners.agent
        • ethicalgardeners.agent.Agent
      • ethicalgardeners.algorithms
        • ethicalgardeners.algorithms.evaluate
        • ethicalgardeners.algorithms.get_latest_policy
        • ethicalgardeners.algorithms.make_SB3_env
        • ethicalgardeners.algorithms.make_env_thunk
        • ethicalgardeners.algorithms.mask_fn
        • ethicalgardeners.algorithms.predict_action
        • ethicalgardeners.algorithms.save_model
        • ethicalgardeners.algorithms.train
        • ethicalgardeners.algorithms.SB3Wrapper
      • ethicalgardeners.constants
        • ethicalgardeners.constants.MAX_PENALTY_TURNS
        • ethicalgardeners.constants.FEATURES_PER_CELL
        • ethicalgardeners.constants.AGENT_PALETTE
        • ethicalgardeners.constants.FLOWER_PALETTE
        • ethicalgardeners.constants.MIN_SEED_RETURNS
        • ethicalgardeners.constants.MAX_SEED_RETURNS
      • ethicalgardeners.gardenersenv
        • ethicalgardeners.gardenersenv.GardenersEnv
      • ethicalgardeners.gridworld
        • ethicalgardeners.gridworld.Cell
        • ethicalgardeners.gridworld.CellType
        • ethicalgardeners.gridworld.Flower
        • ethicalgardeners.gridworld.GridWorld
      • ethicalgardeners.main
        • ethicalgardeners.main.main
        • ethicalgardeners.main.make_agent_algorithm
        • ethicalgardeners.main.make_env
        • ethicalgardeners.main.run_simulation
      • ethicalgardeners.metricscollector
        • ethicalgardeners.metricscollector.MetricsCollector
      • ethicalgardeners.observation
        • ethicalgardeners.observation.ObservationStrategy
        • ethicalgardeners.observation.PartialObservation
        • ethicalgardeners.observation.TotalObservation
      • ethicalgardeners.renderer
        • ethicalgardeners.renderer.ConsoleRenderer
        • ethicalgardeners.renderer.GraphicalRenderer
        • ethicalgardeners.renderer.Renderer
      • ethicalgardeners.rewardfunctions
        • ethicalgardeners.rewardfunctions.RewardFunctions
    • ethicalgardeners.action._ActionEnum
Back to top
View this page

API ReferenceΒΆ

ethicalgardeners

Ethical Gardeners: A simulation environment for ethical reinforcement learning.

ethicalgardeners.action._ActionEnum(...[, ...])

Custom enum for actions.
Next
ethicalgardeners
Previous
Using Ethical Gardeners with Custom Algorithms
Copyright © 2025, Enzo Dos Anjos, Remy Chaput
Made with Sphinx and @pradyunsg's Furo