Skip to main content

MahJax

PyPI License Supported Python versions arXiv Documentation

A GPU-Accelerated Mahjong Simulator for Reinforcement Learning in JAX

[!NOTE] Japanese Riichi Mahjong is a challenging multi-agent RL environment with imperfect information, stochastic dynamics, more than two players, and high-dimensional observations. MahJax aims to make Mahjong research more accessible to a broader RL community. For newcomers, please see our basic introduction and the bilingual visualization.

Overview

  • 🚀 Vectorized Environment: Extremely fast (approx. 1M+ steps/sec on 8x A100 GPUs).
  • 🎨 Rich Visualization: SVG-based visualization with bilingual support for those unfamiliar with Kanji.
  • 🎮 Playable Interface: A web-based UI allows you to play directly against the agents you train.
  • 📚 RL Examples: Simple examples for Behavior Cloning + PPO in the examples/.

For more details, please refer to the Documentation.

Quick Start

Install

MahJax is available on PyPI. Please make sure that your Python environment has jax and jaxlib installed, depending on your hardware setup.

pip install mahjax

📣 MahJax is currently under active development. If you prefer to use the latest codebase with the newest features, please clone the repository and install it in editable mode:

git clone https://github.com/nissymori/mahjax.git
cd mahjax
pip install -e .

[!NOTE] The current API is still provisional and under active development, so it may change in future releases.

Basic Usage

We basically follow the Pgx API design.

import jax
import jax.numpy as jnp
import mahjax
from mahjax import save_svg

batch_size = 10
rng = jax.random.PRNGKey(0)

# Initialize environment
env = mahjax.make(
    "red_mahjong",
    round_mode="single", # "single", "east" (tonpuusen), or "half" (hanchan)
    observe_type="dict", # "dict" for Transformer, "2D" for CNN
    order_points=[30, 10, -10, -30], # Final score bonuses (uma)
)

init_fn = jax.jit(jax.vmap(env.init))
step_fn = jax.jit(jax.vmap(env.step))
obs_fn = jax.jit(jax.vmap(env.observe))

# Initialize state
rng, subrng = jax.random.split(rng)
rngs = jax.random.split(subrng, batch_size)
state = init_fn(rngs)

# Step
rng, subrng = jax.random.split(rng)
rngs = jax.random.split(subrng, batch_size)
action = jnp.zeros((batch_size,), dtype=jnp.int8)
state = step_fn(state, action, rngs)

# Get observation
obs = obs_fn(state)

# Visualize (save_svg renders a single, unbatched state)
single_state = env.init(jax.random.PRNGKey(1))
save_svg(
    single_state,
    "state.svg",
    tile_style="bilingual",  # default is "standard"
)

User interface

MahJax includes a web-based UI (FastAPI + JS) that allows you to play against built-in or custom agents directly in your browser.

Running the UI

Install dependencies and start the server:

pip install mahjax
uvicorn mahjax.ui.app:create_app --host 0.0.0.0 --port 8000

Open http://localhost:8000 to start playing. The default agents are the random and rule_based ones.

Playing Against Your Agent

You can register your trained agent to appear in the UI's agent selector. Create a Python script (e.g., my_app.py) and register your agent's act function:

### my_app.py
from pathlib import Path
from mahjax.ui.app import create_app

app = create_app()

# Load your custom agent
app.state.manager.registry.load_callable_from_path(
    file_path=Path("path/to/my_agent.py"),
    attribute="act", # The function name to call: act(state, rng) -> action_id
    description="My Custom Agent",
)

Run uvicorn my_ui:app --port 8000.

Supported Rules

Currently, MahJax supports the following rules:

Rule id Status Code Speed (steps/sec)
No-Red Mahjong no_red_mahjong no_red_mahjong ~2M
Red Mahjong red_mahjong red_mahjong ~1M
Selective Rules - 🚧 - -
3-player Mahjong - 🚧 - -

red_mahjong implements standard 4-player riichi mahjong with red fives. Its rules are designed to follow Tenhou, one of the most widely used online mahjong platforms in Japan, and we validate the implementation against downloaded Tenhou game logs. For the detailed rule specification, see the official Tenhou rules.

no_red_mahjong implements 4-player riichi mahjong without red fives. This variant is intentionally simplified for speed, and excludes some rules such as abortive draws (特殊流局), pao, and double ron. If throughput is your priority, no_red_mahjong is the recommended option (roughly 2x faster).

You can configure the environment with:

  • id: the rule set, such as red_mahjong or no_red_mahjong
  • round_mode: single for a single round, east for tonpuusen (East-only), or half for hanchan (East-South)
  • observe_type: dict for transformer-style inputs or 2D for CNN-style inputs
  • order_points: final placement bonuses (uma), for example [30, 10, -10, -30]
env = mahjax.make(
    "red_mahjong",
    round_mode="single",
    observe_type="dict",
    order_points=[30, 10, -10, -30],
)

[!NOTE] The observation features are not yet finalized (though the current version suffices for RL with BC; see examples/).

See also

JAX-based environments

  • Pgx: Board game environments such as Go, Chess, and Shogi.
  • Brax: Robotics control.
  • Gymnax: Popular small-scale RL environments such as CartPole or bsuite.
  • Jumanji: A diverse suite of RL environments (packing, routing, etc.).
  • Craftax: A JAX version of Crafter + Nethack.
  • JaxMARL: Multi-agent environments such as Hanabi.
  • Navix: A JAX version of MiniGrid.

Cite us

@article{nishimori2026mahjax,
  title         = {Mahjax: A GPU-Accelerated Mahjong Simulator for Reinforcement Learning in JAX},
  author        = {Nishimori, Soichiro and Okano, Shinri and Habara, Keigo and Koyamada, Sotetsu and Yu, Eason and Sugiyama, Masashi},
  journal       = {arXiv preprint arXiv:2605.20577},
  year          = {2026},
}

Acknowledgement

  • sotetsuk: For general advice on the development of MahJax based on his experience developing pgx.
  • habara-k: For developing core JAX components such as shanten and Yaku calculation.
  • OkanoShinri: For the initial implementation of MahJax and its SVG visualization.
  • easonyu0203: For advice on PPO implementation in a multi-player imperfect-information game.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mahjax-0.1.3.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mahjax-0.1.3-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

Details for the file mahjax-0.1.3.tar.gz.

File metadata

  • Download URL: mahjax-0.1.3.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.0

File hashes

Hashes for mahjax-0.1.3.tar.gz
Algorithm Hash digest
SHA256 b18b1960f1f5755fe5c70b39e49349640e0a744f0506854b03db96e6e73286fb
MD5 d4407f747b9f35112344c86e925d7a64
BLAKE2b-256 379a0a10a7d547ae0810ff50cb44520931b4c605453ddd0c6b10a766d46b1486

See more details on using hashes here.

File details

Details for the file mahjax-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: mahjax-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 1.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.0

File hashes

Hashes for mahjax-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 45db9b3e02e64f0ae55560197ac2430b83903baa6d081ce3b81738a5d052d425
MD5 7d011ad2b0736d357ebb567d70f98de5
BLAKE2b-256 7b729f1acacd74097d3c3e046323da758f4a276245f4bc3e6d6bfb35a36cc2cb

See more details on using hashes here.

Release history Release notifications | RSS feed

0.1.4

2 files

This release

0.1.3 This release

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page