Skip to content

[Feature Request] Improve API consistency #223

@bheijden

Description

@bheijden

🚀 Feature

  • Rename actions/observations to outputs/inputs, respectively in the Graph.
  • Only refer to outputs/inputs as actions/observations if GymBaseEnv is used. Else stick to outputs/inputs naming convention.
  • Rename sensors/actuators to outputs/inputs, respectively in the EngineGraph.

Motivation

Even though the API in Graph and EngineGraph for nodes (inputs/outputs), objects (actuators/sensors), and the environment (actions/observations) are practically the same, they have different names. This unnecessarily confuses new users. Referring to all of them as either an input or output will make the API more consistent and easier to grasp.

Checklist

  • I have checked that there is no similar issue in the repo (required)

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestuser-friendlyMeasure to improve user-friendliness (e.g. via defensive programming, erorr checking, etc...)

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions