datamllab / rlcard / 260

Build # 260

Build Type

push

travis-ci

Committed by Daochen

Commit Message

<a href="https://github.com/datamllab/rlcard/commit/<a class=hub.com/datamllab/rlcard/commit/<a class="double-link" href="https://git"><a class=hub.com/datamllab/rlcard/commit/<a class="double-link" href="https://git"><a class=hub.com/datamllab/rlcard/commit/<a class="double-link" href="https://git"><a class=hub.com/datamllab/rlcard/commit/<a class="double-link" href="https://git"><a class=hub.com/datamllab/rlcard/commit/a4237433a6d2a709c8024d772d3e41d4c7e27814">a4237433a<a href="https://github.com/datamllab/rlcard/commit/a4237433a6d2a709c8024d772d3e41d4c7e27814">&lt;a href=&quot;https://github.com/datamllab/rlcard/commit/a4237433a6d2a709c8024d772d3e41d4c7e27814">&lt;a href=&quot;https://github.com/datamllab/rlcard/commit/a4237433a6d2a709c8024d772d3e41d4c7e27814&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/datamllab/rlcard/commit/a4237433a6d2a709c8024d772d3e41d4c7e27814&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/datamllab/rlcard/commit/a4237433a6d2a709c8024d772d3e41d4c7e27814&amp;amp;quot;&amp;amp;gt;&amp;amp;quot;&amp;amp;gt;Squashed commit of the following:

commit &amp;amp;lt;/a&amp;amp;gt;&amp;amp;lt;a class=&amp;amp;quot;double-link&amp;amp;quot; href=&amp;amp;quot;https://github.com/datamllab/rlcard/commit/&amp;amp;lt;a class=&amp;amp;quot;double-link&amp;amp;quot; href=&amp;amp;quot;https://github.com/datamllab/rlcard/commit/9f18f813d824fa781b2af8605ff0f057b01dabc2&amp;amp;quot;&amp;amp;gt;9f18f813d&amp;amp;lt;/a&amp;amp;gt;&amp;amp;quot;&amp;amp;gt;9f18f813d&amp;amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/datamllab/rlcard/commit/a4237433a6d2a709c8024d772d3e41d4c7e27814&amp;quot;&amp;gt;
Author: Yuanpu &amp;amp;lt;yuanpucao@gmail.com&amp;amp;gt;
Date:   Fri Oct 11 03:46:52 2019 +0800

    update multi process doc

commit &amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/datamllab/rlcard/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/datamllab/rlcard/commit/82adc14325a361bfce35caed6faf36d3bc5aa6ab&quot;&gt;82adc1432&lt;/a&gt;&quot;&gt;82adc1432&lt;/a&gt;&lt;a href=&quot;https://github.com/datamllab/rlcard/commit/a4237433a6d2a709c8024d772d3e41d4c7e27814&quot;&gt;
Author: Daochen &amp;lt;daochen@datalab4.engr.tamu.edu&amp;gt;
Date:   Thu Oct 10 10:39:51 2019 -0500

    readme

commit &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/datamllab/rlcard/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/datamllab/rlcard/commit/d61da683569ef353f12dbd136012a81e73e9e821&quot;&gt;d61da6835&lt;/a&gt;&quot;&gt;d61da6835&lt;/a&gt;&lt;a href=&quot;https://github.com/datamllab/rlcard/commit/a4237433a6d2a709c8024d772d3e41d4c7e27814">
Author: Daochen &lt;daochen@datalab4.engr.tamu.edu&gt;
Date:   Thu Oct 10 09:43:38 2019 -0500

    fix leduc bug

commit </a><a class="double-link" href="https://github.com/datamllab/rlcard/commit/<a class="double-link" href="https://github.com/datamllab/rlcard/commit/d16ecbb93a34cdd2149ee38f00d2f615a654c6a5">d16ecbb93</a>">d16ecbb93</a><a href="https://github.com/datamllab/rlcard/commit/a4237433a6d2a709c8024d772d3e41d4c7e27814">
Author: Daochen &lt;daochen@datalab4.engr.tamu.edu&gt;
Date:   Thu Oct 10 08:28:43 2019 -0500

    docs and models

commit </a><a class="double-link" href="https://github.com/datamllab/rlcard/commit/7bf4fad97">7bf4fad97
Author: Yuanpu <yuanpucao@gmail.com>
Date:   Thu Oct 10 11:40:33 2019 +0800

    dqn multi-process

commit a9a21bd18">a9a21bd18<... (continued)

Run Details

1968 of 1968 new or added lines in 56 files covered. (100.0%)

3281 of 3433 relevant lines covered (95.57%)

0.96 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

69.81

/rlcard/core.py

''' Game-related and Env-related base classes
'''

class Card(object):
    '''
    Card stores the suit and rank of a single card

    Note:
        The suit variable in a standard card game should be one of [S, H, D, C, BJ, RJ] meaning [Spades, Hearts, Diamonds, Clubs, Black Joker, Red Joker]
        Similarly the rank variable should be one of [A, 2, 3, 4, 5, 6, 7, 8, 9, T, J, Q, K]
    '''

    suit = None
    rank = None
    valid_suit = ['S', 'H', 'D', 'C', 'BJ', 'RJ']
    valid_rank = ['A', '2', '3', '4', '5', '6', '7', '8', '9', 'T', 'J', 'Q', 'K']

    def __init__(self, suit, rank):
        ''' Initialize the suit and rank of a card

        Args:
            suit: string, suit of the card, should be one of valid_suit
            rank: string, rank of the card, should be one of valid_rank
        '''
        self.suit = suit
        self.rank = rank

    def get_index(self):
        ''' Get index of a card.

        Returns:
            string: the combination of suit and rank of a card. Eg: 1S, 2H, AD, BJ, RJ...
        '''
        return self.suit+self.rank


class Dealer(object):
    ''' Dealer stores a deck of playing cards, remained cards holded by dealer, and can deal cards to players

    Note: deck variable means all the cards in a single game, and should be a list of Card objects.
    '''

    deck = []
    remained_cards = []

    def __init__(self):
        ''' The dealer should have all the cards at the beginning of a game
        '''
        raise NotImplementedError

    def shuffle(self):
        ''' Shuffle the cards holded by dealer(remained_cards)
        '''
        raise NotImplementedError

    def deal_cards(self, **kwargs):
        ''' Deal specific number of cards to a specific player

        Args:
            player_id: the id of the player to be dealt cards
            num: number of cards to be dealt
        '''
        raise NotImplementedError

class Player(object):
    ''' Player stores cards in the player's hand, and can determine the actions can be made according to the rules
    '''

    player_id = None
    hand = []

    def __init__(self, player_id):
        ''' Every player should have a unique player id
        '''
        self.player_id = player_id

    def available_order(self):
        ''' Get the actions can be made based on the rules

        Returns:
            list: a list of available orders
        '''
        raise NotImplementedError

    def play(self):
        ''' Player's actual action in the round
        '''
        raise NotImplementedError

class Judger(object):
    ''' Judger decides whether the round/game ends and return the winner of the round/game
    '''

    def judge_round(self, **kwargs):
        ''' Decide whether the round ends, and return the winner of the round

        Returns:
            int: return the player's id who wins the round or -1 meaning the round has not ended
        '''
        raise NotImplementedError

    def judge_game(self, **kwargs):
        ''' Decide whether the game ends, and return the winner of the game

        Returns:
            int: return the player's id who wins the game or -1 meaning the game has not ended
        '''
        raise NotImplementedError


class Round(object):
    ''' Round stores the id the ongoing round and can call other Classes' functions to keep the game running
    '''

    def __init__(self):
        ''' When the game starts, round id should be 1
        '''

        raise NotImplementedError

    def proceed_round(self, **kwargs):
        ''' Call other Classes's functions to keep the game running
        '''
        raise NotImplementedError


class Game(object):
    ''' Game class. This class will interact with outer environment.
    '''

    def init_game(self):
        ''' Initialize all characters in the game and start round 1
        '''
        raise NotImplementedError

    def step(self, action):
        ''' Perform one draw of the game and return next player number, and the state for next player
        '''
        raise NotImplementedError

    def step_back(self):
        ''' Takes one step backward and restore to the last state
        '''
        raise NotImplementedError

    def get_player_num(self):
        ''' Retrun the number of players in the game
        '''
        raise NotImplementedError

    def get_action_num(self):
        ''' Return the number of possible actions in the game
        '''
        raise NotImplementedError

    def get_player_id(self):
        ''' Return the current player that will take actions soon
        '''
        raise NotImplementedError

    def is_over(self):
        ''' Return whether the current game is over
        '''
        raise NotImplementedError


1	''' Game-related and Env-related base classes
2	'''
3
4	class Card(object):	1✔
5	'''
6	Card stores the suit and rank of a single card
7
8	Note:
9	The suit variable in a standard card game should be one of [S, H, D, C, BJ, RJ] meaning [Spades, Hearts, Diamonds, Clubs, Black Joker, Red Joker]
10	Similarly the rank variable should be one of [A, 2, 3, 4, 5, 6, 7, 8, 9, T, J, Q, K]
11	'''
12
13	suit = None	1✔
14	rank = None	1✔
15	valid_suit = ['S', 'H', 'D', 'C', 'BJ', 'RJ']	1✔
16	valid_rank = ['A', '2', '3', '4', '5', '6', '7', '8', '9', 'T', 'J', 'Q', 'K']	1✔
17
18	def __init__(self, suit, rank):	1✔
19	''' Initialize the suit and rank of a card
20
21	Args:
22	suit: string, suit of the card, should be one of valid_suit
23	rank: string, rank of the card, should be one of valid_rank
24	'''
25	self.suit = suit	1✔
26	self.rank = rank	1✔
27
28	def get_index(self):	1✔
29	''' Get index of a card.
30
31	Returns:
32	string: the combination of suit and rank of a card. Eg: 1S, 2H, AD, BJ, RJ...
33	'''
34	return self.suit+self.rank	1✔
35
36
37	class Dealer(object):	1✔
38	''' Dealer stores a deck of playing cards, remained cards holded by dealer, and can deal cards to players
39
40	Note: deck variable means all the cards in a single game, and should be a list of Card objects.
41	'''
42
43	deck = []	1✔
44	remained_cards = []	1✔
45
46	def __init__(self):	1✔
47	''' The dealer should have all the cards at the beginning of a game
48	'''
49	raise NotImplementedError	×
50
51	def shuffle(self):	1✔
52	''' Shuffle the cards holded by dealer(remained_cards)
53	'''
54	raise NotImplementedError	×
55
56	def deal_cards(self, **kwargs):	1✔
57	''' Deal specific number of cards to a specific player
58
59	Args:
60	player_id: the id of the player to be dealt cards
61	num: number of cards to be dealt
62	'''
63	raise NotImplementedError	×
64
65	class Player(object):	1✔
66	''' Player stores cards in the player's hand, and can determine the actions can be made according to the rules
67	'''
68
69	player_id = None	1✔
70	hand = []	1✔
71
72	def __init__(self, player_id):	1✔
73	''' Every player should have a unique player id
74	'''
75	self.player_id = player_id	1✔
76
77	def available_order(self):	1✔
78	''' Get the actions can be made based on the rules
79
80	Returns:
81	list: a list of available orders
82	'''
83	raise NotImplementedError	×
84
85	def play(self):	1✔
86	''' Player's actual action in the round
87	'''
88	raise NotImplementedError	×
89
90	class Judger(object):	1✔
91	''' Judger decides whether the round/game ends and return the winner of the round/game
92	'''
93
94	def judge_round(self, **kwargs):	1✔
95	''' Decide whether the round ends, and return the winner of the round
96
97	Returns:
98	int: return the player's id who wins the round or -1 meaning the round has not ended
99	'''
100	raise NotImplementedError	×
101
102	def judge_game(self, **kwargs):	1✔
103	''' Decide whether the game ends, and return the winner of the game
104
105	Returns:
106	int: return the player's id who wins the game or -1 meaning the game has not ended
107	'''
108	raise NotImplementedError	×
109
110
111	class Round(object):	1✔
112	''' Round stores the id the ongoing round and can call other Classes' functions to keep the game running
113	'''
114
115	def __init__(self):	1✔
116	''' When the game starts, round id should be 1
117	'''
118
119	raise NotImplementedError	×
120
121	def proceed_round(self, **kwargs):	1✔
122	''' Call other Classes's functions to keep the game running
123	'''
124	raise NotImplementedError	×
125
126
127	class Game(object):	1✔
128	''' Game class. This class will interact with outer environment.
129	'''
130
131	def init_game(self):	1✔
132	''' Initialize all characters in the game and start round 1
133	'''
134	raise NotImplementedError	×
135
136	def step(self, action):	1✔
137	''' Perform one draw of the game and return next player number, and the state for next player
138	'''
139	raise NotImplementedError	×
140
141	def step_back(self):	1✔
142	''' Takes one step backward and restore to the last state
143	'''
144	raise NotImplementedError	×
145
146	def get_player_num(self):	1✔
147	''' Retrun the number of players in the game
148	'''
149	raise NotImplementedError	×
150
151	def get_action_num(self):	1✔
152	''' Return the number of possible actions in the game
153	'''
154	raise NotImplementedError	×
155
156	def get_player_id(self):	1✔
157	''' Return the current player that will take actions soon
158	'''
159	raise NotImplementedError	×
160
161	def is_over(self):	1✔
162	''' Return whether the current game is over
163	'''
164	raise NotImplementedError	×
165

datamllab / rlcard / 260

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous