yawning_titan.envs.specific.five_node_def.FiveNodeDef#

class yawning_titan.envs.specific.five_node_def.FiveNodeDef(attacker_skill=50, n_machines=5, attack_success_threshold=0.3, no_compromised_machine_loss=4)[source]#

Bases: Env

OpenAI Gym Environment for Cyber Whack-a-Mole.

Methods

`close`	Override close in your subclass to perform any necessary cleanup.
`render`	Renders the environment.
`reset`	Reset the environment to the default state.
`seed`	Sets the seed for this env's random number generator(s).
`step`	Take a time step and execute the actions for both Blue RL agent and hard-hard coded Red agent.

Attributes

`action_space`
`metadata`
`observation_space`
`reward_range`
`spec`
`unwrapped`	Completely unwrap this env.

observation_space = None#

action_space = None#

reward_range = (-inf, inf)#

reset()[source]#

Reset the environment to the default state.

Returns:: A new starting observation (numpy array)

step(action)[source]#

Take a time step and execute the actions for both Blue RL agent and hard-hard coded Red agent.

Parameters:: action – The action value generated from the Blue RL agent (int)
Returns:: The next environment observation (numpy array) reward: The reward value for that timestep (int) done: Whether the epsiode is done (bool)
Return type:: observation

close()#

Override close in your subclass to perform any necessary cleanup.

Environments will automatically close() themselves when garbage collected or when the program exits.

metadata = {'render.modes': []}#

abstract render(mode='human')#

Renders the environment.

The set of supported modes varies per environment. (And some environments do not support rendering at all.) By convention, if mode is:

human: render to the current display or terminal and return nothing. Usually for human consumption.
rgb_array: Return an numpy.ndarray with shape (x, y, 3), representing RGB values for an x-by-y pixel image, suitable for turning into a video.
ansi: Return a string (str) or StringIO.StringIO containing a terminal-style text representation. The text can include newlines and ANSI escape sequences (e.g. for colors).

Note

Make sure that your class’s metadata ‘render.modes’ key includes: the list of supported modes. It’s recommended to call super() in implementations to use the functionality of this method.

Parameters:: mode (str) – the mode to render with

Example:

class MyEnv(Env):

metadata = {‘render.modes’: [‘human’, ‘rgb_array’]}

def render(self, mode=’human’):

if mode == ‘rgb_array’:: return np.array(…) # return RGB frame suitable for video
elif mode == ‘human’:: … # pop up a window and render
else:: super(MyEnv, self).render(mode=mode) # just raise an exception

seed(seed=None)#

Sets the seed for this env’s random number generator(s).

Note

Some environments use multiple pseudorandom number generators. We want to capture all such seeds used in order to ensure that there aren’t accidental correlations between multiple generators.

Returns:

Returns the list of seeds used in this env’s random: number generators. The first value in the list should be the “main” seed, or the value which a reproducer should pass to ‘seed’. Often, the main seed equals the provided ‘seed’, but this won’t be true if seed=None, for example.

Return type:

list<bigint>

spec = None#

property unwrapped#

Completely unwrap this env.

Returns:: The base non-wrapped gym.Env instance
Return type:: gym.Env