273876873e
- renamed _config_values_main to training_config.py and renamed the ConfigValuesMain class to TrainingConfig. Moved training_config.py to src/primaite/config/training_config.py - Renamed all training config yaml file keys to make creating an instance of TrainingConfig easier. Moved action_type and num_steps over to the training config. - Decoupled the training config and lay down config. - Refactored main.py so that it can be ran from CLI and can take a training config path and a lay down config path. - refactored all outputs so that they save to the session dir. - Added some necessary setup scripts that handle creating app dirs, fronting example config files to the user, fronting demo notebooks to the user, performing clean-up in between installations etc. - Added functions that attempt to retrieve the file path of users example config files that have been fronted by the primaite setup. - Added logging config and a getLogger function in the top-level init. - Refactored all logs entries logged to use a logger using the primaite logging config. - Added basic typer CLI for doing things like setup, viewing logs, viewing primaite version, running a basic session. - Updated test to use new features and config structures. - Began updating docs. More to do here.
33 lines
847 B
Python
33 lines
847 B
Python
# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
|
|
import os
|
|
from pathlib import Path
|
|
|
|
import pkg_resources
|
|
|
|
from primaite import getLogger
|
|
|
|
_LOGGER = getLogger(__name__)
|
|
|
|
|
|
def get_file_path(path: str) -> Path:
|
|
"""
|
|
Get PrimAITE package data.
|
|
|
|
:Example:
|
|
|
|
>>> from primaite.utils.package_data import get_file_path
|
|
>>> main_env_config = get_file_path("config/_package_data/training_config_main.yaml")
|
|
|
|
|
|
:param path: The path from the primaite root.
|
|
:return: The file path of the package data file.
|
|
:raise FileNotFoundError: When the filepath does not exist.
|
|
"""
|
|
fp = pkg_resources.resource_filename("primaite", path)
|
|
if os.path.isfile(fp):
|
|
return Path(fp)
|
|
else:
|
|
msg = f"Cannot PrimAITE package data: {fp}"
|
|
_LOGGER.error(msg)
|
|
raise FileNotFoundError(msg)
|