Updates across the board

2026-06-22 16:41:31 -04:00
parent 5ca97dc5d0
commit 73624d1a0c
33 changed files with 3104 additions and 643 deletions
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -0,0 +1,30 @@
+API Reference
+=============
+
+All classes below are importable directly from ``retro_gamer``.
+
+Game description
+----------------
+
+.. autoclass:: retro_gamer.GameMetadata
+   :members: from_pyproject, from_dict, validate
+
+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