diff --git a/CHANGELOG.md b/CHANGELOG.md index 575611dc..d66257b5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] -## [2.0.0] - 2023-07-31 +## [2.0.0] - 2023-07-26 ### Added - Command Line Interface (CLI) for easy access and streamlined usage of PrimAITE. diff --git a/benchmark/results/v2.0.0rc2/v2.0.0rc2_benchmark_metadata.json b/benchmark/results/v2.0.0rc2/v2.0.0rc2_benchmark_metadata.json index fe8f5eac..47940f95 100644 --- a/benchmark/results/v2.0.0rc2/v2.0.0rc2_benchmark_metadata.json +++ b/benchmark/results/v2.0.0rc2/v2.0.0rc2_benchmark_metadata.json @@ -1,7 +1,7 @@ { "start_timestamp": "2023-07-24T19:39:43.122256", "end_datetime": "2023-07-24T22:33:06.357431", - "primaite_version": "2.0.0rc2", + "primaite_version": "2.0.0", "system_info": { "System": { "OS": "Windows", diff --git a/docs/source/custom_agent.rst b/docs/source/custom_agent.rst index 0f4f30ad..8a95d3ae 100644 --- a/docs/source/custom_agent.rst +++ b/docs/source/custom_agent.rst @@ -130,7 +130,7 @@ Finally, specify your agent in your training config. .. code-block:: yaml - # ~/primaite/2.0.0rc2/config/path/to/your/config_main.yaml + # ~/primaite/2.0.0/config/path/to/your/config_main.yaml # Training Config File diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 0ac2fdd4..f07f1d27 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -41,12 +41,12 @@ Install PrimAITE .. code-tab:: bash :caption: Unix - mkdir ~/primaite/2.0.0rc2 + mkdir ~/primaite/2.0.0 .. code-tab:: powershell :caption: Windows (Powershell) - mkdir ~\primaite\2.0.0rc2 + mkdir ~\primaite\2.0.0 2. Navigate to the primaite directory and create a new python virtual environment (venv) @@ -55,13 +55,13 @@ Install PrimAITE .. code-tab:: bash :caption: Unix - cd ~/primaite/2.0.0rc2 + cd ~/primaite/2.0.0 python3 -m venv .venv .. code-tab:: powershell :caption: Windows (Powershell) - cd ~\primaite\2.0.0rc2 + cd ~\primaite\2.0.0 python3 -m venv .venv attrib +h .venv /s /d # Hides the .venv directory diff --git a/docs/source/migration_1.2_-_2.0.rst b/docs/source/migration_1.2_-_2.0.rst index e1e24790..c38fcbe9 100644 --- a/docs/source/migration_1.2_-_2.0.rst +++ b/docs/source/migration_1.2_-_2.0.rst @@ -31,7 +31,7 @@ v1.2 to v2.0 Migration guide **3. Location of configs** - In version 1.2, training configs and laydown configs were all stored in the project repository under ``src/primaite/config``. Version 2.0.0 introduced user data directories, and now when you install and setup PrimAITE, config files are stored in your user data location. On Linux/OSX, this is stored in ``~/primaite/2.0.0rc2/config``. On Windows, this is stored in ``C:\Users\\primaite\configs``. Upon first setup, the configs folder is populated with some default yaml files. It is recommended that you store all your custom configuration files here. + In version 1.2, training configs and laydown configs were all stored in the project repository under ``src/primaite/config``. Version 2.0.0 introduced user data directories, and now when you install and setup PrimAITE, config files are stored in your user data location. On Linux/OSX, this is stored in ``~/primaite/2.0.0/config``. On Windows, this is stored in ``C:\Users\\primaite\configs``. Upon first setup, the configs folder is populated with some default yaml files. It is recommended that you store all your custom configuration files here. **4. Contents of configs** diff --git a/docs/source/primaite_session.rst b/docs/source/primaite_session.rst index 840e5717..ed023499 100644 --- a/docs/source/primaite_session.rst +++ b/docs/source/primaite_session.rst @@ -20,14 +20,14 @@ Both the ``primaite session`` and :func:`primaite.main.run` take a training conf .. code-tab:: bash :caption: Unix CLI - cd ~/primaite/2.0.0rc2 + cd ~/primaite/2.0.0 source ./.venv/bin/activate primaite session --tc ./config/my_training_config.yaml --ldc ./config/my_lay_down_config.yaml .. code-tab:: powershell :caption: Powershell CLI - cd ~\primaite\2.0.0rc2 + cd ~\primaite\2.0.0 .\.venv\Scripts\activate primaite session --tc .\config\my_training_config.yaml --ldc .\config\my_lay_down_config.yaml @@ -41,11 +41,11 @@ Both the ``primaite session`` and :func:`primaite.main.run` take a training conf lay_down_config = run(training_config, lay_down_config) -When a session is ran, a session output sub-directory is created in the users app sessions directory (``~/primaite/2.0.0rc2/sessions``). -The sub-directory is formatted as such: ``~/primaite/2.0.0rc2/sessions//_/`` +When a session is ran, a session output sub-directory is created in the users app sessions directory (``~/primaite/2.0.0/sessions``). +The sub-directory is formatted as such: ``~/primaite/2.0.0/sessions//_/`` For example, when running a session at 17:30:00 on 31st January 2023, the session will output to: -``~/primaite/2.0.0rc2/sessions/2023-01-31/2023-01-31_17-30-00/``. +``~/primaite/2.0.0/sessions/2023-01-31/2023-01-31_17-30-00/``. ``primaite session`` can be ran in the terminal/command prompt without arguments. It will use the default configs in the directory ``primaite/config/example_config``. @@ -110,7 +110,7 @@ For each training session, assuming the agent being trained implements the *save ~/ └── primaite/ - └── 2.0.0rc2/ + └── 2.0.0/ └── sessions/ └── 2023-07-18/ └── 2023-07-18_11-06-04/ @@ -160,14 +160,14 @@ A previous session can be loaded by providing the **directory** of the previous .. code-tab:: bash :caption: Unix CLI - cd ~/primaite/2.0.0rc2 + cd ~/primaite/2.0.0 source ./.venv/bin/activate primaite session --load "path/to/session" .. code-tab:: bash :caption: Powershell CLI - cd ~\primaite\2.0.0rc2 + cd ~\primaite\2.0.0 .\.venv\Scripts\activate primaite session --load "path\to\session" diff --git a/src/primaite/VERSION b/src/primaite/VERSION index 41ab234f..227cea21 100644 --- a/src/primaite/VERSION +++ b/src/primaite/VERSION @@ -1 +1 @@ -2.0.0rc2 +2.0.0 diff --git a/src/primaite/agents/agent_abc.py b/src/primaite/agents/agent_abc.py index c314fec3..54c38abf 100644 --- a/src/primaite/agents/agent_abc.py +++ b/src/primaite/agents/agent_abc.py @@ -25,7 +25,7 @@ def get_session_path(session_timestamp: datetime) -> Path: Get the directory path the session will output to. This is set in the format of: - ~/primaite/2.0.0rc2/sessions//_. + ~/primaite/2.0.0/sessions//_. :param session_timestamp: This is the datetime that the session started. :return: The session directory path. diff --git a/src/primaite/cli.py b/src/primaite/cli.py index c3e173af..4e37f75c 100644 --- a/src/primaite/cli.py +++ b/src/primaite/cli.py @@ -143,11 +143,11 @@ def session(tc: Optional[str] = None, ldc: Optional[str] = None, load: Optional[ tc: The training config filepath. Optional. If no value is passed then example default training config is used from: - ~/primaite/2.0.0rc2/config/example_config/training/training_config_main.yaml. + ~/primaite/2.0.0/config/example_config/training/training_config_main.yaml. ldc: The lay down config file path. Optional. If no value is passed then example default lay down config is used from: - ~/primaite/2.0.0rc2/config/example_config/lay_down/lay_down_config_3_doc_very_basic.yaml. + ~/primaite/2.0.0/config/example_config/lay_down/lay_down_config_3_doc_very_basic.yaml. load: The directory of a previous session. Optional. If no value is passed, then the session will use the default training config and laydown config. Inversely, if a training config and laydown config