roomai.fivecardstud package

Submodules

roomai.fivecardstud.FiveCardStudAction module

class roomai.fivecardstud.FiveCardStudAction.FiveCardStudAction(key)[source]

Bases: roomai.common.common.AbstractAction

The FiveCardStudAction. The action consists of two parts, namely option and price.

The option is [“Fold”,”Check”,”Call”,”Raise”,”Bet”, “Showhand”], and the price is the chips used by this action.

The FiveCardStudAction has a key “%s_%d”%(option, price) as its identification. Examples of usages:

>> import roomai.fivecardstud

>> a = roomai.fivecardstud.FiveCardStudAction.lookup(“Fold_0”)

>> # We strongly recommend you to get a FiveCardStudAction using the lookup function

>> a.option

Fold

>> a.price

0

Bet = 'Bet'
Call = 'Call'
Check = 'Check'
Fold = 'Fold'
Raise = 'Raise'
Showhand = 'Showhand'
classmethod lookup(key)[source]
option

The option of the action

price

The price of the action (chips used by this action)

roomai.fivecardstud.FiveCardStudEnv module

class roomai.fivecardstud.FiveCardStudEnv.FiveCardStudEnv[source]

Bases: roomai.common.common.AbstractEnv

FiveCardStud game enviroment

action_bet(action)[source]
Args:
action:
action_call(action)[source]
Args:
action:
action_check(action)[source]
Args:
action:
action_fold(action)[source]
Args:
action:
action_raise(action)[source]
Args:
action:
action_showhand(action)[source]
Args:
action:
classmethod available_actions(public_state, person_state)[source]
Args:
public_state: person_state:

Returns:

classmethod cards2pattern(cards)[source]
Args:
cards:

Returns:

classmethod choose_player_at_begining_of_round(public_state)[source]
Args:
public_state:

Returns:

classmethod compare_cards(cards1, cards2)[source]
Args:
cards1: cards2:

Returns:

classmethod compete(env, players)[source]
Args:
env: players:

Returns:

classmethod compute_scores(public_state)[source]
Args:
public_state:

Returns:

forward(action)[source]
Args:
action:
Raises:
None: throw ValueError when the action is invalid at this time
classmethod fourcards2pattern(cards)[source]
Args:
cards:

Returns:

init(params={})[source]

Initialize FiveCardStud game enviroment with the params. The params are as follows: 1) num_players denotes how many players join in this game, default 3 2) chips denotes the initialization chips of players, default [500,500,500] 3) floor_bet denotes the minimal bet, default 10 4) allcards denotes the order of the poker cards appearing, default random 5) record_history denotes whether the environment will stores all history information. If you need call the backward function, please set it to bet True. default False An example of params is {“num_players”:3,”chips”:[500,500,500]}

Parameters:params – initialization param
Returns:infos, public_state, person_states, private_state
classmethod is_action_valid(action, public_state, person_state)[source]
Args:
action: public_state: person_state:

Returns:

classmethod is_compute_scores(public_state)[source]
Args:
public_state:

Returns:

classmethod is_nextround(public_state)[source]
Returns:A boolean variable indicates whether is it time to enter the next stage
classmethod next_player(pu)[source]
Args:
pu:

Returns:

roomai.fivecardstud.FiveCardStudInfo module

class roomai.fivecardstud.FiveCardStudInfo.FiveCardStudPersonState[source]

Bases: roomai.common.common.AbstractPersonState

available_actions = None
fifth_hand_card = None
first_hand_card = None
fourth_hand_card = None
id = None
second_hand_card = None
third_hand_card = None
class roomai.fivecardstud.FiveCardStudInfo.FiveCardStudPrivateState[source]

Bases: roomai.common.common.AbstractPrivateState

all_hand_cards = None
class roomai.fivecardstud.FiveCardStudInfo.FiveCardStudPublicState[source]

Bases: roomai.common.common.AbstractPublicState

bets = None
chips = None
fifth_hand_cards = None
first_hand_cards = None
floor_bet = None
fourth_hand_cards = None
is_needed_to_action = None
is_quit = None
is_raise = None
is_terminal = None
max_bet_sofar = None
num_needed_to_action = None
num_players = None
num_quit = None
num_raise = None
previous_action = None
previous_id = None
previous_round = None
round = None
scores = None
second_hand_cards = None
third_hand_cards = None
turn = None
upper_bet = None

roomai.fivecardstud.FiveCardStudUtils module

class roomai.fivecardstud.FiveCardStudUtils.FiveCardStudPokerCard(point, suit=None)[source]

Bases: roomai.common.common.PokerCard

A poker card used in FiveCardStud game The difference in the common poker card(roomai.common.PokerCard) and the fivecardstud poker card(roomai.fivecardstud.FiveCardStudPokerCard) is: they have different suit rank The common poker card: ‘Spade’: ‘Spade’:0, ‘Heart’:1, ‘Diamond’:2, ‘Club’:3, ‘ForKing’:4 The FiveCardStud poker card:’Spade’: 3, ‘Heart’: 2, ‘Club’: 1, ‘Diamond’:0 Besides, there aren’t r and R in FiveCardStud

classmethod lookup(key)[source]

Module contents