qiskit-community / qiskit-machine-learning / 27933409312

90%

push

github

Add Phase of Matter quantum dataset generator (#1044)

* Add Phase of Matter quantum dataset generator

Implements phase_of_matter_data() as a new dataset in
qiskit_machine_learning/datasets/phase_of_matter/:

- Four spin-chain Hamiltonians built via SparsePauliOp (no extra deps):
  heisenberg (trivial/topological), haldane (afm/paramagnetic/spt),
  annni (ferromagnetic/paramagnetic/floating/antiphase),
  cluster (haldane/ferromagnetic/antiferromagnetic/trivial)
- Exact ground states via scipy.sparse.linalg.eigsh (default)
- Optional VQE pathway for hardware-experiment workflows
- Follows existing dataset API: training_size, test_size, one_hot,
  formatting, class_labels, include_sample_total, seed, backend
- 55-test suite covering Hermiticity, normalization, eigenstate
  residuals, phase label coverage, shape contracts, reproducibility

Reference: Bermejo-Vega et al., arXiv:2408.12739 (2024)

* Fix CI: copyright, pylint naming/docstrings/spelling, mypy, import order

- Add STFC copyright header to all 8 new files
- Rename variable H -> ham throughout (C0103 invalid-name)
- Add docstrings to all test methods (C0116 missing-function-docstring)
- Move 'from test import' before third-party imports (C0411 wrong-import-order)
- Add :type backend: object to fix W9016 missing-type-doc in two functions
- Replace British spellings with American: normalised, optimisation, mislabelled
- Replace Greek chars in inline comments with ASCII equivalents
- Add Callable type annotation to _fixed_hamiltonian to fix mypy operator error
- Add domain-specific words to .pylintdict for spell check

* Fix CI round 2: spelling, W9016 type doc, doctest skip

- Add rng, geq, ddt, idata, atol, eigh, zxz, simulatable to .pylintdict
- Fix neighbour/favour -> neighbor/favor in _haldane.py
- Fix parameterised/honoured -> parameterized/honored in test file
- Reword 'RNG' -> 'random number generator' in phase_of_matter.py docstring
- Fix Simulable -> Simulatable in paper reference
- Fix... (continued)

225 of 241 new or added lines in 8 files covered. (93.36%)

5398 of 6011 relevant lines covered (89.8%)

0.9 hits per line