Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,165 @@
+---
+license: cc-by-4.0
+task_categories:
+  - tabular-regression
+tags:
+  - sparse-matrices
+  - linear-systems
+  - preconditioners
+  - numerical-linear-algebra
+  - suitesparse
+  - scientific-computing
+  - benchmark
+size_categories:
+  - n<1K
+configs:
+  - config_name: manifest
+    data_files: manifest.parquet
+---
+
+# MatrixPFN SuiteSparse Evaluation Set
+
+A curated subset of the [SuiteSparse Matrix Collection](https://sparse.tamu.edu/) for benchmarking learned preconditioners on sparse linear systems, matching the evaluation criteria from the GNP paper ([arXiv 2406.00809v3](https://arxiv.org/abs/2406.00809v3)).
+
+## Dataset Description
+
+- **Source:** [SuiteSparse Matrix Collection](https://sparse.tamu.edu/)
+- **License:** CC-BY 4.0
+- **Total matrices:** 867
+- **Format:** Matrix Market (.mtx)
+- **Size on disk:** ~5.7 GB
+
+| Property | Value |
+|---|---|
+| Rows/Cols | 1,000 - 100,000 |
+| Nonzeros | 1,314 - 1,990,919 |
+| Shape | Square |
+| Type | Real, non-SPD |
+| Problem domains | 50 categories |
+
+### Domain Distribution (top 10)
+
+| Count | Domain |
+|---|---|
+| 123 | Circuit simulation |
+| 75 | Computational fluid dynamics |
+| 69 | Optimization |
+| 67 | Optimal control |
+| 59 | Economic |
+| 49 | Chemical process simulation |
+| 47 | Undirected weighted graph |
+| 32 | Circuit simulation (frequency-domain) |
+| 31 | 2D/3D problem |
+| 30 | Eigenvalue/model reduction |
+
+## Dataset Structure
+
+```
+.
+├── README.md
+├── manifest.parquet              # Matrix metadata (id, group, name, rows, cols, nnz, kind)
+├── suitesparse/
+│   ├── 2D_27628_bjtcai/
+│   │   └── 2D_27628_bjtcai.mtx
+│   ├── ACTIVSg2000/
+│   │   └── ACTIVSg2000.mtx
+│   └── ...                       # 867 matrix directories
+└── benchmark_results/
+    └── benchmark_gnp_paper.jsonl  # FGMRES benchmark with 6 preconditioners
+```
+
+### manifest.parquet
+
+Browsable in the HuggingFace Dataset Viewer. Fields:
+
+| Column | Type | Description |
+|---|---|---|
+| `id` | int | SuiteSparse matrix ID |
+| `group` | str | Collection group (e.g. "HB", "SNAP") |
+| `name` | str | Matrix name |
+| `rows` | int | Number of rows |
+| `cols` | int | Number of columns |
+| `nnz` | int | Number of nonzeros |
+| `kind` | str | Problem domain |
+
+### benchmark_results/
+
+JSONL file with FGMRES solver results per matrix for 6 preconditioners: None, Jacobi, Block Jacobi, ILU(0), AMG (AIR), GMRES-Inner. Includes convergence status, iteration count, residual history, and AUC metrics.
+
+## Dataset Creation
+
+### Selection Criteria
+
+Matches the GNP paper evaluation set:
+- Square matrices only (`rows == cols`)
+- Real-valued (not complex)
+- Non-SPD (not symmetric positive definite)
+- 1,000 to 100,000 rows
+- Less than 2,000,000 nonzeros
+
+### Source Data
+
+All matrices originate from the [SuiteSparse Matrix Collection](https://sparse.tamu.edu/), downloaded unmodified in Matrix Market format via [ssgetpy](https://github.com/drdarshan/ssgetpy).
+
+## Usage
+
+```python
+from scipy.io import mmread
+from huggingface_hub import hf_hub_download
+
+path = hf_hub_download(
+    repo_id="Csed-dev/matrixpfn-base",
+    filename="suitesparse/ACTIVSg2000/ACTIVSg2000.mtx",
+    repo_type="dataset",
+)
+matrix = mmread(path)
+print(f"Shape: {matrix.shape}, NNZ: {matrix.nnz}")
+```
+
+```python
+from datasets import load_dataset
+
+manifest = load_dataset("Csed-dev/matrixpfn-base", "manifest")
+print(manifest["train"].to_pandas().head())
+```
+
+## Considerations
+
+- Matrix Market (.mtx) files are not natively streamable via `datasets`. Use `hf_hub_download` or `snapshot_download` for the sparse matrices.
+- Some matrices may have near-singular or zero diagonals, causing preconditioner construction failures (documented in benchmark results).
+- The benchmark results use spectral-radius scaling (dividing by the infinity norm) before solving.
+
+## Citation
+
+This dataset is a redistribution of matrices from the SuiteSparse Matrix Collection under the CC-BY 4.0 license.
+
+**Required citations:**
+
+```bibtex
+@article{Davis2011,
+  author  = {Timothy A. Davis and Yifan Hu},
+  title   = {The University of Florida Sparse Matrix Collection},
+  journal = {ACM Transactions on Mathematical Software},
+  volume  = {38},
+  number  = {1},
+  year    = {2011},
+  doi     = {10.1145/2049662.2049663}
+}
+
+@article{Kolodziej2019,
+  author  = {Scott P. Kolodziej and Mohsen Aznaveh and Matthew Bullock and Jarrett David and Timothy A. Davis and Matthew Henderson and Yifan Hu and Read Sandstrom},
+  title   = {The SuiteSparse Matrix Collection Website Interface},
+  journal = {Journal of Open Source Software},
+  volume  = {4},
+  number  = {35},
+  pages   = {1244},
+  year    = {2019},
+  doi     = {10.21105/joss.01244}
+}
+```
+
+Individual matrices may have additional citations. See https://sparse.tamu.edu/ for per-matrix metadata.
+
+## License
+
+CC-BY 4.0 (inherited from SuiteSparse Matrix Collection)