Fahad Alghanim commited on
Commit
f1db0ca
·
1 Parent(s): 061a7ee

Polish dataset card

Browse files

Improve readability of the dataset README (plain-text coordinates, viewer note, updated benchmark table, and richer YAML metadata).

Files changed (1) hide show
  1. README.md +10 -8
README.md CHANGED
@@ -1,5 +1,7 @@
1
  ---
2
  language: en
 
 
3
  tags:
4
  - climate
5
  - sea-surface-temperature
@@ -9,14 +11,14 @@ task_categories:
9
  - time-series-forecasting
10
  ---
11
 
12
- # MUR SST (Pacific) — ML Benchmark Zarr
13
 
14
- This repo contains a **machine-learning friendly Zarr subset** of the NASA/JPL GHRSST **MUR SST** product, packaged for easy download + ML access.
15
 
16
  - **Upstream source (public, no auth)**: `s3://mur-sst/zarr`
17
  - **Subset**:
18
- - **Region**: Pacific, **20–50°N**, **180–240°E** (longitude stored as **0–360**)
19
- - **Time**: **2018-01-01 → 2019-12-30** (729 daily frames; upstream coverage for this slice ends on 2019-12-30)
20
  - **Variable**: `analysed_sst` only (**float32, °C**)
21
  - **Chunking for ML**: `(time, lat, lon) = (7, 256, 256)` (weekly windows)
22
 
@@ -26,7 +28,7 @@ Why `mur-sst/zarr-v1` during extraction?
26
 
27
  ## Notes (Hub viewer)
28
 
29
- - The **Dataset Viewer is expected to be unavailable** for this repo because it contains a tar archive of a Zarr store (not a `datasets`-native format with named splits).
30
 
31
  ## Files in this dataset repo
32
 
@@ -58,7 +60,7 @@ Time-contiguous splits (no leakage):
58
  - **Val**: 2018-12-31 → 2019-06-30
59
  - **Test**: 2019-07-01 → 2019-12-30
60
 
61
- ## Usage example
62
 
63
  Local:
64
 
@@ -68,7 +70,7 @@ ds = xr.open_zarr("pacific_sst.zarr", consolidated=True)
68
  print(ds)
69
  ```
70
 
71
- From Hugging Face (download + unpack):
72
 
73
  ```python
74
  import xarray as xr
@@ -85,7 +87,7 @@ Run:
85
 
86
  ```bash
87
  tar -xf pacific_sst.zarr.tar
88
- python bench/throughput_benchmark.py --local pacific_sst.zarr
89
  ```
90
 
91
  Measured on this machine (see `bench/throughput_benchmark.py` for details):
 
1
  ---
2
  language: en
3
+ pretty_name: "MUR SST ML Benchmark (Pacific, Zarr)"
4
+ license: "other"
5
  tags:
6
  - climate
7
  - sea-surface-temperature
 
11
  - time-series-forecasting
12
  ---
13
 
14
+ # MUR SST ML Benchmark (Pacific, Zarr)
15
 
16
+ Machine-learning friendly **Zarr subset** of NASA/JPL GHRSST **MUR SST**.
17
 
18
  - **Upstream source (public, no auth)**: `s3://mur-sst/zarr`
19
  - **Subset**:
20
+ - **Region**: Pacific (20–50°N, 180–240°E); longitude is stored as **0–360°E**
21
+ - **Time**: 2018-01-01 → 2019-12-30 (729 daily frames; upstream coverage for this slice ends on 2019-12-30)
22
  - **Variable**: `analysed_sst` only (**float32, °C**)
23
  - **Chunking for ML**: `(time, lat, lon) = (7, 256, 256)` (weekly windows)
24
 
 
28
 
29
  ## Notes (Hub viewer)
30
 
31
+ - The **Dataset Viewer is expected to be unavailable** because this repo contains a tar archive of a Zarr store (not a `datasets`-native format with named splits).
32
 
33
  ## Files in this dataset repo
34
 
 
60
  - **Val**: 2018-12-31 → 2019-06-30
61
  - **Test**: 2019-07-01 → 2019-12-30
62
 
63
+ ## Streaming code example
64
 
65
  Local:
66
 
 
70
  print(ds)
71
  ```
72
 
73
+ Remote (Hugging Face, after download):
74
 
75
  ```python
76
  import xarray as xr
 
87
 
88
  ```bash
89
  tar -xf pacific_sst.zarr.tar
90
+ python bench/throughput_benchmark.py --local pacific_sst.zarr --s3-root mur-sst/zarr-v1
91
  ```
92
 
93
  Measured on this machine (see `bench/throughput_benchmark.py` for details):