aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGertjan van den Burg <gertjanvandenburg@gmail.com>2021-03-06 21:43:47 +0000
committerGertjan van den Burg <gertjanvandenburg@gmail.com>2021-03-06 21:43:47 +0000
commitc4fb23f56d9fede968966592c5197e4fe3a1ffc0 (patch)
tree0c1074d0207bd27e30c4ab25e4e6d802dda50419
parentAdd plotting script to repo (diff)
downloadTCPD-c4fb23f56d9fede968966592c5197e4fe3a1ffc0.tar.gz
TCPD-c4fb23f56d9fede968966592c5197e4fe3a1ffc0.zip
Update readme with info on annotations formatHEADmaster
-rw-r--r--README.md29
1 files changed, 28 insertions, 1 deletions
diff --git a/README.md b/README.md
index 9eef99c..6f2be33 100644
--- a/README.md
+++ b/README.md
@@ -144,7 +144,34 @@ languages:
Implementations of various change point detection algorithms that use these
datasets are available in
-[TCPDBench](https://github.com/alan-turing-institute/TCPDBench).
+[TCPDBench](https://github.com/alan-turing-institute/TCPDBench). A script to
+plot the datasets and detection results from
+[TCPDBench](https://github.com/alan-turing-institute/TCPDBench) is also
+provided in [utils/plot_dataset.py](tree/master/utils/plot_dataset.py).
+
+The annotations are included in the
+[annotations.json](tree/master/annotations.json) file. They are in the format:
+
+```
+{
+ "<dataset>": {
+ "annotator_id": [
+ <change point index>
+ <change point index>
+ ...
+ ],
+ ...
+ },
+ ...
+}
+```
+
+where the ``annotator_id`` is a unique ID for the annotator and the change
+point indices are
+[0-based](https://en.wikipedia.org/wiki/Zero-based_numbering). Please also see
+the documentation in
+[TCPDBench](https://github.com/alan-turing-institute/TCPDBench) for more
+information about using the dataset and benchmark in your own work.
## License