From c9c2b2a1250d7f34b9a7c64b197570c9361ce932 Mon Sep 17 00:00:00 2001
From: David Joy <10147749+dmjoy@users.noreply.github.com>
Date: Sun, 17 Mar 2024 20:34:29 -0400
Subject: [PATCH] Updated CHANGELOG, README, and version for 0.3.1 release

---
 CHANGELOG.md   | 20 +++++++++++++++++
 README.md      | 58 ++++++++++++++------------------------------------
 pyproject.toml |  2 +-
 3 files changed, 37 insertions(+), 43 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 528c3069..dae74953 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -3,6 +3,26 @@
 This changelog follows the specifications detailed in: [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html), although we have not yet reached a `1.0.0` release.
 
+## 0.3.1
+
+### Added
+
+* Added new Random ADM (action based; chooses random action and action parameters)
+* Added additional metrics evaluation candidate ADM configs
+* Added logging for final scenario state (alignment scores are provided there in the unstructured field)
+
+### Changed
+
+* Changed the TA3ActionBased interface class to accept a list of scenario IDs to work through (rather than an individual scenario ID)
+* No longer restricting the SITREP action based on unvisited and conscious characters
+
+### Fixed
+
+* Fixed issue where Llama2SingleKDMAADM tagging selection could choose an invalid tag
+* Not allowing actions that require a character ID to be taken when no characters exist
+* Handling rare corner case where generic APPLY_TREATMENT action could be repeated forever
+* Fixed mentions of "continuation of care" in maximization prompts
+
 ## 0.3.0
 
 ### Added
diff --git a/README.md b/README.md
index 591319e3..47d9091a 100644
--- a/README.md
+++ b/README.md
@@ -170,62 +170,36 @@ run_simplified_align_system LocalFiles \
 
 ## Metrics Evaluation ADM Invocations
 
-### Aligned ADM for ADEPT scenarios
+### Baseline ADM
 
 ```
-run_action_based_align_system TA3ActionBased \
-           --adm-config adm_configs/metrics-evaluation/delivered/single_kdma_adm_adept.yml \
-           --username single_kdma_aligned_adm_adept \
-           --align-to-target \
-           --session-type adept
-```
-
-### Aligned Hybrid Kaleido ADM for ADEPT scenarios
-
-```
-run_action_based_align_system TA3ActionBased \
-           --adm-config adm_configs/metrics-evaluation/delivered/hybrid_kaleido.yml \
-           --username hybrid_kaleido_aligned_adm_adept \
-           --align-to-target \
-           --session-type adept
-```
-
-### Baseline ADM for ADEPT scenarios
-
-```
-run_action_based_align_system TA3ActionBased \
+run_align_system TA3ActionBased \
            --adm-config adm_configs/metrics-evaluation/delivered/single_kdma_adm_baseline.yml \
-           --username single_kdma_baseline_adm_adept \
-           --session-type adept
+           --username kitware-single-kdma-adm-baseline \
+           --session-type eval \
+           --api_endpoint "http://127.0.0.1:8080" # URL for TA3 Server
 ```
 
-### Aligned ADM for SoarTech scenarios
+### Aligned ADM 1 (Single KDMA ADM No Negatives)
 
 ```
-run_action_based_align_system TA3ActionBased \
-           --adm-config adm_configs/metrics-evaluation/delivered/single_kdma_adm_soartech.yml \
-           --username single_kdma_aligned_adm_soartech \
+run_align_system TA3ActionBased \
+           --adm-config adm_configs/metrics-evaluation/delivered/single_kdma_adm_adept.yml \
+           --username kitware-single-kdma-adm-aligned-no-negatives \
            --align-to-target \
-           --session-type soartech
+           --session-type eval \
+           --api_endpoint "http://127.0.0.1:8080" # URL for TA3 Server
 ```
 
-### Aligned Hybrid Kaleido ADM for SoarTech scenarios
+### Aligned ADM 2 (Hybrid Kaleido ADM)
 
 ```
-run_action_based_align_system TA3ActionBased \
+run_align_system TA3ActionBased \
            --adm-config adm_configs/metrics-evaluation/delivered/hybrid_kaleido.yml \
-           --username hybrid_kaleido_aligned_adm_soartech \
+           --username kitware-hybrid-kaleido-aligned \
            --align-to-target \
-           --session-type soartech
-```
-
-### Baseline ADM for SoarTech scenarios
-
-```
-run_action_based_align_system TA3ActionBased \
-           --adm-config adm_configs/metrics-evaluation/delivered/single_kdma_adm_baseline.yml \
-           --username single_kdma_baseline_adm_soartech \
-           --session-type soartech
+           --session-type eval \
+           --api_endpoint "http://127.0.0.1:8080" # URL for TA3 Server
 ```
 
 
diff --git a/pyproject.toml b/pyproject.toml
index 12fbbd7f..a2f2ee1e 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "align-system"
-version = "0.3.0"
+version = "0.3.1"
 description = ""
 authors = ["David Joy <10147749+dmjoy@users.noreply.github.com>"]
 readme = "README.md"