7.8 KiB
7.8 KiB
API Documentation
Changing the Configuration of Frontend
The default configuration for backend server URL is http://127.0.0.1:8000/, you can also change it in /src/utils/config.js.
You will see blank tables on the frontend if you haven't started the backend Django server, or the backend server URL is configured incorrectly.
REST API of Backend
The definitions of the fields are as follows:
eval_num: Integer. The number of evaluation times.name: String. The name of the environment.agent0: String. Model name.agent1: String. Model name.win: Boolean. True if model in the first seat wins.payoff: Float. The payoff of the agent in the first seat.index: Integer. The index of the game of the same environent and same agent. It is in the range [0, eval_num-1]
| type | Resource | Parameters | Description |
|---|---|---|---|
| GET | tournament/launch | num_eval_games, name |
Launch tournment on the game. Each pair of models will play num_eval_games times. Results will be saved in database. |
| GET | tournament/query_game | name, index, agent0, agent1, win, payoff, elements_every_page, page_index |
Query the games with the given parameters |
| GET | tournament/query_payoff | name, agent0, agent1, payoff |
Query the payoffs with the given parameters |
| GET | tournament/query_agent_payoff | name, elements_every_page, page_index, |
Query the payoffs of all the agents |
| GET | tournament/replay | name, agent0, agent1, index |
Return the replay data |
| POST | tournament/upload_agent | model(Python file), name, game, |
Upload a model file. name is model ID |
| GET | tournament/delete_agent | name |
Delete the agent of the given name |
| GET | tournament/list_uploaded_agents | game |
list all the uploaded agents |
| GET | tournament/list_baseline_agents | game |
list all the baseline agents |
| GET | download_examples | name |
download the example agents |
Example API
Registered Models
Some models have been pre-registered as baselines
| Model | Game | Description |
|---|---|---|
| leduc-holdem-random | leduc-holdem | A random model |
| leduc-holdem-cfr | leduc-holdem | Pre-trained CFR model on Leduc Holdem |
| leduc-holdem-rule-v1 | leduc-holdem | A rule model that plays greedily |
| doudizhu-random | doudizhu | A random model |
| doudizhu-rule-v1 | doudizhu | Dou Dizhu rule model |
Example of uploading a new model
A example model file is prepared:
cd server/media/example_agents
Upload the model with curl:
curl -F 'model=@example_luduc_nfsp_model.zip' -F "name=leduc-nfsp" -F "game=leduc-holdem" http://127.0.0.1:8000/tournament/upload_agent
Launch the tounament with:
curl 'http://127.0.0.1:8000/tournament/launch?num_eval_games=200&name=leduc-holdem'
We list the uploaded agent with
curl http://127.0.0.1:8000/tournament/list_uploaded_agents
We can delete the agent with
curl 'http://127.0.0.1:8000/tournament/delete_agent?name=leduc-new'