c89609fe77
- Rename `retro-gamer create` to `retro-gamer init` with positional args (GAME OUTPUT) instead of --game/--output flags - Add [tool.retro-gamer].factory = "module:attr" to declare the game factory function from pyproject.toml instead of relying on a hard-coded create_game attribute - Remove extras_size from user-facing config; it is now measured automatically from a sample observation and never declared - Update docs throughout: create→init, runs/→training/, add factory field documentation, clarify [model] vs [training] hyperparameter sections, remove stale version-history explanations - Bump version to 0.3.0; require retro-games>=2.5.0
31 lines
604 B
ReStructuredText
31 lines
604 B
ReStructuredText
API Reference
|
|
=============
|
|
|
|
All classes below are importable directly from ``retro_gamer``.
|
|
|
|
Game description
|
|
----------------
|
|
|
|
.. autoclass:: retro_gamer.GameMetadata
|
|
:members: from_pyproject, from_dict, validate, resolve_factory, resolve_observation_function
|
|
|
|
Training
|
|
--------
|
|
|
|
.. autoclass:: retro_gamer.DQNTrainer
|
|
:members: train, load_checkpoint
|
|
|
|
Environment
|
|
-----------
|
|
|
|
.. autoclass:: retro_gamer.GameEnvironment
|
|
:members: reset, step
|
|
|
|
Using a trained model
|
|
---------------------
|
|
|
|
.. autoclass:: retro_gamer.TrainedPolicy
|
|
:members: get_action
|
|
|
|
.. autoclass:: retro_gamer.PolicyInput
|