API Reference

• Environment
  • MahjongEnv
• Observation
  • Observation Encoding
  • Tile Encoding
• Action Space
  • Overview
  • Action Indices
  • Riichi Mechanism
  • Getting Valid Actions
  • Action Constants
• Utilities
  • Test Functions

This section provides detailed documentation for the pymahjong API.

Core Classes

options:
  members:
    - reset
    - step
    - get_obs
    - get_oracle_obs
    - get_full_obs
    - get_valid_actions
    - get_payoffs
    - is_over
    - get_curr_player_id
    - render

options:
  members:
    - reset
    - step
    - get_obs
    - get_oracle_obs
    - get_full_obs
    - get_valid_actions
    - render