mirror of
https://github.com/saymrwulf/stable-baselines3.git
synced 2026-05-23 22:20:18 +00:00
* Fix custom policy example * Add RL Zoo doc link * Add changelog to pypi * Add SBX doc page * Fix small mistake in docstring --------- Co-authored-by: Peter Elmers <peter.elmers@yahoo.com>
66 lines
1.7 KiB
ReStructuredText
66 lines
1.7 KiB
ReStructuredText
.. _sbx:
|
|
|
|
==========================
|
|
Stable Baselines Jax (SBX)
|
|
==========================
|
|
|
|
`Stable Baselines Jax (SBX) <https://github.com/araffin/sbx>`_ is a proof of concept version of Stable-Baselines3 in Jax.
|
|
|
|
It provides a minimal number of features compared to SB3 but can be much faster (up to 20x times!): https://twitter.com/araffin2/status/1590714558628253698
|
|
|
|
Implemented algorithms:
|
|
|
|
- Soft Actor-Critic (SAC) and SAC-N
|
|
- Truncated Quantile Critics (TQC)
|
|
- Dropout Q-Functions for Doubly Efficient Reinforcement Learning (DroQ)
|
|
- Proximal Policy Optimization (PPO)
|
|
- Deep Q Network (DQN)
|
|
|
|
|
|
As SBX follows SB3 API, it is also compatible with the `RL Zoo <https://github.com/DLR-RM/rl-baselines3-zoo>`_.
|
|
For that you will need to create two files:
|
|
|
|
``train_sbx.py``:
|
|
|
|
.. code-block:: python
|
|
|
|
import rl_zoo3
|
|
import rl_zoo3.train
|
|
from rl_zoo3.train import train
|
|
from sbx import DQN, PPO, SAC, TQC, DroQ
|
|
|
|
|
|
rl_zoo3.ALGOS["tqc"] = TQC
|
|
rl_zoo3.ALGOS["droq"] = DroQ
|
|
rl_zoo3.ALGOS["sac"] = SAC
|
|
rl_zoo3.ALGOS["ppo"] = PPO
|
|
rl_zoo3.ALGOS["dqn"] = DQN
|
|
rl_zoo3.train.ALGOS = rl_zoo3.ALGOS
|
|
rl_zoo3.exp_manager.ALGOS = rl_zoo3.ALGOS
|
|
|
|
if __name__ == "__main__":
|
|
train()
|
|
|
|
Then you can call ``python train_sbx.py --algo sac --env Pendulum-v1`` and use the RL Zoo CLI.
|
|
|
|
|
|
``enjoy_sbx.py``:
|
|
|
|
.. code-block:: python
|
|
|
|
import rl_zoo3
|
|
import rl_zoo3.enjoy
|
|
from rl_zoo3.enjoy import enjoy
|
|
from sbx import DQN, PPO, SAC, TQC, DroQ
|
|
|
|
|
|
rl_zoo3.ALGOS["tqc"] = TQC
|
|
rl_zoo3.ALGOS["droq"] = DroQ
|
|
rl_zoo3.ALGOS["sac"] = SAC
|
|
rl_zoo3.ALGOS["ppo"] = PPO
|
|
rl_zoo3.ALGOS["dqn"] = DQN
|
|
rl_zoo3.enjoy.ALGOS = rl_zoo3.ALGOS
|
|
rl_zoo3.exp_manager.ALGOS = rl_zoo3.ALGOS
|
|
|
|
if __name__ == "__main__":
|
|
enjoy()
|