Hide navigation sidebar

Hide table of contents sidebar

Toggle site navigation sidebar

YAWNING TITAN v2.0.1 docs

Toggle table of contents sidebar

YAWNING TITAN v2.0.1 docs

Contents:

Getting Started
Create a Network
Yawning-Titan DB
Tutorials
Agent Training
Monitoring Experiments
GameMode UML
Yawning-Titan CLI
Yawning-Titan GUI
Toggle child pages in navigation
Yawning-Titan API
Toggle child pages in navigation
- yawning_titan.LOG_DIR
- yawning_titan.DB_DIR
- yawning_titan.APP_IMAGES_DIR
- yawning_titan.NOTEBOOKS_DIR
- yawning_titan.GAME_MODES_DIR
- yawning_titan.IMAGES_DIR
- yawning_titan.VIDEOS_DIR
- yawning_titan.AGENTS_DIR
- yawning_titan.AGENTS_LOGS_DIR
- yawning_titan.PPO_TENSORBOARD_LOGS_DIR
- yawning_titan.agents
  Toggle child pages in navigation
  - yawning_titan.agents.fixed_red
    Toggle child pages in navigation
    - yawning_titan.agents.fixed_red.FixedRedAgent
  - yawning_titan.agents.keyboard
    Toggle child pages in navigation
    - yawning_titan.agents.keyboard.KeyboardAgent
  - yawning_titan.agents.nsa_red
    Toggle child pages in navigation
    - yawning_titan.agents.nsa_red.NSARed
  - yawning_titan.agents.random
    Toggle child pages in navigation
    - yawning_titan.agents.random.RandomAgent
  - yawning_titan.agents.simple_blue
    Toggle child pages in navigation
    - yawning_titan.agents.simple_blue.SimpleBlue
  - yawning_titan.agents.sinewave_red
    Toggle child pages in navigation
    - yawning_titan.agents.sinewave_red.calculate_number_moves
    - yawning_titan.agents.sinewave_red.SineWaveRedAgent
- yawning_titan.config
  Toggle child pages in navigation
  - yawning_titan.config.core
    Toggle child pages in navigation
  - yawning_titan.config.groups
    Toggle child pages in navigation
    - yawning_titan.config.groups.core
      Toggle child pages in navigation
    - yawning_titan.config.groups.validation
      Toggle child pages in navigation
  - yawning_titan.config.item_types
    Toggle child pages in navigation
    - yawning_titan.config.item_types.bool_item
      Toggle child pages in navigation
      - yawning_titan.config.item_types.bool_item.BoolItem
      - yawning_titan.config.item_types.bool_item.BoolProperties
    - yawning_titan.config.item_types.float_item
      Toggle child pages in navigation
      - yawning_titan.config.item_types.float_item.FloatItem
      - yawning_titan.config.item_types.float_item.FloatProperties
    - yawning_titan.config.item_types.int_item
      Toggle child pages in navigation
    - yawning_titan.config.item_types.str_item
      Toggle child pages in navigation
      - yawning_titan.config.item_types.str_item.StrItem
      - yawning_titan.config.item_types.str_item.StrProperties
- yawning_titan.db
  Toggle child pages in navigation
- yawning_titan.envs
  Toggle child pages in navigation
  - yawning_titan.envs.generic
    Toggle child pages in navigation
    - yawning_titan.envs.generic.core
      Toggle child pages in navigation
      - yawning_titan.envs.generic.core.action_loops
        Toggle child pages in navigation
        
        yawning_titan.envs.generic.core.action_loops.ActionLoop
      - yawning_titan.envs.generic.core.blue_action_set
        Toggle child pages in navigation
        
        yawning_titan.envs.generic.core.blue_action_set.BlueActionSet
      - yawning_titan.envs.generic.core.blue_interface
        Toggle child pages in navigation
        
        yawning_titan.envs.generic.core.blue_interface.BlueInterface
      - yawning_titan.envs.generic.core.network_interface
        Toggle child pages in navigation
        
        yawning_titan.envs.generic.core.network_interface.NetworkInterface
      - yawning_titan.envs.generic.core.red_action_set
        Toggle child pages in navigation
        
        yawning_titan.envs.generic.core.red_action_set.RedActionSet
      - yawning_titan.envs.generic.core.red_interface
        Toggle child pages in navigation
        
        yawning_titan.envs.generic.core.red_interface.RedInterface
      - yawning_titan.envs.generic.core.reward_functions
        Toggle child pages in navigation
        
        yawning_titan.envs.generic.core.reward_functions.dcbo_cost_func
        
        yawning_titan.envs.generic.core.reward_functions.experimental_rewards
        
        yawning_titan.envs.generic.core.reward_functions.num_nodes_safe
        
        yawning_titan.envs.generic.core.reward_functions.one_per_timestep
        
        yawning_titan.envs.generic.core.reward_functions.punish_bad_actions
        
        yawning_titan.envs.generic.core.reward_functions.safe_nodes_give_rewards
        
        yawning_titan.envs.generic.core.reward_functions.standard_rewards
        
        yawning_titan.envs.generic.core.reward_functions.zero_reward
    - yawning_titan.envs.generic.generic_env
      Toggle child pages in navigation
      - yawning_titan.envs.generic.generic_env.GenericNetworkEnv
    - yawning_titan.envs.generic.helpers
      Toggle child pages in navigation
      - yawning_titan.envs.generic.helpers.environment_input_validation
        Toggle child pages in navigation
        
        yawning_titan.envs.generic.helpers.environment_input_validation.check_type
        
        yawning_titan.envs.generic.helpers.environment_input_validation.check_within_range
      - yawning_titan.envs.generic.helpers.eval_printout
        Toggle child pages in navigation
        
        yawning_titan.envs.generic.helpers.eval_printout.EvalPrintout
      - yawning_titan.envs.generic.helpers.graph2plot
        Toggle child pages in navigation
        
        yawning_titan.envs.generic.helpers.graph2plot.repeat_check
        
        yawning_titan.envs.generic.helpers.graph2plot.CustomEnvGraph
    - yawning_titan.envs.generic.wrappers
      Toggle child pages in navigation
      - yawning_titan.envs.generic.wrappers.graph_embedding_observations
        Toggle child pages in navigation
        
        yawning_titan.envs.generic.wrappers.graph_embedding_observations.FeatherGraphEmbedObservation
  - yawning_titan.envs.specific
    Toggle child pages in navigation
    - yawning_titan.envs.specific.core
      Toggle child pages in navigation
      - yawning_titan.envs.specific.core.machines
        Toggle child pages in navigation
        
        yawning_titan.envs.specific.core.machines.Machines
      - yawning_titan.envs.specific.core.node_states
        Toggle child pages in navigation
        
        yawning_titan.envs.specific.core.node_states.get_compromised_nodes
        
        yawning_titan.envs.specific.core.node_states.get_linked_compromised_nodes
        
        yawning_titan.envs.specific.core.node_states.get_linked_node_state
        
        yawning_titan.envs.specific.core.node_states.get_linked_uncompromised_nodes
        
        yawning_titan.envs.specific.core.node_states.get_uncompromised_nodes
      - yawning_titan.envs.specific.core.nsa_node
        Toggle child pages in navigation
        
        yawning_titan.envs.specific.core.nsa_node.Node
      - yawning_titan.envs.specific.core.nsa_node_collection
        Toggle child pages in navigation
        
        yawning_titan.envs.specific.core.nsa_node_collection.NodeCollection
    - yawning_titan.envs.specific.five_node_def
      Toggle child pages in navigation
      - yawning_titan.envs.specific.five_node_def.FiveNodeDef
    - yawning_titan.envs.specific.four_node_def
      Toggle child pages in navigation
      - yawning_titan.envs.specific.four_node_def.FourNodeDef
    - yawning_titan.envs.specific.graph_explore
      Toggle child pages in navigation
      - yawning_titan.envs.specific.graph_explore.GraphExplore
    - yawning_titan.envs.specific.nsa_node_def
      Toggle child pages in navigation
      - yawning_titan.envs.specific.nsa_node_def.NodeEnv
- yawning_titan.exceptions
  Toggle child pages in navigation
- yawning_titan.experiment_helpers
  Toggle child pages in navigation
- yawning_titan.game_modes
  Toggle child pages in navigation
  - yawning_titan.game_modes.components
    Toggle child pages in navigation
  - yawning_titan.game_modes.game_mode
    Toggle child pages in navigation
    - yawning_titan.game_modes.game_mode.GameMode
  - yawning_titan.game_modes.game_mode_db
    Toggle child pages in navigation
- yawning_titan.integrations
  Toggle child pages in navigation
  - yawning_titan.integrations.dcbo
    Toggle child pages in navigation
    - yawning_titan.integrations.dcbo.dcbo_agent
      Toggle child pages in navigation
      - yawning_titan.integrations.dcbo.dcbo_agent.DCBOAgent
    - yawning_titan.integrations.dcbo.utils
      Toggle child pages in navigation
      - yawning_titan.integrations.dcbo.utils.create_env
      - yawning_titan.integrations.dcbo.utils.init_dcbo_agent
- yawning_titan.main
  Toggle child pages in navigation
- yawning_titan.networks
  Toggle child pages in navigation
- yawning_titan.notebooks
- yawning_titan.utils
  Toggle child pages in navigation
  - yawning_titan.utils.old_installation_clean_up
    Toggle child pages in navigation
    - yawning_titan.utils.old_installation_clean_up.run
  - yawning_titan.utils.reset_default_notebooks
    Toggle child pages in navigation
    - yawning_titan.utils.reset_default_notebooks.run
  - yawning_titan.utils.reset_network_and_game_mode_db_defaults
    Toggle child pages in navigation
    - yawning_titan.utils.reset_network_and_game_mode_db_defaults.run
  - yawning_titan.utils.setup_app_dirs
    Toggle child pages in navigation
    - yawning_titan.utils.setup_app_dirs.run
- yawning_titan.yawning_titan_run
  Toggle child pages in navigation
  - yawning_titan.yawning_titan_run.YawningTitanRun
Yawning-Titan Tests
Toggle child pages in navigation
Contribute to Yawning-Titan
Glossary
MIT License
Dependencies

Project Links:

Code
Issues
Pull Requests
Discussions

Back to top

Toggle table of contents sidebar

The Game Mode Config UML Diagram#

../_images/game_mode_config_class_diagram.svg

Made with Sphinx and @pradyunsg's Furo