aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index 2cd505e..37c58ce 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ Welcome to the host repository of the Turing Change Point Dataset, a set of
time series specifically collected for the evaluation of change point
detection algorithms on real-world data. This dataset was introduced in [this
paper](https://arxiv.org/abs/2003.06222). For the repository containing the
-code and annotations, see
+code used for the experiments, see
[TCPDBench](https://github.com/alan-turing-institute/TCPDBench).
**Useful links:**
@@ -46,6 +46,14 @@ paper](https://arxiv.org/abs/2003.06222):
}
```
+The annotations are stored in the [annotations.json](annotations.json) file,
+which is the same as that used in the experiments (see
+[here](https://github.com/alan-turing-institute/TCPDBench/blob/master/analysis/annotations/annotations.json)).
+Annotations are organised in a JSON object by dataset name and annotator id,
+and use 0-based indexing. See the
+[TCPDBench](https://github.com/alan-turing-institute/TCPDBench) repository for
+more information on extending the benchmark with your own methods or datasets.
+
## Getting Started
Many of the time series in the dataset are included in this repository.