Add documentation about the Qiskit Code Assistant #1931

cbjuan · 2024-09-11T16:05:23Z

1st draft for documentation about the Qiskit Code Assistant. Should fix #1930

Considerations:

Rough draft, feel free to edit or give any feedback
I'm not sure if we should split the documentation in 2 parts: one for JupyterLab extension and another one for the VSCode extension
I'm not sure the where the Qiskit Code Assistant should be placed in the TOC
I added content that depends on Add prompt suggestions for the Qiskit Code Assistant #1918

javabster

Generally looks good! Just a few comments.

Question: do you think it would be better to split the content into 2 pages? one for the vscode extension and one for the jupyter lab extension? I felt like the page is quite long while i was reading and if a reader is only interested in one of the methods theres a lot of redundant info

javabster · 2024-09-11T16:27:41Z

docs/guides/qiskit-code-assistant.mdx

+
+# Qiskit Code Assistant
+
+Improve your quantum computing developer experience and learn best practices for Qiskit and IBM Quantum Platform services with Qiskit Code Assistant!


This first paragraph sounds a bit like a marketing advert, could you adjust the tone a bit to be more documentation style?

javabster · 2024-09-11T16:37:40Z

docs/guides/qiskit-code-assistant.mdx

+
+### Authentication and setup
+
+After installing the extension in VSCode or JupyterLab, the extension will try to authenticate you. By default, the package tries to authenticate to IBM Quantum services with the defined Qiskit API token, and uses your token from the `QISKIT_IBM_TOKEN` environment variable or from the file `~/.qiskit/qiskit-ibm.json` (under the section `default-ibm-quantum`).


do we need to explain to people how to set their api token env var?

javabster · 2024-09-11T16:38:53Z

docs/guides/qiskit-code-assistant.mdx

+
+Jupyterlab also includes a traditional completer than displays suggestion in a context menu rather than inline. This completer can be triggered using `Tab` to run and display the context menu.
+
+The context menu will include suggestions from the default completer in addition to the Qiskit Code Assistant suggestions. The context menu also sanitizes and trims the suggestions, making it less useful for see the code suggestion before inserting it.


beckykd

Thanks for this draft. I'll finish my review tomorrow!

docs/guides/qiskit-code-assistant.mdx

beckykd · 2024-09-12T20:13:15Z

docs/guides/qiskit-code-assistant.mdx

+<Admonition type="note">
+    This is an experimental feature available only to the IBM Quantum Premium Plan.
+    The Qiskit Code Assistant is in preview release status, subject to change.
+    If you have feedback or want to contact the developer team, please use this [Qiskit Slack Workspace channel](https://qiskit.enterprise.slack.com/archives/C07LYA6PL83) or the related public GitHub repositories.


Suggested change

If you have feedback or want to contact the developer team, please use this [Qiskit Slack Workspace channel](https://qiskit.enterprise.slack.com/archives/C07LYA6PL83) or the related public GitHub repositories.

- See the [support page](/support#ibm-quantum-support) to learn how to give feedback or how to contact the development team.

docs/guides/qiskit-code-assistant.mdx

beckykd · 2024-09-12T21:56:45Z

docs/guides/qiskit-code-assistant.mdx

+
+1. Launch Visual Studio Code
+1. Click on the Extensions tab
+1. Search for `qiskit-vscode`


Should I be able to find this? I don't see it in my VS Code.

docs/guides/qiskit-code-assistant.mdx

frankharkins · 2024-09-13T09:18:09Z

...do you think it would be better to split the content into 2 pages? one for the vscode extension and one for the jupyter lab extension?

I think the tabs component could work quite well here

Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>

cbjuan · 2024-09-13T09:37:40Z

...do you think it would be better to split the content into 2 pages? one for the vscode extension and one for the jupyter lab extension?

I think the tabs component could work quite well here

Splitting in tabs

…he model and the QHE benchmark

cbjuan · 2024-09-13T11:58:31Z

Now the guide uses tabs: one giving an overview about the assistant, other two tabs for the extensions. Addressed some other comments and added some videos about how to use it

javabster · 2024-09-13T17:43:39Z

docs/guides/qiskit-code-assistant-vscode.mdx

+---
+
+
+# Use the Qiskit Code Assistant in JupyterLab


This intro looks like its for the jupyter lab page not the vscode page?

…/qiskit-documentation into pr/1931

cbjuan · 2024-09-13T18:12:37Z

I’ll stop editing the files unless you ask for it so I don’t interrupt others

…documentation into add-qiskit-code-assistant

Eric-Arellano

(still reviewing)

docs/guides/qiskit-code-assistant-vscode.mdx

Eric-Arellano · 2024-09-13T21:25:42Z

docs/guides/qiskit-code-assistant-vscode.mdx

+## Contribute to the JupyterLab extension
+
+The code for this official extension is publicly available and open source. Check it out in [github.](https://github.com/Qiskit/qiskit-code-assistant-jupyterlab)


This should be for VSCode, right?

Eric-Arellano · 2024-09-13T21:26:01Z

docs/guides/qiskit-code-assistant-vscode.mdx

+## Next steps
+
+<Admonition type="tip" title="Recommendations">
+    - Check out examples to use the Qiskit Code Assistant for [circuits](https://docs.quantum.ibm.com/guides/circuit-library), [configuring error suppression](https://docs.quantum.ibm.com/guides/configure-error-suppression), and [transpiling with passmanagers.](transpile-with-pass-managers)


This won't be love on Monday morning. Should we remove this section for now?

docs/guides/qiskit-code-assistant-vscode.mdx

beckykd · 2024-09-13T21:29:10Z

docs/guides/qiskit-code-assistant-vscode.mdx

+## Next steps
+
+<Admonition type="tip" title="Recommendations">
+    - Check out examples to use the Qiskit Code Assistant for [circuits](https://docs.quantum.ibm.com/guides/circuit-library), [configuring error suppression](https://docs.quantum.ibm.com/guides/configure-error-suppression), and [transpiling with passmanagers.](transpile-with-pass-managers)


Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>

docs/guides/qiskit-code-assistant-jupyterlab.mdx

Eric-Arellano · 2024-09-13T21:33:13Z

docs/guides/qiskit-code-assistant-jupyterlab.mdx

+
+The code for this extension is publicly available and open source. Check it out in [github.](https://github.com/Qiskit/qiskit-code-assistant-jupyterlab)
+
+## Next steps


Ditto if this should be removed for now?

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>

docs/guides/qiskit-code-assistant-vscode.mdx

docs/guides/qiskit-code-assistant.mdx

Eric-Arellano · 2024-09-13T21:37:55Z

docs/guides/qiskit-code-assistant.mdx

+
+<Admonition type="tip" title="Recommendations">
+    - Install and use the official [JupyterLab](/guides/qiskit-code-assistant-jupyterlab) or [VSCode](/guides/qiskit-code-assistant-vscode) extensions.
+    - Follow examples to use the Qiskit Code Assistant for [circuits](https://docs.quantum.ibm.com/guides/circuit-library), [configuring error suppression](https://docs.quantum.ibm.com/guides/configure-error-suppression), and [transpiling with passmanagers.](transpile-with-pass-managers)


This should be removed for now

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>

cbjuan · 2024-09-13T21:55:34Z

Thank you!! 🙏

1st draft for documentation about the Qiskit Code Assistant. Should fix #1930 Considerations: - Rough draft, feel free to edit or give any feedback - I'm not sure if we should split the documentation in 2 parts: one for JupyterLab extension and another one for the VSCode extension - I'm not sure the where the Qiskit Code Assistant should be placed in the TOC - I added content that depends on #1918 --------- Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com> Co-authored-by: Rebecca Dimock <beckyd@us.ibm.com> Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>

1st draft of documentation for the Qiskit Code Assistant

c95a2c5

cbjuan requested a review from javabster September 11, 2024 16:05

javabster reviewed Sep 11, 2024

View reviewed changes

cbjuan requested review from javabster, abbycross and frankharkins September 11, 2024 16:45

javabster requested a review from beckykd September 12, 2024 14:43

beckykd reviewed Sep 12, 2024

View reviewed changes

cbjuan and others added 2 commits September 13, 2024 11:22

Update docs/guides/qiskit-code-assistant.mdx

ba5ddcf

Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>

Apply suggestions from code review

955a5f2

Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>

Splitting the content in tabs, adding videos and more details about t…

8754970

…he model and the QHE benchmark

Adding details about how to setup the IQP token

ad9fea6

javabster reviewed Sep 13, 2024

View reviewed changes

cbjuan and others added 4 commits September 13, 2024 19:58

Update qiskit-code-assistant-vscode.mdx

6a8efa8

Overview edits

192b179

Merge branch 'add-qiskit-code-assistant' of https://github.com/cbjuan…

a87567a

…/qiskit-documentation into pr/1931

Update qiskit-code-assistant-jupyterlab.mdx

e58b2c8

beckykd and others added 9 commits September 13, 2024 14:09

JupyterLab edits and adding missing eula image

45ec22e

JupyterLab and spelling

f48a296

spelling

9797e6d

VSCode edits

32d43cb

How to generate code using the assistant

9531402

These pages don't fit on any index page

2ed1623

Fix syntax

f739c22

edit

3591f26

Fix image links

c4087f1

Eric-Arellano added 2 commits September 13, 2024 17:12

Merge branch 'add-qiskit-code-assistant' of github.com:cbjuan/qiskit-…

73c2718

…documentation into add-qiskit-code-assistant

Fix watsonx link

e5c7e50

Eric-Arellano reviewed Sep 13, 2024

View reviewed changes

beckykd reviewed Sep 13, 2024

View reviewed changes

Apply suggestions from code review

078514b

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>

Eric-Arellano reviewed Sep 13, 2024

View reviewed changes

beckykd and others added 2 commits September 13, 2024 16:34

Examples won't be live on Monday. Will add back in as an update

a392c30

Apply suggestions from code review

5d03588

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>

Eric-Arellano reviewed Sep 13, 2024

View reviewed changes

Apply suggestions from code review

2e63521

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>

Eric-Arellano approved these changes Sep 13, 2024

View reviewed changes

beckykd and others added 3 commits September 13, 2024 16:45

make bullets parallel

f59b699

Update docs/guides/qiskit-code-assistant-vscode.mdx

1793252

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>

Apply suggestions from code review

6a96d00

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>

Eric-Arellano added this pull request to the merge queue Sep 13, 2024

Eric-Arellano removed this pull request from the merge queue due to a manual request Sep 13, 2024

beckykd added this pull request to the merge queue Sep 13, 2024

Merged via the queue into Qiskit:main with commit 3d4b933 Sep 13, 2024
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation about the Qiskit Code Assistant #1931

Add documentation about the Qiskit Code Assistant #1931

cbjuan commented Sep 11, 2024

javabster left a comment

javabster Sep 11, 2024

javabster Sep 11, 2024

javabster Sep 11, 2024

beckykd left a comment

beckykd Sep 12, 2024

beckykd Sep 12, 2024

frankharkins commented Sep 13, 2024

cbjuan commented Sep 13, 2024

cbjuan commented Sep 13, 2024

javabster Sep 13, 2024

cbjuan commented Sep 13, 2024

Eric-Arellano left a comment

Eric-Arellano Sep 13, 2024

Eric-Arellano Sep 13, 2024

beckykd Sep 13, 2024

beckykd Sep 13, 2024

Eric-Arellano Sep 13, 2024

Eric-Arellano Sep 13, 2024

cbjuan commented Sep 13, 2024


		# Qiskit Code Assistant

		Improve your quantum computing developer experience and learn best practices for Qiskit and IBM Quantum Platform services with Qiskit Code Assistant!


		### Authentication and setup

		After installing the extension in VSCode or JupyterLab, the extension will try to authenticate you. By default, the package tries to authenticate to IBM Quantum services with the defined Qiskit API token, and uses your token from the `QISKIT_IBM_TOKEN` environment variable or from the file `~/.qiskit/qiskit-ibm.json` (under the section `default-ibm-quantum`).


		Jupyterlab also includes a traditional completer than displays suggestion in a context menu rather than inline. This completer can be triggered using `Tab` to run and display the context menu.

		The context menu will include suggestions from the default completer in addition to the Qiskit Code Assistant suggestions. The context menu also sanitizes and trims the suggestions, making it less useful for see the code suggestion before inserting it.

	If you have feedback or want to contact the developer team, please use this [Qiskit Slack Workspace channel](https://qiskit.enterprise.slack.com/archives/C07LYA6PL83) or the related public GitHub repositories.
	- See the [support page](/support#ibm-quantum-support) to learn how to give feedback or how to contact the development team.

		## Contribute to the JupyterLab extension

		The code for this official extension is publicly available and open source. Check it out in [github.](https://github.com/Qiskit/qiskit-code-assistant-jupyterlab)


		The code for this extension is publicly available and open source. Check it out in [github.](https://github.com/Qiskit/qiskit-code-assistant-jupyterlab)

		## Next steps

Add documentation about the Qiskit Code Assistant #1931

Add documentation about the Qiskit Code Assistant #1931

Conversation

cbjuan commented Sep 11, 2024

javabster 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

beckykd left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

frankharkins commented Sep 13, 2024

cbjuan commented Sep 13, 2024

cbjuan commented Sep 13, 2024

Choose a reason for hiding this comment

cbjuan commented Sep 13, 2024

Eric-Arellano 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

cbjuan commented Sep 13, 2024