#2837 - Updates to some more documentation files to cover new features [skip ci]
This commit is contained in:
@@ -5,7 +5,8 @@ All notable changes to this project will be documented in this file.
|
|||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
||||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
## [Unreleased]
|
## [3.3.0] - 2024-08-30
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
- Random Number Generator Seeding by specifying a random number seed in the config file.
|
- Random Number Generator Seeding by specifying a random number seed in the config file.
|
||||||
- Implemented Terminal service class, providing a generic terminal simulation.
|
- Implemented Terminal service class, providing a generic terminal simulation.
|
||||||
|
|||||||
@@ -172,3 +172,8 @@ The amount of timesteps that the frequency can randomly change.
|
|||||||
---------------
|
---------------
|
||||||
|
|
||||||
If ``True``, gymnasium flattening will be performed on the observation space before sending to the agent. Set this to ``True`` if your agent does not support nested observation spaces.
|
If ``True``, gymnasium flattening will be performed on the observation space before sending to the agent. Set this to ``True`` if your agent does not support nested observation spaces.
|
||||||
|
|
||||||
|
``Agent History``
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
Agents will record their action log for each step. This is a summary of what the agent did, along with response information from requests within the simulation.
|
||||||
@@ -28,6 +28,7 @@ This section defines high-level settings that apply across the game, currently i
|
|||||||
high: 10
|
high: 10
|
||||||
medium: 5
|
medium: 5
|
||||||
low: 0
|
low: 0
|
||||||
|
seed: 1
|
||||||
|
|
||||||
``max_episode_length``
|
``max_episode_length``
|
||||||
----------------------
|
----------------------
|
||||||
@@ -54,3 +55,8 @@ See :ref:`List of IPProtocols <List of IPProtocols>` for a list of protocols.
|
|||||||
--------------
|
--------------
|
||||||
|
|
||||||
These are used to determine the thresholds of high, medium and low categories for counted observation occurrences.
|
These are used to determine the thresholds of high, medium and low categories for counted observation occurrences.
|
||||||
|
|
||||||
|
``seed``
|
||||||
|
--------
|
||||||
|
|
||||||
|
Used to configure the random seeds used within PrimAITE, ensuring determinism within episode/session runs. If empty or set to -1, no seed is set.
|
||||||
Reference in New Issue
Block a user