Welcome to Gym Xiangqi’s documentation!

Gym Xiangqi is a reinforcement learning environment of the Xiangqi (Chinese Chess) game. The project is built on top of a popular reinforcement learning framework called OpenAI Gym. Please check out this documentation page and our Github repository for more information!

Contents:

• Installation
  • Using PIP
  • Installing from Source
  • Installing for Development
• Examples
  • Training
  • Game (Playing against your agent)
• API
  • XiangQiEnv
  • From Piece Move to XiangQiEnv Action Space
  • From XiangQiEnv Action Space to Piece Move
• GUI
  • The Board and Pieces
  • Captured Log
  • Sound Effects

Indices and tables

• Index

• Module Index

• Search Page