# Data Sources

This directory contains local copies or processed snapshots of external VM scheduling datasets used by this repository.

## Azure Public Dataset

- Local file: `data/azure/vmtable.csv`
- Source repository: https://github.com/Azure/AzurePublicDataset
- Source document: https://github.com/Azure/AzurePublicDataset/blob/master/AzurePublicDatasetV2.md
- Upstream archive listed by Azure: `trace_data/vmtable/vmtable.csv.gz`
- Local license note: `data/azure/LICENSE`

The Azure file is derived from the Azure Public Dataset VM table trace described in the Azure Public Dataset V2 documentation.

### License and attribution

The Azure Public Dataset repository distributes dataset content under
CC BY 4.0. The full upstream license text is archived in
`data/azure/LICENSE`.

When reusing this dataset:

- attribute the Azure Public Dataset project and link to the upstream repository
- retain the CC BY 4.0 attribution requirements
- cite the upstream dataset or paper according to the Azure repository guidance

### Repository policy for `vmtable.csv` (large file)

`data/azure/vmtable.csv` can be very large (e.g., ~800MB). To keep the repository lightweight and avoid inflating
`.git`, do **not** commit the raw CSV into Git. Instead, download it locally when needed and keep only this pointer
to the upstream source.

Recommended `.gitignore` entries:

```gitignore
# Azure trace (downloaded locally, not committed)
data/azure/vmtable.csv
data/azure/vmtable.csv.gz
```

### How to obtain the file

Follow the upstream Azure Public Dataset V2 documentation to locate the official download for
`trace_data/vmtable/vmtable.csv.gz`, then decompress it into `data/azure/vmtable.csv`.

Example (replace the URL with the official upstream download URL):

```bash
mkdir -p data/azure
curl -L "<UPSTREAM_URL_TO_vmtable.csv.gz>" -o data/azure/vmtable.csv.gz
gzip -d -c data/azure/vmtable.csv.gz > data/azure/vmtable.csv
```

Optional: record/verify the exact snapshot you downloaded:

```bash
sha256sum data/azure/vmtable.csv
```

## Huawei / VMAgent Dataset

- Local file: `data/huawei/dataset_clean.csv`
- Source data directory: https://github.com/mail-ecnu/VMAgent/tree/master/vmagent/data
- Related dataset repository: https://github.com/huaweicloud/VM-placement-dataset
- Local license note: `data/huawei/LICENSE`
- Local citation note: `data/huawei/CITATION.md`

The Huawei/VMAgent data is a VM scheduling dataset used by VMAgent.

### License and attribution

The related Huawei VM placement dataset is described upstream as non-commercial
Creative Commons material. The upstream repository does not expose a separate
standalone `LICENSE` file; this repository archives the full CC BY-NC 4.0 legal
text in `data/huawei/LICENSE` because that is the license explicitly referenced
by the upstream dataset page.

When reusing this dataset:

- follow the upstream non-commercial and attribution requirements
- cite the upstream VMAgent project and the related dataset repository as appropriate
- check `data/huawei/CITATION.md` for the repository-local citation guidance

## Citation

If these datasets are used in experiments or publications, cite the original upstream datasets and papers according to their repository instructions.
