Skip to content

[QI2-1613] Fix outdated docs #35

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
merged 2 commits into from
May 27, 2025
Merged

[QI2-1613] Fix outdated docs #35

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
27b0e1b
Update docs
Mythir May 26, 2025
275e9fb
Add supports raw data field
Mythir May 27, 2025
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
11 changes: 2 additions & 9 deletions docs/request/meta.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,11 @@ This message does not require any additional information in the payload section.
"Y"
],
"starttime": 1690061619.610174,
"supports_raw_data": true,
"default_compiler_config": {
"decomposition": [
{
"path": "opensquirrel.decomposer.mckay_decomposer.McKayDecomposer",
"path": "opensquirrel.passes.decomposer.mckay_decomposer.McKayDecomposer",
"method": "decompose",
"arguments": {}
}
Expand All @@ -80,14 +81,6 @@ library. The config is represented as a dict and defines for each _stage_, a lis
that should be performed in the stage. Each pass includes settings such as the pass _name_, corresponding _method_
invoked by opensquirrel and additional keyword arguments.

Currently, the following stages are supported:

* `decomposition`:
* `path`: `opensquirrel.<path_to_decomposer_class>`.
See the _decomposers_ listed in [the opensquirrel docs](https://qutech-delft.github.io/OpenSquirrel/reference).
* `method`: `decompose`
* `arguments`: arguments expected for the initialization of the decomposer class.

If no `default_compiler_config` is provided, there will be **no** pre-processing steps applied to the circuit.
The backend will receive the cQASM string the same way it was provided by the user.

Expand Down