Update README.md

#2
by tvspina - opened
Files changed (1) hide show
  1. README.md +6 -6
README.md CHANGED
@@ -32,7 +32,7 @@ If you use this data, please cite:
32
  title = {Building Power Grid Models from Open Data: A Complete Pipeline from OpenStreetMap to Optimal Power Flow},
33
  author = {Britto, Andrea and Spina, Thiago and Yang, Weiwei and Fowers, Spencer and Zhang, Baosen and White, Chris},
34
  year = {2026},
35
- note = {Microsoft Research Catalyst Lab}
36
  }
37
  ```
38
 
@@ -340,7 +340,7 @@ from huggingface_hub import hf_hub_download
340
  import json
341
 
342
  path = hf_hub_download(
343
- repo_id="microsoft/GridSFM_US_power_grid_2026_05_07",
344
  filename="16h/texas_model.json",
345
  repo_type="dataset",
346
  )
@@ -362,13 +362,13 @@ from gridsfm_pg_loader import GridSFM_PG_Loader
362
  # With export_dir (optional): the entire dataset is automatically downloaded
363
  # to this directory on init. Without it, files are stored in HuggingFace's cache.
364
  loader = GridSFM_PG_Loader(
365
- "microsoft/GridSFM_US_power_grid_2026_05_07",
366
  export_dir="./gridsfm_data", # optional; pre-fetches everything here
367
  )
368
 
369
  # To skip the automatic download, use pre_fetch_all=False (lazy download on access)
370
  # loader = GridSFM_PG_Loader(
371
- # "microsoft/GridSFM_US_power_grid_2026_05_07",
372
  # export_dir="./gridsfm_data",
373
  # pre_fetch_all=False,
374
  # )
@@ -397,13 +397,13 @@ loader.export_all("./gridsfm_data")
397
  **Download the entire dataset (~230 MB):**
398
 
399
  ```bash
400
- huggingface-cli download --repo-type dataset microsoft/GridSFM_US_power_grid_2026_05_07 --local-dir ./gridsfm_data
401
  ```
402
 
403
  **Download a subset (one hour only):**
404
 
405
  ```bash
406
- huggingface-cli download --repo-type dataset microsoft/GridSFM_US_power_grid_2026_05_07 --include "16h/*" --local-dir ./gridsfm_data
407
  ```
408
 
409
  ### Load a model from local files
 
32
  title = {Building Power Grid Models from Open Data: A Complete Pipeline from OpenStreetMap to Optimal Power Flow},
33
  author = {Britto, Andrea and Spina, Thiago and Yang, Weiwei and Fowers, Spencer and Zhang, Baosen and White, Chris},
34
  year = {2026},
35
+ note = {Microsoft Research}
36
  }
37
  ```
38
 
 
340
  import json
341
 
342
  path = hf_hub_download(
343
+ repo_id="microsoft/GridSFM_US_power_grid",
344
  filename="16h/texas_model.json",
345
  repo_type="dataset",
346
  )
 
362
  # With export_dir (optional): the entire dataset is automatically downloaded
363
  # to this directory on init. Without it, files are stored in HuggingFace's cache.
364
  loader = GridSFM_PG_Loader(
365
+ "microsoft/GridSFM_US_power_grid",
366
  export_dir="./gridsfm_data", # optional; pre-fetches everything here
367
  )
368
 
369
  # To skip the automatic download, use pre_fetch_all=False (lazy download on access)
370
  # loader = GridSFM_PG_Loader(
371
+ # "microsoft/GridSFM_US_power_grid",
372
  # export_dir="./gridsfm_data",
373
  # pre_fetch_all=False,
374
  # )
 
397
  **Download the entire dataset (~230 MB):**
398
 
399
  ```bash
400
+ hf download --repo-type dataset microsoft/GridSFM_US_power_grid --local-dir ./gridsfm_data
401
  ```
402
 
403
  **Download a subset (one hour only):**
404
 
405
  ```bash
406
+ hf download --repo-type dataset microsoft/GridSFM_US_power_grid --include "16h/*" --local-dir ./gridsfm_data
407
  ```
408
 
409
  ### Load a model from local files