From c4fb23f56d9fede968966592c5197e4fe3a1ffc0 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Sat, 6 Mar 2021 21:43:47 +0000 Subject: Update readme with info on annotations format --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) 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: + +``` +{ + "": { + "annotator_id": [ + + + ... + ], + ... + }, + ... +} +``` + +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 -- cgit v1.2.3