Skip to content

fix(#43): correct README Quick Start parameter names and API references #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Manideep3969 merged 1 commit into from
Aug 18, 2026
Merged

fix(#43): correct README Quick Start parameter names and API references #94

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ backend = FakeBrisbane()

compiler = QCompiler(backend=backend)
config = OptimizerConfig(
gate_fusion=True,
scheduling_method="coherence_aware",
error_mitigation=True,
circuit_cutting=True,
fusion=True,
scheduling="coherence_aware",
mitigation="adaptive",
cutting=True,
autotune=True,
)
result = compiler.optimize(qc, config=config)
Expand All @@ -72,9 +72,9 @@ print(f"Passes applied: {result.passes_applied}")
Unified error estimation using device calibration data. Provides `DeviceCharacterization`, `CircuitMetrics`, and `ErrorBreakdown` dataclasses.

```python
from qc_compiler import CostModel, DeviceCharacterization
from qc_compiler import CostModel

model = CostModel(DeviceCharacterization.from_backend(backend))
model = CostModel(backend=backend)
breakdown = model.estimate_fidelity(circuit)
print(breakdown)
```
Expand All @@ -88,7 +88,8 @@ from qc_compiler import GateFusion

fusion = GateFusion(cost_model=model)
result = fusion.optimize(circuit)
print(f"Gate reduction: {result.gate_reduction_pct:.1f}%")
gate_reduction = 1 - result.total_gates_after / max(result.total_gates_before, 1)
print(f"Gate reduction: {gate_reduction:.1%}")
```

### Circuit Cutting (`cutting.py`)
Expand Down Expand Up @@ -124,7 +125,8 @@ from qc_compiler import CoherenceAwareScheduler

scheduler = CoherenceAwareScheduler(cost_model=model)
result = scheduler.schedule(circuit, method="coherence_aware")
print(f"Idle time reduction: {result.idle_time_avg:.1f}%")
fidelity_improvement = result.estimated_fidelity_optimized - result.estimated_fidelity_asap
print(f"Fidelity improvement: {fidelity_improvement:.4f}")
```

### Circuit Batching (`batching.py`)
Expand All @@ -136,7 +138,7 @@ from qc_compiler import CircuitBatcher

batcher = CircuitBatcher(cost_model=model)
plan = batcher.create_batch_plan(circuits)
print(f"Batches: {len(plan.batches)}")
print(f"Batches: {plan.num_batches}")
```

### AutoTuner (`autotuning.py`)
Expand All @@ -159,7 +161,7 @@ Composes all six passes into a single optimization pipeline with configurable en
from qc_compiler import QCompiler, OptimizerConfig

compiler = QCompiler(backend=backend)
config = OptimizerConfig(gate_fusion=True, circuit_cutting=True)
config = OptimizerConfig(fusion=True, cutting=True)
result = compiler.optimize(circuit, config=config)
```

Expand All @@ -177,7 +179,7 @@ src/qc_compiler/
autotuning.py # Hardware-aware autotuning
transpiler.py # QCompiler pipeline
utils.py # Shared utilities
tests/ # 234 tests
tests/ # 316 tests
notebooks/ # Validation notebooks (01-08)
docs/
notes/ # Research notes and paper outline
Expand Down
Loading