gnubg-nn 1.1.0a6

Python3 bindings for GNUBG neural evaluation

GNUBG Neural Networks

GNUBG Neural Networks (this package, gnubg-nn) is a library that provides Python bindings to the GNUBG neural-network evaluation engine — the same engine used for position analysis and cube decisions in the full GNU Backgammon application, but packaged as a standalone library for use in scripts, analysis tools, and applications. It is not the full backgammon game (GUI, match play, etc.).

Quick Start

gnubg_nn is a native Python extension module that wraps the GNUBG neural-net evaluation library, so you can call the same position-analysis and cube-decision routines that power the full GNU Backgammon application from any Python 3.10+ script or application. It’s ideal for batch processing, data-science workflows, or building custom tools and UIs.

Installation

pip install gnubg-nn

Getting Started

import gnubg_nn

# Load the engine (weights, bear-off tables, etc. are initialized)
gnubg_nn.initnet()

# Convert a position key (20-char A–Z or 14-char Base64) to a board
board = gnubg_nn.boardfromkey("4HPwATDgc/ABMA")

# Evaluate win/gammon/backgammon probabilities and equity at 4 plies
win, gamm, bg, equity = gnubg_nn.probabilities(board, 4)

print(f"Win: {win:.3f}, Gammon: {gamm:.3f}, Backgammon: {bg:.3f}, Equity: {equity:.3f}")

That’s all you need to get up and running! For detailed API docs, advanced build options, and configuration, see the sections below or visit the full documentation on ReadTheDocs.

• ReadTheDocs https://gnubg.readthedocs.io/en/latest/
• GNU Backgammon (full application): https://www.gnu.org/software/gnubg/
• Original Documentation: http://www.gnubg.org/documentation/doku.php?id=gnu_backgammon_faq
• Mailing list: https://lists.gnu.org/mailman/listinfo/gnubg
• Source code: https://github.com/StonesAndDice/gnubg-nn-pypi
• GNUBG Neural Networks (gnubg-nn) upstream: https://git.savannah.gnu.org/cgit/gnubg/gnubg-nn.git
• Contributing: https://savannah.gnu.org/people/
• Credits: https://git.savannah.gnu.org/cgit/gnubg.git/tree/credits.sh

It provides:

• Engine initialization & data loading (neural-net weights, opening-book, bear-off tables)
• Position classification (classify) & public-evaluation best move (pub_best_move)
• Board ↔ ID conversions (board_from_position_id, board_from_position_key, key_of_board, position_id)
• Dice utilities (roll) & cube utilities (best_move, pub_eval_score)
• Bear-off tools (bearoff_id_2_pos, bearoff_probabilities)
• Legal-move enumeration (moves) & probabilistic evaluation (probabilities)
• Monte-Carlo rollouts (rollout, cubeful_rollout)
• Equity lookup (equities.value(xAway, oAway))
• Runtime engine tuning via the set submodule

🧪 Platform Compatibility

Python Version	Linux x86_64 (glibc ≥ 2.17)	Linux i686 (glibc ≥ 2.12)	macOS universal2	Windows x86_64
3.14	✅	✅	✅ (macOS ≥ 10.14)	✅
3.13	✅	✅	✅ (macOS ≥ 10.14)	✅
3.12	✅	✅	✅ (macOS ≥ 10.14)	✅
3.11	✅	✅	✅ (macOS ≥ 10.9)	✅
3.10	✅	✅	✅ (macOS ≥ 10.9)	✅

Notes:

• ✅ = Built and available
• ❌ = Not built
• macOS universal2 = Supports both ARM64 and x86-64 architectures

Testing

gnubg-nn-pypi has some basic unit testing. After installation, run:

python3 -m unittest discover -s gnubg_nn.tests

AI-Assisted Development

Parts of this project were developed with the assistance of generative AI tools.

Specifically, the following models were used:

• GPT-4o (OpenAI ChatGPT)
• o4-mini-high (OpenAI ChatGPT)

These models were used to assist with code generation, documentation drafting, and architectural guidance. All outputs were reviewed and curated by a human before inclusion.

⚠️ Disclaimer:
Although human-reviewed, some AI-generated content may contain mistakes, inaccuracies, or outdated practices. Contributors and users should critically assess all code, comments, and documentation. We welcome corrections and improvements via pull requests or issues.

Code of Conduct

Please read the Code of Conduct to learn how to interact positively.

Contributing

Your expertise and enthusiasm are welcome! You can contribute by:

• Reviewing and testing pull requests
• Reporting and triaging issues
• Improving documentation, tutorials, and examples
• Enhancing engine parameters or submodules
• Maintaining website or branding assets
• Translating materials
• Assisting with outreach and onboarding
• Writing grant proposals or helping with fundraising

For more information, see our Contributing Guide. If you’re unsure where to start, open an issue or join the discussion on our mailing list!

Acknowledgments

This project builds upon the extensive work of the GNU Backgammon (GNUBG) community. The gnubg-nn library is the neural network evaluation component; the full backgammon application (GUI, match play, etc.) is maintained separately. We specifically acknowledge the pygnubg program developed by Joseph Heled.

We express our gratitude to all contributors who have dedicated their time and expertise to the development of the GNUBG neural network library and its Python bindings.

• AUTHORS.md: A list of primary contributors to the gnubg-nn-pypi project can be found here.
• GNU Backgammon (full project) credits.sh: For a comprehensive list of contributors to the full GNUBG application, please refer to the credits.sh file.

We also thank the broader GNUBG community, including testers, translators, and mailing list participants, for their invaluable support.