Contents Menu Expand Light mode Dark mode Auto light/dark mode
YAWNING TITAN v2.0.1 docs
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
    • Create a game mode
    • Create a Network
    • Running a session
  • Yawning-Titan API
    • 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
      • yawning_titan.agents.fixed_red
        • yawning_titan.agents.fixed_red.FixedRedAgent
      • yawning_titan.agents.keyboard
        • yawning_titan.agents.keyboard.KeyboardAgent
      • yawning_titan.agents.nsa_red
        • yawning_titan.agents.nsa_red.NSARed
      • yawning_titan.agents.random
        • yawning_titan.agents.random.RandomAgent
      • yawning_titan.agents.simple_blue
        • yawning_titan.agents.simple_blue.SimpleBlue
      • yawning_titan.agents.sinewave_red
        • yawning_titan.agents.sinewave_red.calculate_number_moves
        • yawning_titan.agents.sinewave_red.SineWaveRedAgent
    • yawning_titan.config
      • yawning_titan.config.core
        • yawning_titan.config.core.ConfigBase
        • yawning_titan.config.core.ConfigGroup
        • yawning_titan.config.core.ConfigGroupValidation
        • yawning_titan.config.core.ConfigItem
        • yawning_titan.config.core.ConfigItemValidation
        • yawning_titan.config.core.ConfigValidationBase
        • yawning_titan.config.core.ItemTypeProperties
      • yawning_titan.config.groups
        • yawning_titan.config.groups.core
          • yawning_titan.config.groups.core.ActionLikelihoodChanceGroup
          • yawning_titan.config.groups.core.ActionLikelihoodGroup
          • yawning_titan.config.groups.core.NodeChanceGroup
          • yawning_titan.config.groups.core.RestrictRangeGroup
          • yawning_titan.config.groups.core.UseChancesGroup
          • yawning_titan.config.groups.core.UseValueGroup
        • yawning_titan.config.groups.validation
          • yawning_titan.config.groups.validation.AnyNonZeroGroup
          • yawning_titan.config.groups.validation.AnyTrueGroup
          • yawning_titan.config.groups.validation.AnyUsedGroup
      • yawning_titan.config.item_types
        • yawning_titan.config.item_types.bool_item
          • yawning_titan.config.item_types.bool_item.BoolItem
          • yawning_titan.config.item_types.bool_item.BoolProperties
        • yawning_titan.config.item_types.float_item
          • yawning_titan.config.item_types.float_item.FloatItem
          • yawning_titan.config.item_types.float_item.FloatProperties
        • yawning_titan.config.item_types.int_item
          • yawning_titan.config.item_types.int_item.IntItem
          • yawning_titan.config.item_types.int_item.IntProperties
          • yawning_titan.config.item_types.int_item.Parity
        • yawning_titan.config.item_types.str_item
          • yawning_titan.config.item_types.str_item.StrItem
          • yawning_titan.config.item_types.str_item.StrProperties
    • yawning_titan.db
      • yawning_titan.db.compatibility_query
        • yawning_titan.db.compatibility_query.check_element
        • yawning_titan.db.compatibility_query.EntryNodeCompatibilityQuery
        • yawning_titan.db.compatibility_query.HighValueNodeCompatibilityQuery
        • yawning_titan.db.compatibility_query.NetworkCompatibilityQuery
        • yawning_titan.db.compatibility_query.NetworkNodeCompatibilityQuery
      • yawning_titan.db.doc_metadata
        • yawning_titan.db.doc_metadata.DocMetaDataObject
        • yawning_titan.db.doc_metadata.DocMetadata
        • yawning_titan.db.doc_metadata.DocMetadataSchema
      • yawning_titan.db.query
        • yawning_titan.db.query.YawningTitanQuery
      • yawning_titan.db.schemas
        • yawning_titan.db.schemas.AttackSourceSchema
        • yawning_titan.db.schemas.BasicAttackSchema
        • yawning_titan.db.schemas.BlueActionSetSchema
        • yawning_titan.db.schemas.BlueAttackDiscoverySchema
        • yawning_titan.db.schemas.BlueIntrusionDiscoverySchema
        • yawning_titan.db.schemas.BlueLossConditionSchema
        • yawning_titan.db.schemas.BlueSchema
        • yawning_titan.db.schemas.DeceptiveNodeSchema
        • yawning_titan.db.schemas.DoNothingSchema
        • yawning_titan.db.schemas.EntryNodeCountSchema
        • yawning_titan.db.schemas.FailedAttackChanceSchema
        • yawning_titan.db.schemas.FailedAttackSchema
        • yawning_titan.db.schemas.GameModeConfigurationSchema
        • yawning_titan.db.schemas.GameRulesSchema
        • yawning_titan.db.schemas.HighValueNodeCountSchema
        • yawning_titan.db.schemas.ImmediateSchema
        • yawning_titan.db.schemas.MakeNodeSafeSchema
        • yawning_titan.db.schemas.MiscellaneousSchema
        • yawning_titan.db.schemas.MoveSchema
        • yawning_titan.db.schemas.NPercentNodesLostSchema
        • yawning_titan.db.schemas.NaturalSpreadChanceSchema
        • yawning_titan.db.schemas.NetworkCompatibilitySchema
        • yawning_titan.db.schemas.NodeCountSchema
        • yawning_titan.db.schemas.ObservationSpaceSchema
        • yawning_titan.db.schemas.OnScanSchema
        • yawning_titan.db.schemas.RandomInfectSchema
        • yawning_titan.db.schemas.RedActionSetSchema
        • yawning_titan.db.schemas.RedAgentAttackSchema
        • yawning_titan.db.schemas.RedNaturalSpreadingSchema
        • yawning_titan.db.schemas.RedSchema
        • yawning_titan.db.schemas.RedTargetMechanismSchema
        • yawning_titan.db.schemas.ResetSchema
        • yawning_titan.db.schemas.RewardsSchema
        • yawning_titan.db.schemas.SkillSchema
        • yawning_titan.db.schemas.SpreadSchema
        • yawning_titan.db.schemas.SucceededAttackKnownCompromiseChanceSchema
        • yawning_titan.db.schemas.SucceededAttackKnownCompromiseSchema
        • yawning_titan.db.schemas.SucceededAttackUnknownCompromiseChanceSchema
        • yawning_titan.db.schemas.SucceededAttackUnknownCompromiseSchema
        • yawning_titan.db.schemas.TargetNodeSchema
        • yawning_titan.db.schemas.ZeroDaySchema
      • yawning_titan.db.yawning_titan_db
        • yawning_titan.db.yawning_titan_db.YawningTitanDB
        • yawning_titan.db.yawning_titan_db.YawningTitanDBSchema
    • yawning_titan.envs
      • yawning_titan.envs.generic
        • yawning_titan.envs.generic.core
          • yawning_titan.envs.generic.core.action_loops
            • yawning_titan.envs.generic.core.action_loops.ActionLoop
          • yawning_titan.envs.generic.core.blue_action_set
            • yawning_titan.envs.generic.core.blue_action_set.BlueActionSet
          • yawning_titan.envs.generic.core.blue_interface
            • yawning_titan.envs.generic.core.blue_interface.BlueInterface
          • yawning_titan.envs.generic.core.network_interface
            • yawning_titan.envs.generic.core.network_interface.NetworkInterface
          • yawning_titan.envs.generic.core.red_action_set
            • yawning_titan.envs.generic.core.red_action_set.RedActionSet
          • yawning_titan.envs.generic.core.red_interface
            • yawning_titan.envs.generic.core.red_interface.RedInterface
          • yawning_titan.envs.generic.core.reward_functions
            • 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
          • yawning_titan.envs.generic.generic_env.GenericNetworkEnv
        • yawning_titan.envs.generic.helpers
          • yawning_titan.envs.generic.helpers.environment_input_validation
            • 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
            • yawning_titan.envs.generic.helpers.eval_printout.EvalPrintout
          • yawning_titan.envs.generic.helpers.graph2plot
            • yawning_titan.envs.generic.helpers.graph2plot.repeat_check
            • yawning_titan.envs.generic.helpers.graph2plot.CustomEnvGraph
        • yawning_titan.envs.generic.wrappers
          • yawning_titan.envs.generic.wrappers.graph_embedding_observations
            • yawning_titan.envs.generic.wrappers.graph_embedding_observations.FeatherGraphEmbedObservation
      • yawning_titan.envs.specific
        • yawning_titan.envs.specific.core
          • yawning_titan.envs.specific.core.machines
            • yawning_titan.envs.specific.core.machines.Machines
          • yawning_titan.envs.specific.core.node_states
            • 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
            • yawning_titan.envs.specific.core.nsa_node.Node
          • yawning_titan.envs.specific.core.nsa_node_collection
            • yawning_titan.envs.specific.core.nsa_node_collection.NodeCollection
        • yawning_titan.envs.specific.five_node_def
          • yawning_titan.envs.specific.five_node_def.FiveNodeDef
        • yawning_titan.envs.specific.four_node_def
          • yawning_titan.envs.specific.four_node_def.FourNodeDef
        • yawning_titan.envs.specific.graph_explore
          • yawning_titan.envs.specific.graph_explore.GraphExplore
        • yawning_titan.envs.specific.nsa_node_def
          • yawning_titan.envs.specific.nsa_node_def.NodeEnv
    • yawning_titan.exceptions
      • yawning_titan.exceptions.ConfigGroupValidationError
      • yawning_titan.exceptions.ConfigItemValidationError
      • yawning_titan.exceptions.NetworkError
      • yawning_titan.exceptions.YawningTitanDBCriticalError
      • yawning_titan.exceptions.YawningTitanDBError
      • yawning_titan.exceptions.YawningTitanRunError
    • yawning_titan.experiment_helpers
      • yawning_titan.experiment_helpers.constants
      • yawning_titan.experiment_helpers.graph_metrics
        • yawning_titan.experiment_helpers.graph_metrics.flatten_list
        • yawning_titan.experiment_helpers.graph_metrics.geometric_mean_overflow
        • yawning_titan.experiment_helpers.graph_metrics.get_assortativity_metrics
        • yawning_titan.experiment_helpers.graph_metrics.get_func_summary_statistics
        • yawning_titan.experiment_helpers.graph_metrics.get_graph_metric_bundle
        • yawning_titan.experiment_helpers.graph_metrics.pprint_metric_table
      • yawning_titan.experiment_helpers.sb3
        • yawning_titan.experiment_helpers.sb3.init_env
        • yawning_titan.experiment_helpers.sb3.print_metric_stats
        • yawning_titan.experiment_helpers.sb3.print_policy_eval_metrics
        • yawning_titan.experiment_helpers.sb3.train_and_eval
    • yawning_titan.game_modes
      • yawning_titan.game_modes.components
        • yawning_titan.game_modes.components.blue_agent
          • yawning_titan.game_modes.components.blue_agent.Blue
          • yawning_titan.game_modes.components.blue_agent.BlueActionSetGroup
          • yawning_titan.game_modes.components.blue_agent.BlueAttackDiscoveryGroup
          • yawning_titan.game_modes.components.blue_agent.BlueIntrusionDiscoveryGroup
          • yawning_titan.game_modes.components.blue_agent.DeceptiveNodeGroup
          • yawning_titan.game_modes.components.blue_agent.MakeNodeSafeGroup
        • yawning_titan.game_modes.components.game_rules
          • yawning_titan.game_modes.components.game_rules.BlueLossConditionGroup
          • yawning_titan.game_modes.components.game_rules.GameRules
          • yawning_titan.game_modes.components.game_rules.NetworkCompatibilityGroup
        • yawning_titan.game_modes.components.miscellaneous
          • yawning_titan.game_modes.components.miscellaneous.Miscellaneous
        • yawning_titan.game_modes.components.observation_space
          • yawning_titan.game_modes.components.observation_space.ObservationSpace
        • yawning_titan.game_modes.components.red_agent
          • yawning_titan.game_modes.components.red_agent.AttackSourceGroup
          • yawning_titan.game_modes.components.red_agent.NaturalSpreadChanceGroup
          • yawning_titan.game_modes.components.red_agent.Red
          • yawning_titan.game_modes.components.red_agent.RedActionSetGroup
          • yawning_titan.game_modes.components.red_agent.RedAgentAttackGroup
          • yawning_titan.game_modes.components.red_agent.RedNaturalSpreadingGroup
          • yawning_titan.game_modes.components.red_agent.RedTargetMechanismGroup
          • yawning_titan.game_modes.components.red_agent.TargetNodeGroup
          • yawning_titan.game_modes.components.red_agent.ZeroDayGroup
        • yawning_titan.game_modes.components.reset
          • yawning_titan.game_modes.components.reset.Reset
        • yawning_titan.game_modes.components.rewards
          • yawning_titan.game_modes.components.rewards.Rewards
      • yawning_titan.game_modes.game_mode
        • yawning_titan.game_modes.game_mode.GameMode
      • yawning_titan.game_modes.game_mode_db
        • yawning_titan.game_modes.game_mode_db.dcbo_game_mode
        • yawning_titan.game_modes.game_mode_db.default_game_mode
        • yawning_titan.game_modes.game_mode_db.GameModeDB
        • yawning_titan.game_modes.game_mode_db.GameModeSchema
    • yawning_titan.integrations
      • yawning_titan.integrations.dcbo
        • yawning_titan.integrations.dcbo.dcbo_agent
          • yawning_titan.integrations.dcbo.dcbo_agent.DCBOAgent
        • yawning_titan.integrations.dcbo.utils
          • yawning_titan.integrations.dcbo.utils.create_env
          • yawning_titan.integrations.dcbo.utils.init_dcbo_agent
    • yawning_titan.main
      • yawning_titan.main.build_dirs
      • yawning_titan.main.clean_up
      • yawning_titan.main.docs
      • yawning_titan.main.gui
      • yawning_titan.main.keyboard_agent
      • yawning_titan.main.logs
      • yawning_titan.main.notebooks
      • yawning_titan.main.release_notes
      • yawning_titan.main.reset_db
      • yawning_titan.main.reset_notebooks
      • yawning_titan.main.setup
      • yawning_titan.main.version
    • yawning_titan.networks
      • yawning_titan.networks.network
        • yawning_titan.networks.network.Network
        • yawning_titan.networks.network.NetworkLayout
        • yawning_titan.networks.network.RandomEntryNodePreference
        • yawning_titan.networks.network.RandomHighValueNodePreference
      • yawning_titan.networks.network_creator
        • yawning_titan.networks.network_creator.check_if_nearby
        • yawning_titan.networks.network_creator.create_mesh
        • yawning_titan.networks.network_creator.create_p2p
        • yawning_titan.networks.network_creator.create_ring
        • yawning_titan.networks.network_creator.create_star
        • yawning_titan.networks.network_creator.custom_network
        • yawning_titan.networks.network_creator.dcbo_base_network
        • yawning_titan.networks.network_creator.generate_node_positions
        • yawning_titan.networks.network_creator.get_18_node_network_mesh
        • yawning_titan.networks.network_creator.get_network_from_matrix_and_positions
        • yawning_titan.networks.network_creator.gnp_random_connected_graph
      • yawning_titan.networks.network_db
        • yawning_titan.networks.network_db.dcbo_base_network
        • yawning_titan.networks.network_db.default_18_node_network
        • yawning_titan.networks.network_db.NetworkDB
        • yawning_titan.networks.network_db.NetworkQuery
        • yawning_titan.networks.network_db.NetworkSchema
      • yawning_titan.networks.node
        • yawning_titan.networks.node.Node
    • yawning_titan.notebooks
    • yawning_titan.utils
      • yawning_titan.utils.old_installation_clean_up
        • yawning_titan.utils.old_installation_clean_up.run
      • yawning_titan.utils.reset_default_notebooks
        • yawning_titan.utils.reset_default_notebooks.run
      • yawning_titan.utils.reset_network_and_game_mode_db_defaults
        • yawning_titan.utils.reset_network_and_game_mode_db_defaults.run
      • yawning_titan.utils.setup_app_dirs
        • yawning_titan.utils.setup_app_dirs.run
    • yawning_titan.yawning_titan_run
      • yawning_titan.yawning_titan_run.YawningTitanRun
  • Yawning-Titan Tests
    • tests.e2e_integration_tests
    • tests.game_mode_db_patch
      • tests.game_mode_db_patch.game_mode_db_init_patch
    • tests.integration_tests
      • tests.integration_tests.db
        • tests.integration_tests.db.test_yawning_titan_db_yawning_titan_query
          • tests.integration_tests.db.test_yawning_titan_db_yawning_titan_query.test_count_with_condition
          • tests.integration_tests.db.test_yawning_titan_db_yawning_titan_query.test_yt_query_len_eq
          • tests.integration_tests.db.test_yawning_titan_db_yawning_titan_query.test_yt_query_len_ge
          • tests.integration_tests.db.test_yawning_titan_db_yawning_titan_query.test_yt_query_len_gt
          • tests.integration_tests.db.test_yawning_titan_db_yawning_titan_query.test_yt_query_len_le
          • tests.integration_tests.db.test_yawning_titan_db_yawning_titan_query.test_yt_query_len_lt
      • tests.integration_tests.env
        • tests.integration_tests.env.test_five_node_def
          • tests.integration_tests.env.test_five_node_def.test_environment_init
          • tests.integration_tests.env.test_five_node_def.test_environment_reset
          • tests.integration_tests.env.test_five_node_def.test_n_machines
        • tests.integration_tests.env.test_repeatable_episodic_output
          • tests.integration_tests.env.test_repeatable_episodic_output.test_repeatable_episodic_output_set_random_seed
          • tests.integration_tests.env.test_repeatable_episodic_output.test_setting_high_value_node_with_random_seeded_randomisation
        • tests.integration_tests.env.test_stable_baselines_compliance
          • tests.integration_tests.env.test_stable_baselines_compliance.test_environment_sb3_compliance
      • tests.integration_tests.generic_env
        • tests.integration_tests.generic_env.test_graph_embedding_observations
          • tests.integration_tests.generic_env.test_graph_embedding_observations.test_env_check
          • tests.integration_tests.generic_env.test_graph_embedding_observations.test_obs_range
          • tests.integration_tests.generic_env.test_graph_embedding_observations.test_obs_size
          • tests.integration_tests.generic_env.test_graph_embedding_observations.test_wrapped_env
        • tests.integration_tests.generic_env.test_new_entry_nodes
          • tests.integration_tests.generic_env.test_new_entry_nodes.test_new_entry_nodes
        • tests.integration_tests.generic_env.test_reward_functions
          • tests.integration_tests.generic_env.test_reward_functions.test_punish_bad_actions
          • tests.integration_tests.generic_env.test_reward_functions.test_safe_gives_rewards
          • tests.integration_tests.generic_env.test_reward_functions.test_standard_rewards
      • tests.integration_tests.network
        • tests.integration_tests.network.test_graph_metrics
          • tests.integration_tests.network.test_graph_metrics.test_flatten_list
          • tests.integration_tests.network.test_graph_metrics.test_geometric_mean_overflow
          • tests.integration_tests.network.test_graph_metrics.test_get_func_summary_statistics
          • tests.integration_tests.network.test_graph_metrics.test_get_graph_metric_bundle
        • tests.integration_tests.network.test_network_db
          • tests.integration_tests.network.test_network_db.test_db_file_exists
          • tests.integration_tests.network.test_network_db.test_delete_default_network_delete_fails
          • tests.integration_tests.network.test_network_db.test_network_schema
          • tests.integration_tests.network.test_network_db.test_reset_default_networks
      • tests.integration_tests.test_network_interface
        • tests.integration_tests.test_network_interface.test_network_interface
    • tests.network_db_patch
      • tests.network_db_patch.network_db_init_patch
    • tests.test_pipeline_markers
      • tests.test_pipeline_markers.test_e2e_integration_test
      • tests.test_pipeline_markers.test_integration_test
      • tests.test_pipeline_markers.test_no_mark
      • tests.test_pipeline_markers.test_unit_test
    • tests.unit_tests
      • tests.unit_tests.config
        • tests.unit_tests.config.core
          • tests.unit_tests.config.core.test_config_group
            • tests.unit_tests.config.core.test_config_group.multi_tier_test_group
            • tests.unit_tests.config.core.test_config_group.test_create_from_legacy
            • tests.unit_tests.config.core.test_config_group.test_group
            • tests.unit_tests.config.core.test_config_group.test_multi_tier_group_tier_1_item_failed
            • tests.unit_tests.config.core.test_config_group.test_multi_tier_group_tier_1_validation_group_failed
            • tests.unit_tests.config.core.test_config_group.test_multi_tier_group_tier_2_item_failed
            • tests.unit_tests.config.core.test_config_group.test_multi_tier_group_tier_2_validation_group_failed
            • tests.unit_tests.config.core.test_config_group.test_multi_tier_group_validation_passed
            • tests.unit_tests.config.core.test_config_group.test_repeat_group_validation
            • tests.unit_tests.config.core.test_config_group.test_repeat_item_validation
            • tests.unit_tests.config.core.test_config_group.test_set_config_item_to_value
            • tests.unit_tests.config.core.test_config_group.test_stringify
            • tests.unit_tests.config.core.test_config_group.test_to_dict
            • tests.unit_tests.config.core.test_config_group.test_yaml_round_trip
            • tests.unit_tests.config.core.test_config_group.Group
            • tests.unit_tests.config.core.test_config_group.GroupTier1
            • tests.unit_tests.config.core.test_config_group.GroupTier2
          • tests.unit_tests.config.core.test_config_item
            • tests.unit_tests.config.core.test_config_item.test_assign_incorrect_properties
            • tests.unit_tests.config.core.test_config_item.test_assignment
            • tests.unit_tests.config.core.test_config_item.test_set_value
            • tests.unit_tests.config.core.test_config_item.test_to_dict
        • tests.unit_tests.config.groups
          • tests.unit_tests.config.groups.test_action_likelihood_chance_group
            • tests.unit_tests.config.groups.test_action_likelihood_chance_group.test_action_likelihood_chance_group_fail_used
            • tests.unit_tests.config.groups.test_action_likelihood_chance_group.test_action_likelihood_chance_not_used
            • tests.unit_tests.config.groups.test_action_likelihood_chance_group.test_action_likelihood_chance_used_chance_and_likelihood_not_set
            • tests.unit_tests.config.groups.test_action_likelihood_chance_group.test_action_likelihood_chance_used_chance_not_set
            • tests.unit_tests.config.groups.test_action_likelihood_chance_group.test_action_likelihood_chance_used_likelihood_not_set
            • tests.unit_tests.config.groups.test_action_likelihood_chance_group.test_action_likelihood_chance_valid_used
          • tests.unit_tests.config.groups.test_restrict_range_group
            • tests.unit_tests.config.groups.test_restrict_range_group.test_restrict_range_min_greater_than_max
            • tests.unit_tests.config.groups.test_restrict_range_group.test_restrict_range_no_range
            • tests.unit_tests.config.groups.test_restrict_range_group.test_restrict_range_not_used
            • tests.unit_tests.config.groups.test_restrict_range_group.test_restrict_range_valid_input
          • tests.unit_tests.config.groups.test_use_chances_group
            • tests.unit_tests.config.groups.test_use_chances_group.test_chance_group_fail_used_group_fail
            • tests.unit_tests.config.groups.test_use_chances_group.test_chance_group_fail_used_item_fail
            • tests.unit_tests.config.groups.test_use_chances_group.test_chance_group_not_used
            • tests.unit_tests.config.groups.test_use_chances_group.test_chance_group_valid_used
        • tests.unit_tests.config.item_types
          • tests.unit_tests.config.item_types.test_bool_item
            • tests.unit_tests.config.item_types.test_bool_item.test_bool_item_incorrect_properties_type
            • tests.unit_tests.config.item_types.test_bool_item.test_bool_properties_validation
          • tests.unit_tests.config.item_types.test_float_item
            • tests.unit_tests.config.item_types.test_float_item.test_float_item_incorrect_properties_type
            • tests.unit_tests.config.item_types.test_float_item.test_float_properties_validation
          • tests.unit_tests.config.item_types.test_int_item
            • tests.unit_tests.config.item_types.test_int_item.test_int_item_incorrect_properties_type
            • tests.unit_tests.config.item_types.test_int_item.test_int_properties_validation
          • tests.unit_tests.config.item_types.test_str_item
            • tests.unit_tests.config.item_types.test_str_item.test_bool_properties_validation
            • tests.unit_tests.config.item_types.test_str_item.test_str_item_incorrect_properties_type
        • tests.unit_tests.config.validation
          • tests.unit_tests.config.validation.test_any_non_zero
            • tests.unit_tests.config.validation.test_any_non_zero.nested_group
            • tests.unit_tests.config.validation.test_any_non_zero.test_all_zero
            • tests.unit_tests.config.validation.test_any_non_zero.test_all_zero_or_none
            • tests.unit_tests.config.validation.test_any_non_zero.test_group
            • tests.unit_tests.config.validation.test_any_non_zero.test_multiple_items_above_zero
            • tests.unit_tests.config.validation.test_any_non_zero.test_non_numeric_type
            • tests.unit_tests.config.validation.test_any_non_zero.test_single_item_above_zero
            • tests.unit_tests.config.validation.test_any_non_zero.Group
          • tests.unit_tests.config.validation.test_any_true
            • tests.unit_tests.config.validation.test_any_true.test_bool_item_multiple_true
            • tests.unit_tests.config.validation.test_any_true.test_bool_item_true
            • tests.unit_tests.config.validation.test_any_true.test_group
            • tests.unit_tests.config.validation.test_any_true.test_non_numeric_type
            • tests.unit_tests.config.validation.test_any_true.test_none_used
            • tests.unit_tests.config.validation.test_any_true.Group
          • tests.unit_tests.config.validation.test_any_used
            • tests.unit_tests.config.validation.test_any_used.test_bool_item_true
            • tests.unit_tests.config.validation.test_any_used.test_group
            • tests.unit_tests.config.validation.test_any_used.test_none_used
            • tests.unit_tests.config.validation.test_any_used.test_use_value_used
            • tests.unit_tests.config.validation.test_any_used.test_use_value_used_and_bool_item_true
            • tests.unit_tests.config.validation.test_any_used.Group
      • tests.unit_tests.db
        • tests.unit_tests.db.test_yawning_titan_db
          • tests.unit_tests.db.test_yawning_titan_db.demo_db_docs
          • tests.unit_tests.db.test_yawning_titan_db.test_all
          • tests.unit_tests.db.test_yawning_titan_db.test_count
          • tests.unit_tests.db.test_yawning_titan_db.test_get
          • tests.unit_tests.db.test_yawning_titan_db.test_get_with_uuid_multiple_fails
          • tests.unit_tests.db.test_yawning_titan_db.test_insert_existing_uuid_fails
          • tests.unit_tests.db.test_yawning_titan_db.test_remove
          • tests.unit_tests.db.test_yawning_titan_db.test_remove_locked_fails
          • tests.unit_tests.db.test_yawning_titan_db.test_remove_with_uuid
          • tests.unit_tests.db.test_yawning_titan_db.test_remove_with_uuid_multiple_fails
          • tests.unit_tests.db.test_yawning_titan_db.test_search
          • tests.unit_tests.db.test_yawning_titan_db.test_update
          • tests.unit_tests.db.test_yawning_titan_db.test_update_locked_fails
          • tests.unit_tests.db.test_yawning_titan_db.test_update_metadata
          • tests.unit_tests.db.test_yawning_titan_db.test_upsert_insert
          • tests.unit_tests.db.test_yawning_titan_db.test_upsert_update
          • tests.unit_tests.db.test_yawning_titan_db.DemoDB
          • tests.unit_tests.db.test_yawning_titan_db.DemoSchema
      • tests.unit_tests.game_modes
        • tests.unit_tests.game_modes.agents
        • tests.unit_tests.game_modes.environment
        • tests.unit_tests.game_modes.test_game_mode
      • tests.unit_tests.integrations
        • tests.unit_tests.integrations.dcbo
          • tests.unit_tests.integrations.dcbo.test_dcbo_utils
            • tests.unit_tests.integrations.dcbo.test_dcbo_utils.test_base_dcbo_agent
            • tests.unit_tests.integrations.dcbo.test_dcbo_utils.test_dcbo_agent_with_initial_probabs
            • tests.unit_tests.integrations.dcbo.test_dcbo_utils.test_init_dcbo_agent_assertion_error
      • tests.unit_tests.network
        • tests.unit_tests.network.test_network
          • tests.unit_tests.network.test_network.test_reset_entry_nodes_randomly
          • tests.unit_tests.network.test_network.test_reset_high_value_nodes_randomly
          • tests.unit_tests.network.test_network.test_setting_high_value_nodes_before_entry_nodes
      • tests.unit_tests.test_application_logging
        • tests.unit_tests.test_application_logging.test_log_file_location
    • tests.yawning_titan_db_patch
      • tests.yawning_titan_db_patch.yawning_titan_db_init_patch
      • tests.yawning_titan_db_patch.yawning_titan_db_test_defaults_patch
  • Contribute to Yawning-Titan
  • Glossary
  • MIT License
  • Dependencies

Project Links:

  • Code
  • Issues
  • Pull Requests
  • Discussions
Back to top

yawning_titan.game_modes#

yawning_titan.game_modes.components

yawning_titan.game_modes.game_mode

yawning_titan.game_modes.game_mode_db

Provides an API for the game_mode.json TinyDB file, and a Schema class that defines the game_mode DB fields.
Next
yawning_titan.game_modes.components
Previous
yawning_titan.experiment_helpers.sb3.train_and_eval
Copyright © Crown Copyright (C) Dstl 2021 - 2023
Made with Sphinx and @pradyunsg's Furo