Skip to content

Latest commit

 

History

History
27 lines (15 loc) · 1.35 KB

CONTRIBUTE.md

File metadata and controls

27 lines (15 loc) · 1.35 KB

如何贡献

欢迎广大开发爱好者为 JoyRL 贡献代码,如果你想参与bug修复的话,直接修改对应的代码然后PR即可,PR教程可参考VS Code快速实现Git PR操作。如果你想贡献新的算法的话,可以按照以下步骤进行,有问题的话随时交流~(微信:johnjim0816)

新建算法

首先在algos目录下新建文件夹,明明为你想要新增的算法名称,并且在config.py下配置好默认参数

配置参数

presets下配置好yaml文件,包括TrainTest的部分。如果新增了通用超参数,需要在config.py下配置好默认参数,若新增了算法超参数,需要在algos下的config.py下配置好默认参数。

运行代码

调试好你的算法代码之后,分别训练和测试一次,将对应输出的文件夹放到benchmarks目录下

注意test模式下请将render设置为True,并且render_mode设置为rgb_array,这样可以生成gif文件,方便可视化对比。

代码注释

注释说明, 本仓库统一中文注释

修改文档

docs/hyper_tuning.md文件中写好你贡献的算法的参数说明

著权署名

README.md的算法列表中增加一行,写上对应的算法和自己的名字,最后PR即可