Fix readme

README.md

@@ -1,64 +1,63 @@
 ---
 license: apache-2.0
 ---
-# Linear Function Quantum Synthesis Circuit Models
+# Permutation Quantum Synthesis Circuit Models
 
 ## Introduction
-This repository hosts models for linear function synthesis in quantum circuits trained with RL techniques. The models are specialized for different topologies up to 10 qubits. 
+This repository hosts models for permutation synthesis in quantum circuits trained with RL techniques. The models are specialized for different topologies and qubit counts.
 
-A linear function over n qubits is an n×n binary transformation on X/Z operators (the reversible linear part of a Clifford). Implementing it means finding CX/SWAP-based circuits whose action matches that binary map.
-
-For each model, there is the environment configs (`.json`) and the trained policy weights (`.safetensors`).
+Permutation circuits rearrange computational basis states according to an n-element permutation (one per qubit in binary encoding) using SWAP gates constrained by the device topology.
 
+For each model, there is the environment config (`.json`) and the trained policy weights (`.safetensors`).
 
 ## Scope
-- Linear-function synthesis models.
+- Permutation synthesis models only.
 - Each model is tied to a specific qubit count and topology; use the matching pair for your target device/layout. To discover the specific topology for each model see the `gateset` property in the model's config.
 
 ## Contents
-- `linear_function_*.json`: model configs for a given qubit count/topology.
+- `permutation_*.json`: model configs for a given qubit count/topology.
 - Matching `.safetensors` files: trained policies for each JSON (same filename stem).
 
-
 ## Training
 
 Training data is entirely synthetic and generated internally at IBM Quantum using custom reinforcement learning environments built on [Qiskit-Gym](https://github.com/AI4quantum/qiskit-gym).
 
-**Data Collection:** Target operators are generated by sampling random linear-reversible circuits with CNOT gates consistent with the target coupling map. The number of gates scales with the difficulty, which increase when the model learns to solve circuits at that difficulty. No external datasets or third-party circuit repositories are used.
+**Data Collection:** Random permutation operators are generated by composing random SWAP sequences consistent with the target coupling map. The number of gates scales with the difficulty, which increase when the model learns to solve circuits at that difficulty. No external datasets or third-party circuit repositories are used.
 
 **PII:** No personal or sensitive data is present or used in any phase of training, as all data is synthetic and generated algorithmically.
 
 **Infrastructure:** We train the models using IBM's Cognitive Computing Cluster (CCC) using NVIDIA A100 40GB GPUs. The cluster provides a scalable and efficient infrastructure for training.
 
-
 ## Usage example
 
-Here we provide a code snippet to synthesis a random 10qL linear function. In addition to the model we use the `qiskit-gym` ([repo](https://github.com/AI4quantum/qiskit-gym)) and `twisteRL` ([repo](https://github.com/AI4quantum/twisteRL)) libraries, as well as `qiskit`. You can install all needed libraries running `pip install qiskit-gym` in your python virutal environment.
+Below is a snippet to synthesize a random 10-qubit permutation. We use `qiskit-gym` ([repo](https://github.com/AI4quantum/qiskit-gym)), `twisteRL` ([repo](https://github.com/AI4quantum/twisteRL)), and `qiskit`. Install dependencies via `pip install qiskit-gym` in your virtual environment.
 
 ```python
 from qiskit_gym.rl import RLSynthesis
-
 from twisterl.utils import pull_hub_algorithm
-
-from qiskit.circuit.library import LinearFunction
-from qiskit.synthesis.linear.linear_matrix_utils import random_invertible_binary_matrix
+from qiskit.circuit.library import Permutation
+import numpy as np
 
 local_path = pull_hub_algorithm(
-    repo_id="Qiskit/ai-transpiler_linear-functions",
+    repo_id="Qiskit/ai-transpiler_permutations",
     model_path="./models",
     revision="main",
-    validate=True
+    validate=True,
 )
 
 if not local_path:
     raise ValueError("Failed to download model from hub")
 
-num_qubits = 10
-matrix = random_invertible_binary_matrix(num_qubits, seed=42)
-input_lf = LinearFunction(matrix)
-rls = RLSynthesis.from_config_json(f"{local_path}/linear_function_10qL.json", f"{local_path}/linear_function_10qL.safetensors")
-qc_lf_output = rls.synth(input_lf, num_searches=10, num_mcts_searches=0, deterministic=False)
-print(qc_lf_output)
+num_qubits = 12
+seed = 42
+input_perm = np.random.default_rng(seed).permutation(num_qubits).tolist()
+
+rls = RLSynthesis.from_config_json(
+    f"{local_path}/permutation_12qO.json",
+    f"{local_path}/permutation_12qO.safetensors",
+)
+qc_perm_output = rls.synth(input_perm, num_searches=10, num_mcts_searches=0, deterministic=False)
+print(qc_perm_output)
 ```
 
 <!-- MODEL_INDEX_START -->
@@ -68,38 +67,13 @@ Below is the list of available models with qubit counts and topologies:
 
 | Model | Qubits | Topology |
 | --- | --- | --- |
-| [`linear_function_2qL`](linear_function_2qL.md) | 2 | L |
-| [`linear_function_3qL`](linear_function_3qL.md) | 3 | L |
-| [`linear_function_4qL`](linear_function_4qL.md) | 4 | L |
-| [`linear_function_4qY`](linear_function_4qY.md) | 4 | Y |
-| [`linear_function_5qL`](linear_function_5qL.md) | 5 | L |
-| [`linear_function_5qT`](linear_function_5qT.md) | 5 | T |
-| [`linear_function_6qL`](linear_function_6qL.md) | 6 | L |
-| [`linear_function_6qT`](linear_function_6qT.md) | 6 | T |
-| [`linear_function_6qY`](linear_function_6qY.md) | 6 | Y |
-| [`linear_function_7qF`](linear_function_7qF.md) | 7 | F |
-| [`linear_function_7qH`](linear_function_7qH.md) | 7 | H |
-| [`linear_function_7qL`](linear_function_7qL.md) | 7 | L |
-| [`linear_function_7qT`](linear_function_7qT.md) | 7 | T |
-| [`linear_function_7qY`](linear_function_7qY.md) | 7 | Y |
-| [`linear_function_8qF`](linear_function_8qF.md) | 8 | F |
-| [`linear_function_8qJ`](linear_function_8qJ.md) | 8 | J |
-| [`linear_function_8qL`](linear_function_8qL.md) | 8 | L |
-| [`linear_function_8qT1`](linear_function_8qT1.md) | 8 | T1 |
-| [`linear_function_8qT2`](linear_function_8qT2.md) | 8 | T2 |
-| [`linear_function_8qY`](linear_function_8qY.md) | 8 | Y |
-| [`linear_function_9qF1`](linear_function_9qF1.md) | 9 | F1 |
-| [`linear_function_9qF2`](linear_function_9qF2.md) | 9 | F2 |
-| [`linear_function_9qH1`](linear_function_9qH1.md) | 9 | H1 |
-| [`linear_function_9qH2`](linear_function_9qH2.md) | 9 | H2 |
-| [`linear_function_9qH3`](linear_function_9qH3.md) | 9 | H3 |
-| [`linear_function_9qJ`](linear_function_9qJ.md) | 9 | J |
-| [`linear_function_9qL`](linear_function_9qL.md) | 9 | L |
-| [`linear_function_9qT1`](linear_function_9qT1.md) | 9 | T1 |
-| [`linear_function_9qT2`](linear_function_9qT2.md) | 9 | T2 |
-| [`linear_function_9qY`](linear_function_9qY.md) | 9 | Y |
-| [`linear_function_10qL`](linear_function_10qL.md) | 10 | L |
+| [`permutation_8qL`](model_data/permutation_8qL.md) | 8 | L |
+| [`permutation_12qO`](model_data/permutation_12qO.md) | 12 | O |
+| [`permutation_27q`](model_data/permutation_27q.md) | 27 | HEX |
+| [`permutation_33q`](model_data/permutation_33q.md) | 33 | HEX |
+| [`permutation_65q`](model_data/permutation_65q.md) | 65 | HEX |
 <!-- MODEL_INDEX_END -->
 
 ## Acknowledgements
-The authors acknowledge the IBM Research CCC Service for providing resources that have contributed to the production or processing of the data contained within this data collection.
+The authors acknowledge the IBM Research CCC Service for providing resources that have contributed to the production or processing of the data contained within this data collection.
+