Add files using upload-large-folder tool

.gitattributes

@@ -57,3 +57,6 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 # Video files - compressed
 *.mp4 filter=lfs diff=lfs merge=lfs -text
 *.webm filter=lfs diff=lfs merge=lfs -text
+train/SOCOPF/dual/xaa filter=lfs diff=lfs merge=lfs -text
+train/SOCOPF/dual/xab filter=lfs diff=lfs merge=lfs -text
+train/SOCOPF/dual/xac filter=lfs diff=lfs merge=lfs -text

PGLearn-Large-9241_pegase-nminus1.py

@@ -0,0 +1,429 @@
+from __future__ import annotations
+from dataclasses import dataclass
+from pathlib import Path
+import json
+import shutil
+
+import datasets as hfd
+import h5py
+import pgzip as gzip
+import pyarrow as pa
+
+# ┌──────────────┐
+# │   Metadata   │
+# └──────────────┘
+
+@dataclass
+class CaseSizes:
+    n_bus:    int
+    n_load:   int
+    n_gen:    int
+    n_branch: int
+
+CASENAME = "9241_pegase-nminus1"
+SIZES = CaseSizes(n_bus=9241, n_load=4895, n_gen=1445, n_branch=16049)
+NUM_TRAIN = 61158
+NUM_TEST = 15290
+NUM_INFEASIBLE = 23552
+SPLITFILES = {
+    "train/SOCOPF/dual.h5.gz": ["train/SOCOPF/dual/xaa", "train/SOCOPF/dual/xab", "train/SOCOPF/dual/xac"],
+}
+
+URL = "https://huggingface.co/datasets/PGLearn/PGLearn-Large-9241_pegase-nminus1"
+DESCRIPTION = """\
+The 9241_pegase-nminus1 PGLearn optimal power flow dataset, part of the PGLearn-Large collection. \
+"""
+VERSION = hfd.Version("1.0.0")
+DEFAULT_CONFIG_DESCRIPTION="""\
+This configuration contains feasible input, primal solution, and dual solution data \
+for the ACOPF and DCOPF formulations on the {case} system. For case data, \
+download the case.json.gz file from the `script` branch of the repository. \
+https://huggingface.co/datasets/PGLearn/PGLearn-Large-9241_pegase-nminus1/blob/script/case.json.gz
+"""
+USE_ML4OPF_WARNING = """
+================================================================================================
+  Loading PGLearn-Large-9241_pegase-nminus1 through the `datasets.load_dataset` function may be slow.
+
+  Consider using ML4OPF to directly convert to `torch.Tensor`; for more info see:
+    https://github.com/AI4OPT/ML4OPF?tab=readme-ov-file#manually-loading-data
+
+  Or, use `huggingface_hub.snapshot_download` and an HDF5 reader; for more info see:
+    https://huggingface.co/datasets/PGLearn/PGLearn-Large-9241_pegase-nminus1#downloading-individual-files
+================================================================================================
+"""
+CITATION = """\
+@article{klamkinpglearn,
+  title={{PGLearn - An Open-Source Learning Toolkit for Optimal Power Flow}},
+  author={Klamkin, Michael and Tanneau, Mathieu and Van Hentenryck, Pascal},
+  year={2025},
+}\
+"""
+
+IS_COMPRESSED = True
+
+# ┌──────────────────┐
+# │   Formulations   │
+# └──────────────────┘
+
+def acopf_features(sizes: CaseSizes, primal: bool, dual: bool, meta: bool):
+    features = {}
+    if primal: features.update(acopf_primal_features(sizes))
+    if dual:   features.update(acopf_dual_features(sizes))
+    if meta:   features.update({f"ACOPF/{k}": v for k, v in META_FEATURES.items()})
+    return features
+
+def dcopf_features(sizes: CaseSizes, primal: bool, dual: bool, meta: bool):
+    features = {}
+    if primal: features.update(dcopf_primal_features(sizes))
+    if dual:   features.update(dcopf_dual_features(sizes))
+    if meta:   features.update({f"DCOPF/{k}": v for k, v in META_FEATURES.items()})
+    return features
+
+def socopf_features(sizes: CaseSizes, primal: bool, dual: bool, meta: bool):
+    features = {}
+    if primal: features.update(socopf_primal_features(sizes))
+    if dual:   features.update(socopf_dual_features(sizes))
+    if meta:   features.update({f"SOCOPF/{k}": v for k, v in META_FEATURES.items()})
+    return features
+
+FORMULATIONS_TO_FEATURES = {
+    "ACOPF": acopf_features,
+    "DCOPF": dcopf_features,
+    "SOCOPF": socopf_features,
+}
+
+# ┌───────────────────┐
+# │   BuilderConfig   │
+# └───────────────────┘
+
+class PGLearnLarge9241_pegaseNminus1Config(hfd.BuilderConfig):
+    """BuilderConfig for PGLearn-Large-9241_pegase-nminus1. 
+    By default, primal solution data, metadata, input, casejson, are included for the train and test splits.
+
+    To modify the default configuration, pass attributes of this class to `datasets.load_dataset`:
+    
+    Attributes:
+        formulations (list[str]): The formulation(s) to include, e.g. ["ACOPF", "DCOPF"]
+        primal (bool, optional): Include primal solution data. Defaults to True.
+        dual (bool, optional): Include dual solution data. Defaults to False.
+        meta (bool, optional): Include metadata. Defaults to True.
+        input (bool, optional): Include input data. Defaults to True.
+        casejson (bool, optional): Include case.json data. Defaults to True.
+        train (bool, optional): Include training samples. Defaults to True.
+        test (bool, optional): Include testing samples. Defaults to True.
+        infeasible (bool, optional): Include infeasible samples. Defaults to False.
+    """
+    def __init__(self,
+            formulations: list[str],
+            primal: bool=True, dual: bool=False, meta: bool=True, input: bool = True, casejson: bool=True,
+            train: bool=True, test: bool=True, infeasible: bool=False,
+            compressed: bool=IS_COMPRESSED, **kwargs
+        ):
+        super(PGLearnLarge9241_pegaseNminus1Config, self).__init__(version=VERSION, **kwargs)
+
+        self.case = CASENAME
+        self.formulations = formulations
+
+        self.primal = primal
+        self.dual = dual
+        self.meta = meta
+        self.input = input
+        self.casejson = casejson
+
+        self.train = train
+        self.test = test
+        self.infeasible = infeasible
+
+        self.gz_ext = ".gz" if compressed else ""
+
+    @property
+    def size(self):
+        return SIZES
+
+    @property
+    def features(self):
+        features = {}
+        if self.casejson: features.update(case_features())
+        if self.input: features.update(input_features(SIZES))
+        for formulation in self.formulations:
+            features.update(FORMULATIONS_TO_FEATURES[formulation](SIZES, self.primal, self.dual, self.meta))
+        return hfd.Features(features)
+    
+    @property
+    def splits(self):
+        splits: dict[hfd.Split, dict[str, str | int]] = {}
+        if self.train:
+            splits[hfd.Split.TRAIN] = {
+                "name": "train",
+                "num_examples": NUM_TRAIN
+            }
+        if self.test:
+            splits[hfd.Split.TEST] = {
+                "name": "test",
+                "num_examples": NUM_TEST
+            }
+        if self.infeasible:
+            splits[hfd.Split("infeasible")] = {
+                "name": "infeasible",
+                "num_examples": NUM_INFEASIBLE
+            }
+        return splits
+    
+    @property
+    def urls(self):
+        urls: dict[str, None | str | list] = {
+            "case": None, "train": [], "test": [], "infeasible": [],
+        }
+
+        if self.casejson:
+            urls["case"] = f"case.json" + self.gz_ext
+        else:
+            urls.pop("case")
+
+        split_names = []
+        if self.train: split_names.append("train")
+        if self.test:  split_names.append("test")
+        if self.infeasible: split_names.append("infeasible")
+
+        for split in split_names:
+            if self.input: urls[split].append(f"{split}/input.h5" + self.gz_ext)
+            for formulation in self.formulations:
+                if self.primal:
+                    filename = f"{split}/{formulation}/primal.h5" + self.gz_ext
+                    if filename in SPLITFILES: urls[split].append(SPLITFILES[filename])
+                    else: urls[split].append(filename)
+                if self.dual:
+                    filename = f"{split}/{formulation}/dual.h5" + self.gz_ext
+                    if filename in SPLITFILES: urls[split].append(SPLITFILES[filename])
+                    else: urls[split].append(filename)
+                if self.meta:
+                    filename = f"{split}/{formulation}/meta.h5" + self.gz_ext
+                    if filename in SPLITFILES: urls[split].append(SPLITFILES[filename])
+                    else: urls[split].append(filename)
+        return urls
+
+# ┌────────────────────┐
+# │   DatasetBuilder   │
+# └────────────────────┘
+
+class PGLearnLarge9241_pegaseNminus1(hfd.ArrowBasedBuilder):
+    """DatasetBuilder for PGLearn-Large-9241_pegase-nminus1.
+    The main interface is `datasets.load_dataset` with `trust_remote_code=True`, e.g.
+
+    ```python
+    from datasets import load_dataset
+    ds = load_dataset("PGLearn/PGLearn-Large-9241_pegase-nminus1", trust_remote_code=True,
+        # modify the default configuration by passing kwargs
+        formulations=["DCOPF"],
+        dual=False,
+        meta=False,
+    )
+    ```
+    """
+
+    DEFAULT_WRITER_BATCH_SIZE = 10000
+    BUILDER_CONFIG_CLASS = PGLearnLarge9241_pegaseNminus1Config
+    DEFAULT_CONFIG_NAME=CASENAME
+    BUILDER_CONFIGS = [
+        PGLearnLarge9241_pegaseNminus1Config(
+            name=CASENAME, description=DEFAULT_CONFIG_DESCRIPTION.format(case=CASENAME),
+            formulations=list(FORMULATIONS_TO_FEATURES.keys()),
+            primal=True, dual=True, meta=True, input=True, casejson=False,
+            train=True, test=True, infeasible=False,
+        )
+    ]
+
+    def _info(self):
+        return hfd.DatasetInfo(
+            features=self.config.features, splits=self.config.splits,
+            description=DESCRIPTION + self.config.description,
+            homepage=URL, citation=CITATION,
+        )
+
+    def _split_generators(self, dl_manager: hfd.DownloadManager):
+        hfd.logging.get_logger().warning(USE_ML4OPF_WARNING)
+
+        filepaths = dl_manager.download_and_extract(self.config.urls)
+
+        splits: list[hfd.SplitGenerator] = []
+        if self.config.train:
+            splits.append(hfd.SplitGenerator(
+                name=hfd.Split.TRAIN,
+                gen_kwargs=dict(case_file=filepaths.get("case", None), data_files=tuple(filepaths["train"]), n_samples=NUM_TRAIN),
+            ))
+        if self.config.test:
+            splits.append(hfd.SplitGenerator(
+                name=hfd.Split.TEST,
+                gen_kwargs=dict(case_file=filepaths.get("case", None), data_files=tuple(filepaths["test"]), n_samples=NUM_TEST),
+            ))
+        if self.config.infeasible:
+            splits.append(hfd.SplitGenerator(
+                name=hfd.Split("infeasible"),
+                gen_kwargs=dict(case_file=filepaths.get("case", None), data_files=tuple(filepaths["infeasible"]), n_samples=NUM_INFEASIBLE),
+            ))
+        return splits
+
+    def _generate_tables(self, case_file: str | None, data_files: tuple[hfd.utils.track.tracked_str | list[hfd.utils.track.tracked_str]], n_samples: int):
+        case_data: str | None = json.dumps(json.load(open_maybe_gzip_cat(case_file))) if case_file is not None else None
+        data: dict[str, h5py.File] = {}
+        for file in data_files:
+            v = h5py.File(open_maybe_gzip_cat(file), "r")
+            if isinstance(file, list):
+                k = "/".join(Path(file[0].get_origin()).parts[-3:-1]).split(".")[0]
+            else:
+                k = "/".join(Path(file.get_origin()).parts[-2:]).split(".")[0]
+            data[k] = v
+        for k in list(data.keys()):
+            if "/input" in k: data[k.split("/", 1)[1]] = data.pop(k)
+
+        batch_size = self._writer_batch_size or self.DEFAULT_WRITER_BATCH_SIZE
+        for i in range(0, n_samples, batch_size):
+            effective_batch_size = min(batch_size, n_samples - i)
+
+            sample_data = {
+                f"{dk}/{k}":
+                hfd.features.features.numpy_to_pyarrow_listarray(v[i:i + effective_batch_size, ...])
+                for dk, d in data.items() for k, v in d.items() if f"{dk}/{k}" in self.config.features
+            }
+
+            if case_data is not None:
+                sample_data["case/json"] = pa.array([case_data] * effective_batch_size)
+
+            yield i, pa.Table.from_pydict(sample_data)
+
+        for f in data.values():
+            f.close()
+
+# ┌──────────────┐
+# │   Features   │
+# └──────────────┘
+
+FLOAT_TYPE = "float32"
+INT_TYPE = "int64"
+BOOL_TYPE = "bool"
+STRING_TYPE = "string"
+
+def case_features():
+    # FIXME: better way to share schema of case data -- need to treat jagged arrays
+    return {
+        "case/json": hfd.Value(STRING_TYPE),
+    }
+
+META_FEATURES = {
+    "meta/seed":                   hfd.Value(dtype=INT_TYPE),
+    "meta/formulation":            hfd.Value(dtype=STRING_TYPE),
+    "meta/primal_objective_value": hfd.Value(dtype=FLOAT_TYPE),
+    "meta/dual_objective_value":   hfd.Value(dtype=FLOAT_TYPE),
+    "meta/primal_status":          hfd.Value(dtype=STRING_TYPE),
+    "meta/dual_status":            hfd.Value(dtype=STRING_TYPE),
+    "meta/termination_status":     hfd.Value(dtype=STRING_TYPE),
+    "meta/build_time":             hfd.Value(dtype=FLOAT_TYPE),
+    "meta/extract_time":           hfd.Value(dtype=FLOAT_TYPE),
+    "meta/solve_time":             hfd.Value(dtype=FLOAT_TYPE),
+}
+
+def input_features(sizes: CaseSizes):
+    return {
+        "input/pd":            hfd.Sequence(length=sizes.n_load,   feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "input/qd":            hfd.Sequence(length=sizes.n_load,   feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "input/gen_status":    hfd.Sequence(length=sizes.n_gen,    feature=hfd.Value(dtype=BOOL_TYPE)),
+        "input/branch_status": hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=BOOL_TYPE)),
+        "input/seed":          hfd.Value(dtype=INT_TYPE),
+    }
+
+def acopf_primal_features(sizes: CaseSizes):
+    return {
+        "ACOPF/primal/vm": hfd.Sequence(length=sizes.n_bus,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/primal/va": hfd.Sequence(length=sizes.n_bus,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/primal/pg": hfd.Sequence(length=sizes.n_gen,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/primal/qg": hfd.Sequence(length=sizes.n_gen,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/primal/pf": hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/primal/pt": hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/primal/qf": hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/primal/qt": hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+    }
+def acopf_dual_features(sizes: CaseSizes):
+    return {
+        "ACOPF/dual/kcl_p":     hfd.Sequence(length=sizes.n_bus,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/dual/kcl_q":     hfd.Sequence(length=sizes.n_bus,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/dual/vm":        hfd.Sequence(length=sizes.n_bus,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/dual/pg":        hfd.Sequence(length=sizes.n_gen,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/dual/qg":        hfd.Sequence(length=sizes.n_gen,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/dual/ohm_pf":    hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/dual/ohm_pt":    hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/dual/ohm_qf":    hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/dual/ohm_qt":    hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/dual/pf":        hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/dual/pt":        hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/dual/qf":        hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/dual/qt":        hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/dual/va_diff":   hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/dual/sm_fr":     hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/dual/sm_to":     hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "ACOPF/dual/slack_bus": hfd.Value(dtype=FLOAT_TYPE),
+    }
+def dcopf_primal_features(sizes: CaseSizes):
+    return {
+        "DCOPF/primal/va": hfd.Sequence(length=sizes.n_bus,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "DCOPF/primal/pg": hfd.Sequence(length=sizes.n_gen,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "DCOPF/primal/pf": hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+    }
+def dcopf_dual_features(sizes: CaseSizes):
+    return {
+        "DCOPF/dual/kcl_p":     hfd.Sequence(length=sizes.n_bus,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "DCOPF/dual/pg":        hfd.Sequence(length=sizes.n_gen,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "DCOPF/dual/ohm_pf":    hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "DCOPF/dual/pf":        hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "DCOPF/dual/va_diff":   hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "DCOPF/dual/slack_bus": hfd.Value(dtype=FLOAT_TYPE),
+    }
+def socopf_primal_features(sizes: CaseSizes):
+    return {
+        "SOCOPF/primal/w":  hfd.Sequence(length=sizes.n_bus,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/primal/pg": hfd.Sequence(length=sizes.n_gen,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/primal/qg": hfd.Sequence(length=sizes.n_gen,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/primal/pf": hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/primal/pt": hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/primal/qf": hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/primal/qt": hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/primal/wr": hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/primal/wi": hfd.Sequence(length=sizes.n_branch, feature=hfd.Value(dtype=FLOAT_TYPE)),
+    }
+def socopf_dual_features(sizes: CaseSizes):
+    return {
+        "SOCOPF/dual/kcl_p":   hfd.Sequence(length=sizes.n_bus,       feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/dual/kcl_q":   hfd.Sequence(length=sizes.n_bus,       feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/dual/w":       hfd.Sequence(length=sizes.n_bus,       feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/dual/pg":      hfd.Sequence(length=sizes.n_gen,       feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/dual/qg":      hfd.Sequence(length=sizes.n_gen,       feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/dual/ohm_pf":  hfd.Sequence(length=sizes.n_branch,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/dual/ohm_pt":  hfd.Sequence(length=sizes.n_branch,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/dual/ohm_qf":  hfd.Sequence(length=sizes.n_branch,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/dual/ohm_qt":  hfd.Sequence(length=sizes.n_branch,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/dual/jabr":    hfd.Array2D(shape=(sizes.n_branch, 4), dtype=FLOAT_TYPE),
+        "SOCOPF/dual/sm_fr":   hfd.Array2D(shape=(sizes.n_branch, 3), dtype=FLOAT_TYPE),
+        "SOCOPF/dual/sm_to":   hfd.Array2D(shape=(sizes.n_branch, 3), dtype=FLOAT_TYPE),
+        "SOCOPF/dual/va_diff": hfd.Sequence(length=sizes.n_branch,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/dual/wr":      hfd.Sequence(length=sizes.n_branch,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/dual/wi":      hfd.Sequence(length=sizes.n_branch,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/dual/pf":      hfd.Sequence(length=sizes.n_branch,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/dual/pt":      hfd.Sequence(length=sizes.n_branch,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/dual/qf":      hfd.Sequence(length=sizes.n_branch,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+        "SOCOPF/dual/qt":      hfd.Sequence(length=sizes.n_branch,    feature=hfd.Value(dtype=FLOAT_TYPE)),
+    }
+
+# ┌───────────────┐
+# │   Utilities   │
+# └───────────────┘
+
+def open_maybe_gzip_cat(path: str | list):
+    if isinstance(path, list):
+        dest = Path(path[0]).parent.with_suffix(".h5")
+        if not dest.exists():
+            with open(dest, "wb") as dest_f:
+                for piece in path:
+                    with open(piece, "rb") as piece_f:
+                        shutil.copyfileobj(piece_f, dest_f)
+            shutil.rmtree(Path(piece).parent)
+        path = dest.as_posix()
+    return gzip.open(path, "rb") if path.endswith(".gz") else open(path, "rb")

README.md

@@ -0,0 +1,293 @@
+---
+license: cc-by-sa-4.0
+tags:
+- energy
+- optimization
+- optimal_power_flow
+- power_grid
+pretty_name: PGLearn Optimal Power Flow (9241_pegase, N-1)
+task_categories:
+- tabular-regression
+dataset_info:
+  config_name: 9241_pegase-nminus1
+  features:
+  - name: input/pd
+    sequence: float32
+    length: 4895
+  - name: input/qd
+    sequence: float32
+    length: 4895
+  - name: input/gen_status
+    sequence: bool
+    length: 1445
+  - name: input/branch_status
+    sequence: bool
+    length: 16049
+  - name: input/seed
+    dtype: int64
+  - name: ACOPF/primal/vm
+    sequence: float32
+    length: 9241
+  - name: ACOPF/primal/va
+    sequence: float32
+    length: 9241
+  - name: ACOPF/primal/pg
+    sequence: float32
+    length: 1445
+  - name: ACOPF/primal/qg
+    sequence: float32
+    length: 1445
+  - name: ACOPF/primal/pf
+    sequence: float32
+    length: 16049
+  - name: ACOPF/primal/pt
+    sequence: float32
+    length: 16049
+  - name: ACOPF/primal/qf
+    sequence: float32
+    length: 16049
+  - name: ACOPF/primal/qt
+    sequence: float32
+    length: 16049
+  - name: ACOPF/dual/kcl_p
+    sequence: float32
+    length: 9241
+  - name: ACOPF/dual/kcl_q
+    sequence: float32
+    length: 9241
+  - name: ACOPF/dual/vm
+    sequence: float32
+    length: 9241
+  - name: ACOPF/dual/pg
+    sequence: float32
+    length: 1445
+  - name: ACOPF/dual/qg
+    sequence: float32
+    length: 1445
+  - name: ACOPF/dual/ohm_pf
+    sequence: float32
+    length: 16049
+  - name: ACOPF/dual/ohm_pt
+    sequence: float32
+    length: 16049
+  - name: ACOPF/dual/ohm_qf
+    sequence: float32
+    length: 16049
+  - name: ACOPF/dual/ohm_qt
+    sequence: float32
+    length: 16049
+  - name: ACOPF/dual/pf
+    sequence: float32
+    length: 16049
+  - name: ACOPF/dual/pt
+    sequence: float32
+    length: 16049
+  - name: ACOPF/dual/qf
+    sequence: float32
+    length: 16049
+  - name: ACOPF/dual/qt
+    sequence: float32
+    length: 16049
+  - name: ACOPF/dual/va_diff
+    sequence: float32
+    length: 16049
+  - name: ACOPF/dual/sm_fr
+    sequence: float32
+    length: 16049
+  - name: ACOPF/dual/sm_to
+    sequence: float32
+    length: 16049
+  - name: ACOPF/dual/slack_bus
+    dtype: float32
+  - name: ACOPF/meta/seed
+    dtype: int64
+  - name: ACOPF/meta/formulation
+    dtype: string
+  - name: ACOPF/meta/primal_objective_value
+    dtype: float32
+  - name: ACOPF/meta/dual_objective_value
+    dtype: float32
+  - name: ACOPF/meta/primal_status
+    dtype: string
+  - name: ACOPF/meta/dual_status
+    dtype: string
+  - name: ACOPF/meta/termination_status
+    dtype: string
+  - name: ACOPF/meta/build_time
+    dtype: float32
+  - name: ACOPF/meta/extract_time
+    dtype: float32
+  - name: ACOPF/meta/solve_time
+    dtype: float32
+  - name: DCOPF/primal/va
+    sequence: float32
+    length: 9241
+  - name: DCOPF/primal/pg
+    sequence: float32
+    length: 1445
+  - name: DCOPF/primal/pf
+    sequence: float32
+    length: 16049
+  - name: DCOPF/dual/kcl_p
+    sequence: float32
+    length: 9241
+  - name: DCOPF/dual/pg
+    sequence: float32
+    length: 1445
+  - name: DCOPF/dual/ohm_pf
+    sequence: float32
+    length: 16049
+  - name: DCOPF/dual/pf
+    sequence: float32
+    length: 16049
+  - name: DCOPF/dual/va_diff
+    sequence: float32
+    length: 16049
+  - name: DCOPF/dual/slack_bus
+    dtype: float32
+  - name: DCOPF/meta/seed
+    dtype: int64
+  - name: DCOPF/meta/formulation
+    dtype: string
+  - name: DCOPF/meta/primal_objective_value
+    dtype: float32
+  - name: DCOPF/meta/dual_objective_value
+    dtype: float32
+  - name: DCOPF/meta/primal_status
+    dtype: string
+  - name: DCOPF/meta/dual_status
+    dtype: string
+  - name: DCOPF/meta/termination_status
+    dtype: string
+  - name: DCOPF/meta/build_time
+    dtype: float32
+  - name: DCOPF/meta/extract_time
+    dtype: float32
+  - name: DCOPF/meta/solve_time
+    dtype: float32
+  - name: SOCOPF/primal/w
+    sequence: float32
+    length: 9241
+  - name: SOCOPF/primal/pg
+    sequence: float32
+    length: 1445
+  - name: SOCOPF/primal/qg
+    sequence: float32
+    length: 1445
+  - name: SOCOPF/primal/pf
+    sequence: float32
+    length: 16049
+  - name: SOCOPF/primal/pt
+    sequence: float32
+    length: 16049
+  - name: SOCOPF/primal/qf
+    sequence: float32
+    length: 16049
+  - name: SOCOPF/primal/qt
+    sequence: float32
+    length: 16049
+  - name: SOCOPF/primal/wr
+    sequence: float32
+    length: 16049
+  - name: SOCOPF/primal/wi
+    sequence: float32
+    length: 16049
+  - name: SOCOPF/dual/kcl_p
+    sequence: float32
+    length: 9241
+  - name: SOCOPF/dual/kcl_q
+    sequence: float32
+    length: 9241
+  - name: SOCOPF/dual/w
+    sequence: float32
+    length: 9241
+  - name: SOCOPF/dual/pg
+    sequence: float32
+    length: 1445
+  - name: SOCOPF/dual/qg
+    sequence: float32
+    length: 1445
+  - name: SOCOPF/dual/ohm_pf
+    sequence: float32
+    length: 16049
+  - name: SOCOPF/dual/ohm_pt
+    sequence: float32
+    length: 16049
+  - name: SOCOPF/dual/ohm_qf
+    sequence: float32
+    length: 16049
+  - name: SOCOPF/dual/ohm_qt
+    sequence: float32
+    length: 16049
+  - name: SOCOPF/dual/jabr
+    dtype:
+      array2_d:
+        shape:
+        - 16049
+        - 4
+        dtype: float32
+  - name: SOCOPF/dual/sm_fr
+    dtype:
+      array2_d:
+        shape:
+        - 16049
+        - 3
+        dtype: float32
+  - name: SOCOPF/dual/sm_to
+    dtype:
+      array2_d:
+        shape:
+        - 16049
+        - 3
+        dtype: float32
+  - name: SOCOPF/dual/va_diff
+    sequence: float32
+    length: 16049
+  - name: SOCOPF/dual/wr
+    sequence: float32
+    length: 16049
+  - name: SOCOPF/dual/wi
+    sequence: float32
+    length: 16049
+  - name: SOCOPF/dual/pf
+    sequence: float32
+    length: 16049
+  - name: SOCOPF/dual/pt
+    sequence: float32
+    length: 16049
+  - name: SOCOPF/dual/qf
+    sequence: float32
+    length: 16049
+  - name: SOCOPF/dual/qt
+    sequence: float32
+    length: 16049
+  - name: SOCOPF/meta/seed
+    dtype: int64
+  - name: SOCOPF/meta/formulation
+    dtype: string
+  - name: SOCOPF/meta/primal_objective_value
+    dtype: float32
+  - name: SOCOPF/meta/dual_objective_value
+    dtype: float32
+  - name: SOCOPF/meta/primal_status
+    dtype: string
+  - name: SOCOPF/meta/dual_status
+    dtype: string
+  - name: SOCOPF/meta/termination_status
+    dtype: string
+  - name: SOCOPF/meta/build_time
+    dtype: float32
+  - name: SOCOPF/meta/extract_time
+    dtype: float32
+  - name: SOCOPF/meta/solve_time
+    dtype: float32
+  splits:
+  - name: train
+    num_bytes: 211552784513
+    num_examples: 61158
+  - name: test
+    num_bytes: 52889925689
+    num_examples: 15290
+  download_size: 219594823915
+  dataset_size: 264442710202
+---

case.json.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:163106af78f819b569cad7e5ce7b1f88623ca82be2eaa5948e2dca96a0240949
+size 9154665

config.toml

@@ -0,0 +1,44 @@
+# Name of the reference PGLib case. Must be a valid PGLib case name.
+pglib_case = "pglib_opf_case9241_pegase"
+floating_point_type = "Float32"
+
+[sampler]
+# data sampler options
+[sampler.load]
+noise_type = "ScaledUniform"
+l          = 0.6                # Lower bound of base load factor
+u          = 1.0                # Upper bound of base load factor
+sigma      = 0.20               # Relative (multiplicative) noise level.
+
+[sampler.status]
+type = "Nminus1"
+
+[OPF]
+
+[OPF.ACOPF]
+type = "ACOPF"
+solver.name = "Ipopt"
+solver.attributes.tol = 1e-6
+solver.attributes.linear_solver = "ma27"
+
+[OPF.DCOPF]
+# Formulation/solver options
+type = "DCOPF"
+solver.name = "HiGHS"
+
+[OPF.SOCOPF]
+type = "SOCOPF"
+solver.name = "Clarabel"
+# Tight tolerances
+solver.attributes.tol_gap_abs    = 1e-6
+solver.attributes.tol_gap_rel    = 1e-6
+solver.attributes.tol_feas       = 1e-6
+solver.attributes.tol_infeas_rel = 1e-6
+solver.attributes.tol_ktratio    = 1e-6
+# Reduced accuracy settings
+solver.attributes.reduced_tol_gap_abs    = 1e-6
+solver.attributes.reduced_tol_gap_rel    = 1e-6
+solver.attributes.reduced_tol_feas       = 1e-6
+solver.attributes.reduced_tol_infeas_abs = 1e-6
+solver.attributes.reduced_tol_infeas_rel = 1e-6
+solver.attributes.reduced_tol_ktratio    = 1e-6

infeasible/ACOPF/dual.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5fb5e5d4d972022344347eafcdde76cd7272f2f7994a8cd3532f0ec84f0f0b8d
+size 16377887993

infeasible/ACOPF/meta.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:c862c2c87883a336a6cfe10268d58c1fa279be2839e6809959d9c2151b32f332
+size 829162

infeasible/ACOPF/primal.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4fbf0a042c91aa1e08ab42ebfe868822815f3176a6254960125ee78326610ec9
+size 7310441964

infeasible/DCOPF/dual.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:909c02bfa59e86c1879b92916ad1293f260f70b15f0242bdf4669e26e745abbe
+size 1805860458

infeasible/DCOPF/meta.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:2ce0c0ee4ead43cb73d06c8f7b355cf803cae9965f0d68d7c0e71bb692008022
+size 814405

infeasible/DCOPF/primal.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ed871b53bf06a8e1e48dba92db78e53565cb8a9f945b4fa0c3509b9dd03ef025
+size 2003191012

infeasible/SOCOPF/dual.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a058e57027de28b6c0c0a6035f2f59180e426bbfd6d2e118eedd29b59896e195
+size 30283018893

infeasible/SOCOPF/meta.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b9f11c0cf86d24d483ba644efd6d9214f1e31a54ae7a1cd67e69b1d7b85bf479
+size 752959

infeasible/SOCOPF/primal.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a99aaba2192ed61ddc02c629a689e6fcf039e2cdea52df464679152cb13fa591
+size 9118006742

infeasible/input.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a051f9166b2182aac627adc5bf67f9aa0ea473ede38b6805bd8b409444171f9d
+size 851245839

test/ACOPF/dual.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:76a82890d9d90947949b3716ce15bb8b2fc42fe6f3929fc882477e1e7fab4f84
+size 10438638541

test/ACOPF/meta.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6c1083738a8ce4afa1bf9f6781f579fd901d6576149a56cb09d813a19128b9a4
+size 520715

test/ACOPF/primal.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b775e5e973bd3a61dc8b004a3383f07cc19c238ff391eb524adbf127c717d9d1
+size 4725528458

test/DCOPF/dual.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:3382196d68a80c817196a1828dee71a6fce6a858e4ba7754a219ce26d1f3ce4a
+size 1228696414

test/DCOPF/meta.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:9cf31a81c26bf556b2474bf8162db6a7a9cad87d5913a04b559fde5f41a14bec
+size 522917

test/DCOPF/primal.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:24acdd69d63498458560857c1199b08cd6c2e434e24286462120693caae15256
+size 1367332645

test/SOCOPF/dual.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:eb342bf2df24e8f0cfc7255d566f8f8b7c77fb9f8d98a9aba0afc7302013e296
+size 19617075908

test/SOCOPF/meta.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7ba77e6aa2f00f6a268305fb8e12ee61e905cbcbbef6cfec440c759a24dfe4d2
+size 521404

test/SOCOPF/primal.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:fdd944c833ed21455a464c2eecf6a891d5be2576b98a30021418f2dc16e42fc7
+size 5924466295

test/input.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:596565eae06a826bae5772cb6c3ca876581305b3f0da4ad9eb6f1df1f2a8c32d
+size 552632885

train/ACOPF/dual.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d549b49edfaf9ba625c05095fa5acf54dcdab82e7c8241cb567811a260e28b44
+size 41752851579

train/ACOPF/meta.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:478c6ec87e1422405f2c87a6d1a2ae1c66f0bbe2b7b83eb17b4cb4fe66bd16b4
+size 2054959

train/ACOPF/primal.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:92430770c0ffa7cf9447c13062de77aff99b64de29f1ca651fa917399204eef5
+size 18901563058

train/DCOPF/dual.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:72e2bc4ccb55beecb9ff0b0051e4c858426d5640bed93e8578fe9cf7b8a03604
+size 4914433723

train/DCOPF/meta.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1e1de760e213a125252ad7926c92a1734568747e8d12dc32324c999adc8432d0
+size 2063884

train/DCOPF/primal.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:bc555d1aa00e24eb168d16dba87feed0cd6e65de06f46ebd91f9123978ec2182
+size 5469194888

train/SOCOPF/dual/xaa

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ae7148a452ada39c97206909e708c6f211d97d136a296f4a4156fa74c0ad4187
+size 32212254720

train/SOCOPF/dual/xab

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5f84980a80f794de98702cc2a1330e1938fa3db8d2751360dc568a2c2d5ffb4f
+size 32212254720

train/SOCOPF/dual/xac

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:dd4d14e3219da0a2f888abdc6b71a2c83bfbacb62f6fb049b754bdbe6b3dafbc
+size 25512496496

train/SOCOPF/meta.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8233592a19902d73901e4720445c48b2e08e395ace93ef23b6f08cf4c6ce0756
+size 2057186

train/SOCOPF/primal.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:cdb0dff2ae4a89c2cae4dc90ebd4d155f3c50a02b0a28c850b5e66304bd2d624
+size 23696995724

train/input.h5.gz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:404b8cfab3cf879e4857bb2a7d068f5f1b0d41cf8ed8bae04f3d349b342ea21a
+size 2210449180