Skip to main content

__init__

alphacube package provides a flexible API for solving Rubik's Cubes.

High-Level API (recommended for most users):

  • load(*args, **kwargs): Convenience function to load a model into a default global solver.
  • solve(*args, **kwargs): Convenience function to solve a cube using the default global solver.

Core Class (for advanced usage):

  • Solver: The main class for creating solver instances, loading models, and solving cubes.

Utilities:

  • set_verbose(loglevel): Set the verbosity level of the logger.
  • list_models(): List available pre-trained models.
  • device: The auto-detected torch.device (e.g., 'cuda', 'cpu').
  • dtype: The auto-detected torch.dtype (e.g., 'torch.float16').
  • cli(): Command-line utility for solving a Rubik's Cube.

See Getting Started for the basic usage.