Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

23 lines (16 loc) · 1.79 KB

Contibuting Guide

Contribution to this project is greatly appreciated! If you find any bugs or have any feedback, please create an issue or send a pull request to fix the bug. If you want to contribute codes for new features, please contact daochen.zha@tamu.edu or khlai@tamu.edu. We currently have several plans. Please create an issue or contact us through emails if you have other suggestions.

Roadmaps

  • Rule-based Agent and Pre-trained Models. Provide more rule-based agents and pre-trained models to benchmark the evaluation. We currently have several models in /models.
  • More Games and Algorithms. Develop more games and algorithms.
  • Keras Implementation Provide Keras Implementation of the algorithms.
  • Hyperparameter Search Search hyperparameters for each environment and update the best one in the example.

How to Create a Pull Request

If this your first time to contribute to a project, kindly follow the following instructions. You may find Creating a pull request helpful. Mainly, you need to take the following steps to send a pull request:

  • Click Fork in the upper-right corner of the project main page to create a new branch in your local Github.
  • Clone the repo from your local repo in your Github.
  • Make changes in your computer.
  • Commit and push your local changes to your local repo.
  • Send a pull request to merge your local branch to the branches in RLCard project.

Testing Your Code

We strongly encourage you to write the testing code in parallel with your development. We use unittest in RLCard. An example is Blackjack environment testing.