oxbrbtx/PrimAITE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Standardise docstring summary line placement.

Browse Source
This commit is contained in:
Marek Wolan
2023-07-07 10:28:00 +01:00
parent 653d76ec62
commit 5618283cc5
36 changed files with 350 additions and 175 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/primaite/config/lay_down_config.py
View File

@@ -12,7 +12,8 @@ _EXAMPLE_LAY_DOWN: Final[Path] = USERS_CONFIG_DIR / "example_config" / "lay_down
def convert_legacy_lay_down_config_dict(legacy_config_dict: Dict[str, Any]) -> Dict[str, Any]:
"""Convert a legacy lay down config dict to the new format.
"""
Convert a legacy lay down config dict to the new format.
:param legacy_config_dict: A legacy lay down config dict.
"""
@@ -21,7 +22,8 @@ def convert_legacy_lay_down_config_dict(legacy_config_dict: Dict[str, Any]) -> D
def load(file_path: Union[str, Path], legacy_file: bool = False) -> Dict:
"""Read in a lay down config yaml file.
"""
Read in a lay down config yaml file.
:param file_path: The config file path.
:param legacy_file: True if the config file is legacy format, otherwise False.
@@ -50,7 +52,8 @@ def load(file_path: Union[str, Path], legacy_file: bool = False) -> Dict:
def ddos_basic_one_config_path() -> Path:
"""The path to the example lay_down_config_1_DDOS_basic.yaml file.
"""
The path to the example lay_down_config_1_DDOS_basic.yaml file.
:return: The file path.
"""
@@ -64,7 +67,8 @@ def ddos_basic_one_config_path() -> Path:
def ddos_basic_two_config_path() -> Path:
"""The path to the example lay_down_config_2_DDOS_basic.yaml file.
"""
The path to the example lay_down_config_2_DDOS_basic.yaml file.
:return: The file path.
"""
@@ -78,7 +82,8 @@ def ddos_basic_two_config_path() -> Path:
def dos_very_basic_config_path() -> Path:
"""The path to the example lay_down_config_3_DOS_very_basic.yaml file.
"""
The path to the example lay_down_config_3_DOS_very_basic.yaml file.
:return: The file path.
"""
@@ -92,7 +97,8 @@ def dos_very_basic_config_path() -> Path:
def data_manipulation_config_path() -> Path:
"""The path to the example lay_down_config_5_data_manipulation.yaml file.
"""
The path to the example lay_down_config_5_data_manipulation.yaml file.
:return: The file path.
"""

3
src/primaite/config/training_config.py
View File

@@ -180,7 +180,8 @@ class TrainingConfig:
@classmethod
def from_dict(cls, config_dict: Dict[str, Union[str, int, bool]]) -> TrainingConfig:
"""Create an instance of TrainingConfig from a dict.
"""
Create an instance of TrainingConfig from a dict.
:param config_dict: The training config dict.
:return: The instance of TrainingConfig.