idegen commited on
Commit
8ec3e6f
·
verified ·
1 Parent(s): 73e8e26

Adding descriptive fields to the dataset card updating text on readme

Browse files

Including highlevel description of correlation structures. Removing some of the "coming soon" make the dataset card better with link to code, description, summary and funding details

Files changed (1) hide show
  1. README.md +19 -15
README.md CHANGED
@@ -1361,17 +1361,17 @@ tags:
1361
  - correlation-structure
1362
  - synthetic
1363
  - benchmark
1364
- pretty_name: 'CSTS: Correlation Structures in Time Series'
 
 
 
 
 
1365
  ---
1366
-
1367
  # CSTS - Correlation Structures in Time Series
 
1368
 
1369
- ## Important Notice
1370
- This dataset is published as a pre-publication release. An accompanying research paper is forthcoming on arXiv.
1371
- **All usage of this dataset must include proper attribution to the original authors as specified below.**
1372
-
1373
- ## TL/DR
1374
- Try our dataset loading examples in Google Colab to get started quickly!
1375
  [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/isabelladegen/corrclust-validation/blob/main/src/utils/hf_tooling/CSTS_HuggingFace_UsageExample.ipynb)
1376
 
1377
  ## Dataset Description
@@ -1388,6 +1388,9 @@ and messy real-world data.
1388
  - Investigating how **data preprocessing** affects correlation structure discovery
1389
  - Establishing **performance thresholds** for high-quality clustering result
1390
 
 
 
 
1391
  ### Dataset Structure
1392
  CSTS provides **two main splits** (exploratory and confirmatory) with **30 subjects** each, enabling proper statistical validation.
1393
  The dataset structure includes:
@@ -1396,7 +1399,7 @@ The dataset structure includes:
1396
  - **Completeness levels**: complete (100% of observations), partial (70% of observations), sparse (10% of observations)
1397
 
1398
  ### Subjects
1399
- Each subject contains 100 segments of varying lengths (900-36000) and each segment encodes one of the 23 specific correlation
1400
  structures. Each subject uses all 23 patterns 4-5 times. For the complete data variants each subject consists of ~1.26 mio
1401
  observations.
1402
 
@@ -1452,10 +1455,6 @@ Additional splits are:
1452
 
1453
  ### Quick Start
1454
 
1455
- Try our dataset loading examples in Google Colab to get started quickly!
1456
- [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/isabelladegen/corrclust-validation/blob/main/src/utils/hf_tooling/CSTS_HuggingFace_UsageExample.ipynb)
1457
-
1458
- #### Example
1459
  Steps to load the data and labels for the complete correlated data variant:
1460
 
1461
  1. Load the data for all 30 exploratory subjects for the complete and correlated data variant into pandas df:
@@ -1475,6 +1474,10 @@ df_correlated_labels = correlated_labels.to_pandas()
1475
  df_correlated_labels.head()
1476
  ```
1477
 
 
 
 
 
1478
  ## Authors
1479
  - Isabella Degen, University of Bristol
1480
  - Zahraa S Abdallah, University of Bristol
@@ -1501,7 +1504,7 @@ Please use the following temporary citation until our paper is published:
1501
  year = {2025},
1502
  publisher = {Hugging Face},
1503
  howpublished = {Pre-publication dataset release},
1504
- url = {https://huggingface.co/datasets/[your-username]/[dataset-name]}
1505
  note = {ArXiv preprint forthcoming} # Uncomment when preprint is available
1506
  }
1507
  ```
@@ -1510,4 +1513,5 @@ Once our paper is published on arXiv, we will update this README with the proper
1510
  **Please check back for updates.**
1511
 
1512
  ## Acknowledgements
1513
- ... coming soon
 
 
1361
  - correlation-structure
1362
  - synthetic
1363
  - benchmark
1364
+ pretty_name: CSTS
1365
+ funded_by: "UK Research and Innovation (UKRI), through the UKRI Doctoral Training in Interactive Artificial Intelligence (AI) under grant EP/S022937/1"
1366
+ repo: https://github.com/isabelladegen/corrclust-validation
1367
+ demo: https://colab.research.google.com/github/isabelladegen/corrclust-validation/blob/main/src/utils/hf_tooling/CSTS_HuggingFace_UsageExample.ipynb
1368
+ dataset_summary: "CSTS (Correlation Structures in Time Series) is a synthetic benchmarking dataset for evaluating correlation structure discovery in time series data, featuring controlled properties with ground truth labels to bridge the gap between theoretical models and real-world data."
1369
+ description: "CSTS (Correlation Structures in Time Series) is a comprehensive synthetic benchmarking dataset for evaluating correlation structure discovery in time series data. The dataset systematically models known correlation structures between three different time series variates and enables examination of how these structures are affected by distribution shifting, sparsification, and downsampling."
1370
  ---
 
1371
  # CSTS - Correlation Structures in Time Series
1372
+ GitHub Repository: [CSTS GitHub Repository](https://github.com/isabelladegen/corrclust-validation)
1373
 
1374
+ To get started quickly you can follow our dataset loading demo in Google Colab:
 
 
 
 
 
1375
  [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/isabelladegen/corrclust-validation/blob/main/src/utils/hf_tooling/CSTS_HuggingFace_UsageExample.ipynb)
1376
 
1377
  ## Dataset Description
 
1388
  - Investigating how **data preprocessing** affects correlation structure discovery
1389
  - Establishing **performance thresholds** for high-quality clustering result
1390
 
1391
+ ## Correlation Structures
1392
+ The dataset features 23 distinct correlation structures representing different combinations of strong positive, negligible, and strong negative correlations between three time series variates. These structures are based on meaningful thresholds for strong negative ([-1,-0.7]), negligible ([-0.2,0.2]), and strong positive ([0.7,1]) correlations.
1393
+
1394
  ### Dataset Structure
1395
  CSTS provides **two main splits** (exploratory and confirmatory) with **30 subjects** each, enabling proper statistical validation.
1396
  The dataset structure includes:
 
1399
  - **Completeness levels**: complete (100% of observations), partial (70% of observations), sparse (10% of observations)
1400
 
1401
  ### Subjects
1402
+ There are in total 60 subjects. Each subject contains 100 segments of varying lengths (900-36000) and each segment encodes one of the 23 specific correlation
1403
  structures. Each subject uses all 23 patterns 4-5 times. For the complete data variants each subject consists of ~1.26 mio
1404
  observations.
1405
 
 
1455
 
1456
  ### Quick Start
1457
 
 
 
 
 
1458
  Steps to load the data and labels for the complete correlated data variant:
1459
 
1460
  1. Load the data for all 30 exploratory subjects for the complete and correlated data variant into pandas df:
 
1474
  df_correlated_labels.head()
1475
  ```
1476
 
1477
+ Comprehensive examples can be found here:
1478
+ [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/isabelladegen/corrclust-validation/blob/main/src/utils/hf_tooling/CSTS_HuggingFace_UsageExample.ipynb)
1479
+
1480
+
1481
  ## Authors
1482
  - Isabella Degen, University of Bristol
1483
  - Zahraa S Abdallah, University of Bristol
 
1504
  year = {2025},
1505
  publisher = {Hugging Face},
1506
  howpublished = {Pre-publication dataset release},
1507
+ url = {https://huggingface.co/datasets/idegen/csts}
1508
  note = {ArXiv preprint forthcoming} # Uncomment when preprint is available
1509
  }
1510
  ```
 
1513
  **Please check back for updates.**
1514
 
1515
  ## Acknowledgements
1516
+ We would like to thank UK Research and Innovation (UKRI) for funding author ID's PhD research through the UKRI Doctoral Training in Interactive Artificial Intelligence (AI) under grant EP/S022937/1. The authors extend their gratitude to the faculty, staff and colleagues of the Interactive AI Centre for Doctoral Training at Bristol University for their valuable support and guidance throughout this research.
1517
+ We acknowledge the use of Claude 3.7 Sonnet by Anthropic as a research dialogue tool throughout the development of this work, assisting with dataset documentation, iterative refinement of ideas, and evaluating the clarity of our methods and contributions.