Gym-MiniGrid/docs/_scripts/gen_envs_display.py

from __future__ import annotations

import os

import gymnasium

# Display bonus WFC presets
from minigrid.envs.wfc import WFCEnv
from minigrid.envs.wfc.config import (
    WFC_PRESETS_INCONSISTENT,
    WFC_PRESETS_SLOW,
    register_wfc_presets,
)
from utils import env_name_format

register_wfc_presets(WFC_PRESETS_INCONSISTENT, gymnasium.register)
register_wfc_presets(WFC_PRESETS_SLOW, gymnasium.register)

# Read name from the actual class so it is updated if the class name changes
WFCENV_NAME = WFCEnv.__name__


def title_from_id(env_id):
    words = []
    for chunk in env_id.split("_"):
        words.extend(env_name_format(chunk).split(" "))

    return " ".join(w.title() for w in words)


def create_grid_cell(type_id, env_id, base_path):
    # All WFCEnv environments should link to WFCEnv page
    href = f"{base_path}{env_id if type_id != 'wfc' else WFCENV_NAME}"
    return f"""
            <a href="{href}">
                <div class="env-grid__cell">
                    <div class="cell__image-container">
                        <img src="/_static/videos/{type_id}/{env_id}.gif">
                    </div>
                    <div class="cell__title">
                        <span>{title_from_id(env_id)}</span>
                    </div>
                </div>
            </a>
    """


def generate_page(env, limit=-1, base_path=""):
    env_type_id = env["id"]
    env_list = env["list"]
    cells = [create_grid_cell(env_type_id, env_id, base_path) for env_id in env_list]
    non_limited_page = limit == -1 or limit >= len(cells)
    if non_limited_page:
        cells = "\n".join(cells)
    else:
        cells = "\n".join(cells[:limit])

    more_btn = (
        """
<a href="./complete_list">
    <button class="more-btn">
        See More Environments
    </button>
</a>
"""
        if not non_limited_page
        else ""
    )
    return f"""
<div class="env-grid">
    {cells}
</div>
{more_btn}
    """


if __name__ == "__main__":
    """
    python gen_envs_display
    """
    type_dict = {}

    for env_spec in gymnasium.envs.registry.values():
        if isinstance(env_spec.entry_point, str):
            # minigrid.envs:Env or minigrid.envs.babyai:Env
            split = env_spec.entry_point.split(".")
            # ignore minigrid.envs.env_type:Env
            env_module = split[0]
            env_name = split[-1].split(":")[-1]
            env_type = env_module if len(split) == 2 else split[-1].split(":")[0]

            if env_name == WFCENV_NAME:
                env_name = env_spec.kwargs["wfc_config"]
                assert isinstance(env_name, str)

            if env_module == "minigrid":
                if env_type not in type_dict.keys():
                    type_dict[env_type] = []

                if env_name not in type_dict[env_type]:
                    type_dict[env_type].append(env_name)
        else:
            continue

    for key, value in type_dict.items():
        env_type = key

        page = generate_page({"id": key, "list": value})
        fp = open(
            os.path.join(
                os.path.dirname(__file__), "..", "environments", env_type, "list.html"
            ),
            "w",
            encoding="utf-8",
        )
        fp.write(page)
        fp.close()