/phh-std

The Poker Hand History File Format Specification

Primary LanguagePythonMIT LicenseMIT

Poker Hand History File Format Specification

This project defines the poker hand history (PHH) file format, designed to standardize the recording of poker hands across different game variants. Despite poker's widespread popularity in the mainstream culture as a mind sport and its prominence in the field of artificial intelligence (AI) research as a benchmark for imperfect information AI agents, it lacks a consistent format that humans can use to document poker hands across different variants that can also easily be parsed by machines. To address this gap in the literature, we propose the PHH format which provides a concise human-readable machine-friendly representation of hand history that comprehensively captures various details of the hand, ranging from initial game parameters and actions to contextual parameters including but not limited to the venue, players, and time control information.

Example hand histories in the PHH format are provided in our dataset contribution, also hosted on Zenodo. The source code of the parser is available on GitHub as part of our PokerKit project, about which we previously published an accompanying publication on the IEEE Transactions on Games.

Contributing

Contributions are welcome! Please read our Contributing Guide for more information.

License

The PHH file format specification is distributed under the MIT license.

Citing

If you use the PHH file format in your research, please cite the following:

@misc{kim2024recording,
      title={Recording and Describing Poker Hands},
      author={Juho Kim},
      year={2024},
      eprint={2312.11753},
      archivePrefix={arXiv},
      primaryClass={cs.AI}
}

The above preprint has been accepted to the 2024 IEEE Conference on Games (CoG). When the proceedings are published, the BibTex above will be updated to point to the published paper.