Update doc and add warning message to support future Q# flow deprecation #7088
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
️✔️Azure CLI Extensions Breaking Change Test
|
|
Hi @shenyingjun, |
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
Co-authored-by: Xinyi Joffre <[email protected]>
kairu-ms
approved these changes
Jan 3, 2024
|
@shenyingjun, please fix the CI linter issues. Thanks. |
ddouglas-msft
pushed a commit
to ddouglas-msft/azure-cli-extensions
that referenced
this pull request
Jan 10, 2024
…ion (Azure#7088) * Update doc and add warning message to support future Q# flow deprecation * Update src/quantum/azext_quantum/_help.py Co-authored-by: Xinyi Joffre <[email protected]> --------- Co-authored-by: Xinyi Joffre <[email protected]>
| @@ -36,13 +36,13 @@ def load_arguments(self, _): | |||
| storage_account_name_type = CLIArgumentType(options_list=['--storage-account', '-a'], help='Name of the storage account to be used by a quantum workspace.') | |||
| program_args_type = CLIArgumentType(nargs='*', help='List of arguments expected by the Q# operation specified as --name=value after `--`.') | |||
| target_id_type = CLIArgumentType(options_list=['--target-id', '-t'], help='Execution engine for quantum computing jobs. When a workspace is configured with a set of providers, they each enable one or more targets. You can configure the default target using `az quantum target set`.', configured_default='target_id') | |||
| project_type = CLIArgumentType(help='The location of the Q# project to submit. Defaults to current folder.') | |||
| project_type = CLIArgumentType(help='[Becoming deprecated] The location of the Q# project to submit. Defaults to current folder.') | |||
There was a problem hiding this comment.
Suggested change
| project_type = CLIArgumentType(help='[Becoming deprecated] The location of the Q# project to submit. Defaults to current folder.') | |
| project_type = CLIArgumentType(help='[Deprecated] The folder path of the Q# project to submit. Defaults to current folder.') |
I wonder if we can just mark as deprecated already, but allow users to still submit to it
| job_name_type = CLIArgumentType(help='A friendly name to give to this run of the program.') | ||
| job_id_type = CLIArgumentType(options_list=['--job-id', '-j'], help='Job unique identifier in GUID format.') | ||
| job_params_type = CLIArgumentType(options_list=['--job-params'], help='Job parameters passed to the target as a list of key=value pairs, json string, or `@{file}` with json content.', action=JobParamsAction, nargs='+') | ||
| target_capability_type = CLIArgumentType(options_list=['--target-capability'], help='Target-capability parameter passed to the compiler.') | ||
| shots_type = CLIArgumentType(help='The number of times to run the Q# program on the given target.') | ||
| no_build_type = CLIArgumentType(help='If specified, the Q# program is not built before submitting.') | ||
| no_build_type = CLIArgumentType(help='[Becoming deprecated] If specified, the Q# program is not built before submitting.') |
There was a problem hiding this comment.
Suggested change
| no_build_type = CLIArgumentType(help='[Becoming deprecated] If specified, the Q# program is not built before submitting.') | |
| no_build_type = CLIArgumentType(help='[Deprecated] If specified, the Q# program is not built before submitting.') |
| @@ -464,7 +469,7 @@ def _submit_qsharp(cmd, program_args, resource_group_name, workspace_name, locat | |||
| """ | |||
| Submit a Q# project to run on Azure Quantum. | |||
| """ | |||
|
|
|||
| _show_warning('The direct submission of Q# programs will soon be deprecated. Instead, you can submit QIR bitcode or LLVM. Modern QDK can be used to generate LLVM from Q#.') | |||
There was a problem hiding this comment.
Suggested change
| _show_warning('The direct submission of Q# programs will soon be deprecated. Instead, you can submit QIR bitcode or LLVM. Modern QDK can be used to generate LLVM from Q#.') | |
| _show_warning('The direct submission of Q# project folders will soon be fully deprecated. Instead, you can submit QIR bitcode or human-readable LLVM code. Modern QDK can be used to generate human-readable LLVM code from Q#.') |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This checklist is used to make sure that common guidelines for a pull request are followed.
Related command
General Guidelines
azdev style <YOUR_EXT>locally? (pip install azdevrequired)python scripts/ci/test_index.py -qlocally? (pip install wheel==0.30.0required)For new extensions:
About Extension Publish
There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update
src/index.jsonautomatically.You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify
src/index.json.