Go to file
Daochen Zha 21e3ead424 Update server 2021-05-27 10:18:30 -05:00
docs Update server 2021-05-27 10:18:30 -05:00
public update website icon; update upload dialog screenshot 2020-12-18 10:46:42 -08:00
server Update server 2021-05-27 10:18:30 -05:00
src finalize translation for doudizhu demo 2021-05-26 23:11:36 -07:00
.eslintrc add config for eslint, prettier; implementing doudizhu demo... 2021-04-14 23:04:21 -07:00
.gitignore Fix delete agent bug and update README 2020-12-06 11:21:49 -06:00
.prettierignore add config for eslint, prettier; implementing doudizhu demo... 2021-04-14 23:04:21 -07:00
.prettierrc add config for eslint, prettier; implementing doudizhu demo... 2021-04-14 23:04:21 -07:00
README.md Update README.md 2020-12-23 21:06:51 -06:00
package.json set up i18n plugin; add locale switch functionality for doudizhu demo 2021-05-25 23:15:16 -07:00
requirements.txt Update server 2021-05-27 10:18:30 -05:00
yarn.lock set up i18n plugin; add locale switch functionality for doudizhu demo 2021-05-25 23:15:16 -07:00

README.md

RLCard Showdown

This is the GUI support for the RLCard project. The project provides evaluation and visualization tools to help understand the performance of the agents. Currently, we only support Leduc Hold'em and Dou Dizhu. The frontend is developed with React. The backend is based on Django. Have fun!

Cite this work

If you find this repo useful, you may cite:

@inproceedings{ijcai2020-764,
  title     = {RLCard: A Platform for Reinforcement Learning in Card Games},
  author    = {Zha, Daochen and Lai, Kwei-Herng and Huang, Songyi and Cao, Yuanpu and Reddy, Keerthana and Vargas, Juan and Nguyen, Alex and Wei, Ruzhe and Guo, Junyu and Hu, Xia},
  booktitle = {Proceedings of the Twenty-Ninth International Joint Conference on
               Artificial Intelligence, {IJCAI-20}},
  publisher = {International Joint Conferences on Artificial Intelligence Organization},             
  editor    = {Christian Bessiere},	
  pages     = {5264--5266},
  year      = {2020},
  month     = {7},
  note      = {Demos}
  doi       = {10.24963/ijcai.2020/764},
  url       = {https://doi.org/10.24963/ijcai.2020/764},
}

Installation

RLCard-Showdown has separated frontend and backend. The frontend is built with React and the backend is based on Django.

Prerequisite

To set up the frontend, you should make sure you have Node.js and NPM installed. Normally you just need to manually install Node.js, and the NPM package would be automatically installed together with Node.js for you. Please refer to its official website for installation of Node.js.

You can run the following commands to verify the installation

node -v
npm -v

For backend, make sure that you have Python 3.5+ and pip installed.

Install Frontend and Backend

The frontend can be installed with the help of NPM:

git clone https://github.com/datamllab/rlcard-showdown.git
cd rlcard-showdown
npm install

The backend can be installed with

pip install -r requirements.txt
cd server
python manage.py migrate
cd ..

Run RLCard-Showdown

Launch the backend with

cd server
python manage.py runserver

Run the following command in a new terminal under the project folder to start frontend in development mode:

npm start

The frontend will be started in port 3000 in localhost by default. You can view it at http://127.0.0.1:3000/. The backend will run by default in http://127.0.0.1:8000/.

More documentation can be found here. User guide is here.

Demos

leaderboards upload doudizhu-replay leduc-replay

Contact Us

If you have any questions or feedback, feel free to drop an email to Songyi Huang for the frontend or Daochen Zha for backend.

Acknowledgements

We would like to thank JJ World Network Technology Co., LTD for the generous support, Chieh-An Tsai for user interface design, and Lei Pan for the help in visualizations.