Skip to content

Commit 87b35f9

Browse files
author
Yuma Ichikawa
committed
Fix HF dataset handle typo and rename LICENCE.txt to LICENSE
- Correct Hugging Face dataset URL from 'Yuma-Ichikawsa' to 'Yuma-Ichikawa' (17 occurrences across README, docs, data/*, scripts). - Rename LICENCE.txt -> LICENSE so GitHub's licensee and PyPI license classifier can auto-detect the license. License terms are unchanged. - Update pyproject.toml (license.file, sdist include) and README links to the new filename. - Label the license as BSD-3-Clause-Clear in README and CITATION.cff; the text already matched the BSD-3-Clause-Clear SPDX template (the 'NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS' clause distinguishes it from plain BSD-3-Clause). Made-with: Cursor
1 parent 1288e09 commit 87b35f9

14 files changed

Lines changed: 22 additions & 21 deletions

File tree

CITATION.cff

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ authors:
88
given-names: Yamato
99
repository-code: "https://github.com/Yuma-Ichikawa/QQA4CO"
1010
url: "https://github.com/Yuma-Ichikawa/QQA4CO"
11-
license: BSD-3-Clause
11+
license: BSD-3-Clause-Clear
1212
version: 0.5.0
1313
date-released: 2026-04-19
1414
doi: 10.5281/zenodo.19648231
File renamed without changes.

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,19 @@ with earlier QQA4CO releases (``import qqa``).
1616
<p align="center">
1717
<a href="https://pypi.org/project/qqa/"><img src="https://img.shields.io/pypi/v/qqa.svg?logo=pypi&logoColor=white&label=PyPI" alt="PyPI version"></a>
1818
<a href="https://pypi.org/project/qqa/"><img src="https://img.shields.io/pypi/pyversions/qqa.svg?logo=python&logoColor=white" alt="Python versions"></a>
19-
<a href="https://github.com/Yuma-Ichikawa/QQA4CO/blob/main/LICENCE.txt"><img src="https://img.shields.io/pypi/l/qqa.svg" alt="License"></a>
19+
<a href="https://github.com/Yuma-Ichikawa/QQA4CO/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/qqa.svg" alt="License"></a>
2020
<a href="https://github.com/Yuma-Ichikawa/QQA4CO/actions/workflows/ci.yml"><img src="https://github.com/Yuma-Ichikawa/QQA4CO/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
2121
<a href="https://yuma-ichikawa.github.io/QQA4CO/"><img src="https://img.shields.io/badge/docs-mkdocs--material-blue?logo=materialformkdocs&logoColor=white" alt="Documentation"></a>
2222
<a href="https://github.com/Yuma-Ichikawa/QQA4CO/discussions"><img src="https://img.shields.io/github/discussions/Yuma-Ichikawa/QQA4CO?logo=github&label=Discussions" alt="GitHub Discussions"></a>
2323
<a href="https://codecov.io/gh/Yuma-Ichikawa/QQA4CO"><img src="https://codecov.io/gh/Yuma-Ichikawa/QQA4CO/branch/main/graph/badge.svg" alt="Coverage"></a>
2424
<a href="https://doi.org/10.5281/zenodo.19648231"><img src="https://img.shields.io/badge/DOI-10.5281%2Fzenodo.19648231-1f6feb?logo=doi&logoColor=white" alt="DOI"></a>
25-
<a href="https://huggingface.co/datasets/Yuma-Ichikawsa/qqa4co-bench"><img src="https://img.shields.io/badge/%F0%9F%A4%97%20Dataset-Yuma--Ichikawsa%2Fqqa4co--bench-yellow" alt="Hugging Face dataset"></a>
25+
<a href="https://huggingface.co/datasets/Yuma-Ichikawa/qqa4co-bench"><img src="https://img.shields.io/badge/%F0%9F%A4%97%20Dataset-Yuma--Ichikawsa%2Fqqa4co--bench-yellow" alt="Hugging Face dataset"></a>
2626
</p>
2727

2828
<p align="center">
2929
<b>Benchmark data &nbsp;·&nbsp;</b>
30-
<a href="https://huggingface.co/datasets/Yuma-Ichikawsa/qqa4co-bench">
31-
<code>huggingface.co/datasets/Yuma-Ichikawsa/qqa4co-bench</code>
30+
<a href="https://huggingface.co/datasets/Yuma-Ichikawa/qqa4co-bench">
31+
<code>huggingface.co/datasets/Yuma-Ichikawa/qqa4co-bench</code>
3232
</a>
3333
<br>
3434
<sub>DISCS (NeurIPS 2023) + MaxCut G-set (Helmberg & Rendl 2000) + Graph Coloring (COLOR) + MIS on d-regular random graphs (PQQA §5.1) + 3D Edwards-Anderson spin glass + Balanced k-way partition — one HF dataset, <code>make bench-all-setup</code> pulls everything.</sub>
@@ -409,7 +409,7 @@ Run `qqa <command> --help` for the full option list.
409409

410410
Every benchmark instance lives on the Hugging Face Hub:
411411

412-
> **Dataset:** [`huggingface.co/datasets/Yuma-Ichikawsa/qqa4co-bench`](https://huggingface.co/datasets/Yuma-Ichikawsa/qqa4co-bench)
412+
> **Dataset:** [`huggingface.co/datasets/Yuma-Ichikawa/qqa4co-bench`](https://huggingface.co/datasets/Yuma-Ichikawa/qqa4co-bench)
413413
> &nbsp;&nbsp;·&nbsp;&nbsp; DISCS (MaxCut / MIS / MaxClique / NormCut) +
414414
> **MaxCut G-set (Helmberg & Rendl 2000, 71 graphs G1-G67 + G70/72/77/81)** +
415415
> Graph Coloring (COLOR) + MIS on d-regular random graphs (PQQA §5.1) +
@@ -751,7 +751,8 @@ Issues and pull requests are welcome. See
751751

752752
## License
753753

754-
BSD-3-Clause — see [`LICENCE.txt`](LICENCE.txt).
754+
BSD-3-Clause-Clear (BSD-3-Clause with an explicit no-patent-grant
755+
clause) — see [`LICENSE`](LICENSE).
755756

756757
## Cite
757758

data/coloring/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,6 @@ Everything below `.gitignore` is re-generated locally by:
3737
python scripts/generate_coloring_instances.py
3838
```
3939

40-
Upstream distribution: `Yuma-Ichikawsa/qqa4co-bench` on the Hugging Face
40+
Upstream distribution: `Yuma-Ichikawa/qqa4co-bench` on the Hugging Face
4141
Hub (same repo as DISCS; see `data/discs/README.md` for credentials /
4242
fallbacks).

data/discs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ make bench-discs SUITE=mis-satlib BACKEND=qqa DEVICE=cuda
3636
That is it. The setup script will:
3737

3838
1. **Download** the prebuilt dataset from the Hugging Face Hub
39-
(`Yuma-Ichikawsa/qqa4co-bench`, override with `DISCS_HF_REPO_ID=...`) —
39+
(`Yuma-Ichikawa/qqa4co-bench`, override with `DISCS_HF_REPO_ID=...`) —
4040
primary source, free, no auth required.
4141
2. **Or fall back** to the original Google Drive tarball
4242
(`DISCS-DATA.tar.gz`, ~6.7 GB) and extract just the `DISCS-DATA/sco/`

data/ea3d/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,5 @@ against this published ground-state reference when available.
4141
python scripts/generate_ea3d_instances.py
4242
```
4343

44-
Upstream distribution: `Yuma-Ichikawsa/qqa4co-bench` on the Hugging Face
44+
Upstream distribution: `Yuma-Ichikawa/qqa4co-bench` on the Hugging Face
4545
Hub.

data/gset/.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# The actual Gset payload (30 MB) lives on Hugging Face
2-
# (`Yuma-Ichikawsa/qqa4co-bench` under `gset/`). Pull it with
2+
# (`Yuma-Ichikawa/qqa4co-bench` under `gset/`). Pull it with
33
# `make bench-all-setup` or `./scripts/setup_benchmarks.sh --only gset`.
44
# The raw Stanford text files downloaded by
55
# `scripts/fetch_gset_data.py` land under `raw/` and are likewise

data/gset/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# MaxCut — G-set benchmark
22

33
**71 graphs**, best-known cuts tracked, hosted on
4-
[`Yuma-Ichikawsa/qqa4co-bench`](https://huggingface.co/datasets/Yuma-Ichikawsa/qqa4co-bench)
4+
[`Yuma-Ichikawa/qqa4co-bench`](https://huggingface.co/datasets/Yuma-Ichikawa/qqa4co-bench)
55
under `gset/`.
66

77
| size | instances | typical n, m |

data/mis-rrg/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,5 @@ solver benchmark. We ship the `n = 10^4` variant here (covers both
4040
the Hugging Face Hub mirror stays lean. Reinstate it by passing
4141
`--nodes 1000000` to `scripts/generate_rrg_instances.py` if needed.
4242

43-
Upstream distribution: `Yuma-Ichikawsa/qqa4co-bench` on the Hugging Face
43+
Upstream distribution: `Yuma-Ichikawa/qqa4co-bench` on the Hugging Face
4444
Hub.

docs/how-to/benchmark.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ No edits to the repo or knowledge of its internals are required.
66

77
Every benchmark instance lives on the Hugging Face Hub:
88

9-
> **[`huggingface.co/datasets/Yuma-Ichikawsa/qqa4co-bench`](https://huggingface.co/datasets/Yuma-Ichikawsa/qqa4co-bench)**
9+
> **[`huggingface.co/datasets/Yuma-Ichikawa/qqa4co-bench`](https://huggingface.co/datasets/Yuma-Ichikawa/qqa4co-bench)**
1010
1111
The dataset bundles the [DISCS](https://arxiv.org/abs/2311.04730) CO
1212
benchmarks (NeurIPS 2023), the **MaxCut G-set** superset (71 graphs,

0 commit comments

Comments
 (0)