diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..2dc41e69 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,26 @@ +# Changelog + +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. + +## Version 0.0.2 + + +#### Added + +* Added new heuristic similarity measure and top-level CLI option (`--similarity-measure`) for selecting which similarity measure to use + +* Added `--session-type` option to TA3 interface script (`baseline_system.py`) + +* Added CPU inference support for llama index algorithm component + +* Added support for probes embedded in scenario files for local file interface script (`baseline_system_local_files.py`) + +#### Changed + +#### Fixed + + +## Version 0.0.1 + +* Initial release for MVP demonstration diff --git a/README.md b/README.md index f7b1cc2a..1729a816 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ below: ``` $ python baseline_system.py -usage: baseline_system.py [-h] [-e API_ENDPOINT] [-u USERNAME] [-m MODEL] [-t] [-a ALGORITHM] [-A ALGORITHM_KWARGS] +usage: baseline_system.py [-h] [-e API_ENDPOINT] [-u USERNAME] [-m MODEL] [-t] [-a ALGORITHM] [-A ALGORITHM_KWARGS] [--similarity-measure SIMILARITY_MEASURE] [-s SESSION_TYPE] Simple LLM baseline system @@ -68,6 +68,10 @@ options: Algorithm to use -A ALGORITHM_KWARGS, --algorithm-kwargs ALGORITHM_KWARGS JSON encoded dictionary of kwargs for algorithm initialization + --similarity-measure SIMILARITY_MEASURE + Similarity measure to use (default: 'bert') + -s SESSION_TYPE, --session-type SESSION_TYPE + TA3 API Session Type (default: "eval") ``` An example invocation of the system: