Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
πŸ“¦ NumberLink v0.1.6 | GitHub⭐ Star us on GitHub
NumberLink Documentation
Light Logo Dark Logo
NumberLink Documentation
  • Installation
  • Usage
  • API Reference
    • numberlink
      • numberlink.registration
      • numberlink.render_utils
      • numberlink.vector_env
      • numberlink.viewer
      • numberlink.types
      • numberlink.cli
      • numberlink.number_render
      • numberlink.env
      • numberlink.main
      • numberlink.levels
      • numberlink.generator
      • numberlink.notebook_viewer
      • numberlink.__main__
      • numberlink.config
      • numberlink.level_setup
Back to top
View this page

numberlinkΒΆ

NumberLink Environment Package for Reinforcement Learning, built on Gymnasium.

The package exposes configuration dataclasses, environment classes, and the LEVELS mapping of built-in levels. Import these symbols for your use or to register the environment using register_numberlink_v0().

The package automatically registers the NumberLinkRGB-v0 environment id with Gymnasium on import by calling register_numberlink_v0() at module initialization. This means import numberlink is sufficient to make the environment available for gymnasium.make("NumberLinkRGB-v0").

When installed from PyPI, the package also exposes packaging entry-points (project.entry-points."gymnasium.envs") so Gymnasium can discover and instantiate the environment through its entry-point system. See the project pyproject.toml for the gymnasium.envs entry-point definitions.

SubmodulesΒΆ

  • numberlink.registration
  • numberlink.render_utils
  • numberlink.vector_env
  • numberlink.viewer
  • numberlink.types
  • numberlink.cli
  • numberlink.number_render
  • numberlink.env
  • numberlink.main
  • numberlink.levels
  • numberlink.generator
  • numberlink.notebook_viewer
  • numberlink.__main__
  • numberlink.config
  • numberlink.level_setup

Package ContentsΒΆ

DataΒΆ

__version__

__author__

__all__

APIΒΆ

numberlink.__version__ = '0.1.6'[source]ΒΆ
numberlink.__author__ = 'Misagh Soltani'[source]ΒΆ
numberlink.__all__: list[str] = ['__version__', '__author__', 'NumberLinkRGBEnv', 'register_numberlink_v0', 'GeneratorConfig', 'Vari...[source]ΒΆ
Next
numberlink.registration
Previous
API Reference
Copyright © 2025 Misagh Soltani
Made with Sphinx and @pradyunsg's Furo
GitHub
On this page
  • numberlink
    • Submodules
    • Package Contents
      • Data
      • API
        • __version__
        • __author__
        • __all__