Fleshing out some conceptual guidelines #25

bettinaheim · 2022-09-10T00:29:13Z

No description provided.

Co-authored-by: Steve Manuel <nilslice@gmail.com>

… into base-profile

…e workstream meeting

…ubit and result usage

…dule flags

Co-authored-by: Henrique Silvério <henrique.silverio@tecnico.ulisboa.pt>

Co-authored-by: Alec Edgington <54802828+cqc-alec@users.noreply.github.com>

Co-authored-by: Thomas Alexander <thomasalexander2718@gmail.com>

… into base-profile

…itting measurements into their own block

…marked by an attribute

github-actions · 2022-09-10T00:29:24Z

CLA Assistant Lite bot:
Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.

I have read the Contributor License Agreement and I hereby accept the Terms.

2 out of 3 committers have signed the CLA.
✅ @bettinaheim
✅ @idavis
❌ @Bettina Heim
Bettina Heim seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You can retrigger this bot by commenting recheck in this Pull Request}

bettinaheim · 2022-09-10T00:41:29Z

I have read the Contributor License Agreement and I hereby accept the Terms.

* Adding output schemas. * Adding grammars for output files. * Adding notes for implementors. Co-authored-by: César Zaragoza Cortés <cesarzc@microsoft.com> Co-authored-by: Amos Anderson <45039789+qci-amos@users.noreply.github.com>

cesarzc · 2023-08-31T15:57:49Z

specification/under_development/output_schemas/Notes_For_Implementors.md

+```console
+START
+METADATA        entry_point
+METADATA        num_required_qubits     5


I believe this should be required_num_qubits instead of num_required_qubits.

cesarzc · 2023-08-31T16:05:02Z

specification/under_development/output_schemas/Notes_For_Implementors.md

+START
+METADATA        entry_point
+METADATA        num_required_qubits     5
+METADATA        num_required_results    5


Similarly, this should be required_num_results instead of num_required_results.

bmhowe23

I have a few comments and questions about the output specifications (and a few comments about num_required_* vs required_num_*).

bmhowe23 · 2023-08-31T19:12:58Z

specification/under_development/output_schemas/Labeled_And_Async.md

+START
+METADATA\tentry_point
+METADATA\tnum_required_qubits\t5
+METADATA\tnum_required_results\t5


To be consistent with the Base Profile documentation, I believe this should be required_num_qubits instead of num_required_qubits and required_num_results instead of num_required_results.

bmhowe23 · 2023-08-31T19:13:11Z

specification/under_development/output_schemas/No_Labels_And_Ordered.md

+METADATA\tuser_metadata3_name\tuser_metadata3_value
+METADATA\tentry_point
+METADATA\tnum_required_qubits\t5
+METADATA\tnum_required_results\t5


To be consistent with the Base Profile documentation, I believe this should be required_num_qubits instead of num_required_qubits and required_num_results instead of num_required_results.

bmhowe23 · 2023-08-31T19:13:36Z

specification/under_development/output_schemas/Notes_For_Implementors.md

+START
+METADATA        entry_point
+METADATA        num_required_qubits     5
+METADATA        num_required_results    5


To be consistent with the Base Profile documentation, I believe this should be required_num_qubits instead of num_required_qubits and required_num_results instead of num_required_results.

bmhowe23 · 2023-08-31T19:13:41Z

specification/under_development/output_schemas/Notes_For_Implementors.md

+START
+METADATA        entry_point
+METADATA        num_required_qubits     5
+METADATA        num_required_results    5


To be consistent with the Base Profile documentation, I believe this should be required_num_qubits instead of num_required_qubits and required_num_results instead of num_required_results.

bmhowe23 · 2023-08-31T19:13:49Z

specification/under_development/output_schemas/Notes_For_Implementors.md

+START
+METADATA        entry_point
+METADATA        num_required_qubits     5
+METADATA        num_required_results    5


To be consistent with the Base Profile documentation, I believe this should be required_num_qubits instead of num_required_qubits and required_num_results instead of num_required_results.

bmhowe23 · 2023-08-31T19:20:26Z

specification/under_development/output_schemas/Notes_For_Implementors.md

+METADATA        entry_point
+METADATA        num_required_qubits     5
+METADATA        num_required_results    5
+METADATA        output_labeling_schema


Should this also contain the value of the "output_labeling_schema" attribute? Like this:

Suggested change

METADATA output_labeling_schema

METADATA output_labeling_schema No_Labels_And_Async

bmhowe23 · 2023-08-31T19:21:41Z

specification/under_development/output_schemas/Notes_For_Implementors.md

+
+declare void @__quantum__rt__result_record_output(%Result*, i8*)
+
+attributes #0 = { "entry_point" "num_required_qubits"="5" "num_required_results"="5" "output_labeling_schema" "qir_profiles"="base_profile" }


To be consistent with prior examples in the Base Profile documentation, I believe output_labeling_schema needs to be set to some value, like this:

Suggested change

attributes #0 = { "entry_point" "num_required_qubits"="5" "num_required_results"="5" "output_labeling_schema" "qir_profiles"="base_profile" }

attributes #0 = { "entry_point" "num_required_qubits"="5" "num_required_results"="5" "output_labeling_schema"="No_Labels_And_Ordered" "qir_profiles"="base_profile" }

bmhowe23 · 2023-08-31T19:27:10Z

specification/under_development/profiles/Base_Profile.md

+backend. A backend may reject a program as invalid or fail execution if a label
+is missing.
+
+Both the labeling schema and the output schema are identified by a metadata


I only see the output_labeling_schema attribute defined, but this comment makes it seem like there should be another attribute for the output schema. Am I misinterpreting that? (Note that lines 338-339 say that output_labeling_schema is for the labeling schema (and hence not the output schema, presumably).

bmhowe23 · 2023-08-31T19:39:01Z

specification/under_development/profiles/Base_Profile.md

+The defined [output schemas](../output_schemas/) provide different options for
+how a backend may express the computed value(s). The exact schema can be freely
+chosen by the backend and is identified by a string label in the produced
+schema. Each output schema contains sufficient information to allow quantum


Perhaps I'm having a disconnect here, but Line 416 says that the "output_labeling_schema" attribute value can be freely chosen by the compiler frontend, but this comment makes it sound like the backend is deciding on the schema. In either case, is it freely chosen from a set of limit output options (like Labeled_And_Async and No_Labels_And_Ordered)? If so, I think those options should probably enumerated in a table. If not, then it seems like it is an arbitrary string that the front-end can choose, but then the backend may not know what to do with that attribute value.

bmhowe23 · 2023-08-31T19:40:12Z

specification/under_development/profiles/Base_Profile.md

+
+Both the labeling schema and the output schema are identified by a metadata
+entry in the produced output. For the [output schema](../output_schemas/), that
+identifier matches the one listed in the corresponding specification. The


I don't see the explicit identifier strings for the output schemas called out in the corresponding specifications. Am I just missing them?

Bettina Heim and others added 30 commits June 16, 2022 18:19

early outline for a Base Profile for the purpose of discussion

f7fd147

Update specification/under_development/Base-Profile.md

a4f09dd

Co-authored-by: Steve Manuel <nilslice@gmail.com>

addressing some comments

f60a183

Merge branch 'base-profile' of https://github.com/qir-alliance/qir-spec…

745393e

… into base-profile

initial commit for the definition of known quantum instructions

5977122

different version of the qis table

3c1c44e

removing the address space 2

413788c

revising output recording functions

1d30c9b

some thoughts around output

6f399aa

more thoughts

1f5d4cd

minor edits

a7e7132

some more details on the output

2959ffb

add output labels

8fa9d27

starting to flesh out more details about targeting and QIS resolution

07ad6bd

adding a couple of stages for clarity

66ab969

adding bullet points with the three requirements we fleshed out in th…

bf90edf

…e workstream meeting

just adding a small not so I don't forget

542f2fd

minor updates to common instructions

050dc86

outlining some thoughts around the linking stage and qis resolution

b32b3d8

formatting

56bf816

more formatting

bdfc361

fleshing out the introduction and updating the example

74e8964

finishing the profile section and updating the program structure section

a171784

module flags seems like a good option for versioning and indicating q…

6630e36

…ubit and result usage

let's make this two flags

0c59756

almost done with the attributes, and started to write a section on mo…

b348dd8

…dule flags

adding more details to the module flags section

2462e03

finished the module flags section

8b348c5

finishing the attributes section

67eefaa

finished the sections on data types and values, as well as on the QIS

967087b

bettinaheim and others added 20 commits August 9, 2022 11:26

addressing comments

a3a779b

Update specification/under_development/profiles/Base_Profile.md

3b982f2

Co-authored-by: Henrique Silvério <henrique.silverio@tecnico.ulisboa.pt>

Update specification/under_development/profiles/Base_Profile.md

a2f4093

Co-authored-by: Alec Edgington <54802828+cqc-alec@users.noreply.github.com>

Update specification/under_development/profiles/Base_Profile.md

0ef8d5b

Co-authored-by: Alec Edgington <54802828+cqc-alec@users.noreply.github.com>

Update specification/under_development/profiles/Base_Profile.md

a84526b

Co-authored-by: Alec Edgington <54802828+cqc-alec@users.noreply.github.com>

Update specification/under_development/profiles/Base_Profile.md

be56184

Co-authored-by: Alec Edgington <54802828+cqc-alec@users.noreply.github.com>

Update specification/under_development/profiles/Base_Profile.md

666855f

Co-authored-by: Alec Edgington <54802828+cqc-alec@users.noreply.github.com>

addressing some comments

110846a

addressed most of the comments

8fc659f

Update specification/under_development/Compilation_And_Targeting.md

0963ce4

Co-authored-by: Thomas Alexander <thomasalexander2718@gmail.com>

addressing some of the remaining comments

96b3685

Merge branch 'base-profile' of https://github.com/qir-alliance/qir-spec…

468e60e

… into base-profile

now the only thing that isn't addressed is the question regarding spl…

7051641

…itting measurements into their own block

forgot to update the block predecessors

88b8be0

make the entry point have four blocks and require measurements to be …

719c61d

…marked by an attribute

minor rephrasing

1d7c4c9

minor edits

52cbea1

restructuring and some clean up

b173cc1

Merge branch 'main' into conceptual

43abafc

Merge branch 'main' into conceptual

2f44980

bettinaheim and others added 2 commits September 26, 2022 14:17

adding a note

6410fc9

Adding output schemas (#32)

007e98a

* Adding output schemas. * Adding grammars for output files. * Adding notes for implementors. Co-authored-by: César Zaragoza Cortés <cesarzc@microsoft.com> Co-authored-by: Amos Anderson <45039789+qci-amos@users.noreply.github.com>

cesarzc reviewed Aug 31, 2023

View reviewed changes

bmhowe23 reviewed Aug 31, 2023

View reviewed changes

idavis mentioned this pull request Sep 26, 2023

Misnamed Function Attributes (required_num_* vs num_required_*) qir-alliance/pyqir#250

Closed

bettinaheim and others added 2 commits September 28, 2023 18:08

Merge branch 'main' into spec_update

57c1a18

removing outdated profile diff

365efe3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fleshing out some conceptual guidelines #25

Fleshing out some conceptual guidelines #25

bettinaheim commented Sep 10, 2022

github-actions bot commented Sep 10, 2022 •

edited

Loading

bettinaheim commented Sep 10, 2022

cesarzc Aug 31, 2023

cesarzc Aug 31, 2023

bmhowe23 left a comment

bmhowe23 Aug 31, 2023

bmhowe23 Aug 31, 2023

bmhowe23 Aug 31, 2023

bmhowe23 Aug 31, 2023

bmhowe23 Aug 31, 2023

bmhowe23 Aug 31, 2023

bmhowe23 Aug 31, 2023

bmhowe23 Aug 31, 2023

bmhowe23 Aug 31, 2023

bmhowe23 Aug 31, 2023

	METADATA output_labeling_schema
	METADATA output_labeling_schema No_Labels_And_Async


		declare void @__quantum__rt__result_record_output(%Result, i8)

		attributes #0 = { "entry_point" "num_required_qubits"="5" "num_required_results"="5" "output_labeling_schema" "qir_profiles"="base_profile" }

Fleshing out some conceptual guidelines #25

Are you sure you want to change the base?

Fleshing out some conceptual guidelines #25

Conversation

bettinaheim commented Sep 10, 2022

github-actions bot commented Sep 10, 2022 • edited Loading

bettinaheim commented Sep 10, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bmhowe23 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Sep 10, 2022 •

edited

Loading