跳到主要内容

JoyRL

PyPI GitHub issues GitHub stars GitHub forks GitHub license

JoyRL 是一个基于 PyTorchRay 开发的强化学习(RL)框架,支持串行和并行等方式。相比于其他RL库,JoyRL 旨在帮助用户摆脱算法实现繁琐、API不友好等问题。JoyRL设计的宗旨是,用户只需要通过超参数配置就可以训练和测试强化学习算法,这对于初学者来说更加容易上手,并且JoyRL支持大量的强化学习算法。JoyRL 为用户提供了一个模块化的接口,用户可以自定义自己的算法和环境并使用该框架训练。

安装

⚠️注意:不要使用任何镜像源安装 JoyRL!!!

安装 JoyRL 推荐先安装 Anaconda,然后使用 pip 安装 JoyRL

# 创建虚拟环境
conda create -n joyrl python=3.8
conda activate joyrl
pip install -U joyrl

Torch 安装:

推荐使用 pip 安装,但是如果遇到网络问题,可以尝试使用 conda 安装或者使用镜像源安装。

# pip CPU only
pip install torch==1.10.0 torchvision==0.11.0 torchaudio==0.10.0
# pip GPU with mirror image
pip install torch==1.10.0+cu113 torchvision==0.11.0+cu113 torchaudio==0.10.0 --extra-index-url https://download.pytorch.org/whl/cu113
# CPU only
conda install pytorch==1.10.0 torchvision==0.11.0 torchaudio==0.10.0 cpuonly -c pytorch
# GPU
conda install pytorch==1.10.0 torchvision==0.11.0 torchaudio==0.10.0 cudatoolkit=11.3 -c pytorch -c conda-forge

使用说明

快速开始

以下是一个使用 JoyRL 的示例。如下所示,首先创建一个 yaml 文件来设置超参数,然后在终端中运行以下命令。这就是你需要做的所有事情,就可以在 CartPole-v1 环境上训练一个 DQN 算法。

joyrl --yaml ./presets/ClassControl/CartPole-v1/CartPole-v1_DQN.yaml

或者你可以在python 文件中运行以下代码。

import joyrl
if __name__ == "__main__":
print(joyrl.__version__)
yaml_path = "./presets/ClassControl/CartPole-v1/CartPole-v1_DQN.yaml"
joyrl.run(yaml_path = yaml_path)

文档

点击查看更详细的教程和API文档。