Repository navigation
Docs: align examples with SuperQuantX 0.3.0 APIs - #6
Merged
Merged
Conversation
Rewrite stale docs and README-adjacent examples to the real 0.3.0 surface (add_gate/execute_circuit, QuantumNN, FeatureMapSpec, Ocean QUBO helpers). Add scripts/check_docs_examples.py to extract and run Python fences; mark credential-only hardware snippets with docs-check skip. mkdocs build --strict passes; 267 blocks run with 0 failures (21 skipped).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
add_gate/execute_circuit, simulator fluent API where it exists,QuantumNNinstead of invented classifiers,FeatureMapSpec+build_feature_map_circuit, Ocean QUBO/Ising helpers.scripts/check_docs_examples.pyto extract and execute Python fences (shared namespace per page;<!-- docs-check: skip -->for credential-only hardware). Not wired into CI: full run is ~5 minutes with ML examples.VariationalQuantumClassifier, callable feature-map specs,OceanBackend.solve_tsp, brokenbenchmark_algorithmbackend-name assumption).Verification
python scripts/check_docs_examples.py: 267 blocks run, 0 failed, 21 skipped (plus 40 doc tests under pytest).uv run mkdocs build --strict: passes.Notes