Skip to content

Update branding to Microsoft Quantum Development Kit #2438

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.

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
cff-version: 1.2.0
message: "If you use this software in your work, please cite it using the following metadata"
title: "Azure Quantum Development Kit"
title: "Microsoft Quantum Development Kit"
repository-code: "https://github.com/microsoft/qsharp"
license: MIT
year: 2024
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Azure Quantum Development Kit
# Microsoft Quantum Development Kit

Welcome to the Azure Quantum Development Kit!
Welcome to the Microsoft Quantum Development Kit!

This repository contains tooling for the Q# language, specifically:

Expand All @@ -12,7 +12,7 @@ This repository contains tooling for the Q# language, specifically:
- **[npm](./npm/)**: Q# npm package
- **[pip](./pip/)**: Q# Python pip package
- **[playground](./playground/)**: simple website for interacting with Q#
- **[resource_estimator](./resource_estimator)**: Implementation for the Azure Quantum Resource Estimator
- **[resource_estimator](./resource_estimator)**: Implementation for the Microsoft Quantum Resource Estimator
- **[vscode](./vscode/)**: Visual Studio Code extension
- **[wasm](./wasm/)**: The bindings and logic for the WebAssembly module
- **[widgets](./widgets)**: The Q# Jupyter widgets Python package
Expand Down Expand Up @@ -83,15 +83,15 @@ environment variables, for example `RUST_LOG=debug ./target/release/qsc ./sample

## Citation

If you use Q#, Azure Quantum Development Kit, or Azure Quantum Resource Estimator, please cite as follows:
If you use Q#, Microsoft Quantum Development Kit, or Microsoft Quantum Resource Estimator, please cite as follows:

- Azure Quantum Development Kit:
- Microsoft Quantum Development Kit:

```bibtex
@software{Microsoft_Azure_Quantum_Development,
@software{Microsoft_Quantum_Development_Kit,
author = {{Microsoft}},
license = {MIT},
title = {{Azure Quantum Development Kit}},
title = {{Microsoft Quantum Development Kit}},
url = {https://github.com/microsoft/qsharp} }
```

Expand All @@ -109,7 +109,7 @@ If you use Q#, Azure Quantum Development Kit, or Azure Quantum Resource Estimato
month=feb, collection={RWDSL2018} }
```

- Azure Quantum Resource Estimator:
- Microsoft Quantum Resource Estimator:

```bibtex
@inproceedings{Azure_Quantum_Resource_Estimator,
Expand Down
4 changes: 2 additions & 2 deletions compiler/qsc_doc_gen/src/generate_docs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -547,13 +547,13 @@ fn generate_top_index(files: &mut FilesWithMetadata, toc: &mut ToC) {
let empty_ns: Rc<str> = Rc::from(String::new().as_str());
let metadata = Metadata {
uid: "Microsoft.Quantum.apiref-toc".to_string(),
title: "Q# standard libraries for the Azure Quantum Development Kit".to_string(),
title: "Q# standard libraries for the Microsoft Quantum Development Kit".to_string(),
kind: MetadataKind::TableOfContents,
package: PackageKind::StandardLibrary,
namespace: empty_ns.clone(),
name: "Overview".into(),
summary:
"Table of contents for the Q# standard libraries for Azure Quantum Development Kit"
"Table of contents for the Q# standard libraries for Microsoft Quantum Development Kit"
.to_string(),
signature: String::new(),
};
Expand Down
6 changes: 3 additions & 3 deletions compiler/qsc_doc_gen/src/generate_docs/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -178,8 +178,8 @@ fn top_index_file_generation() {
expect![[r#"
---
uid: Microsoft.Quantum.apiref-toc
title: Q# standard libraries for the Azure Quantum Development Kit
description: Table of contents for the Q# standard libraries for Azure Quantum Development Kit
title: Q# standard libraries for the Microsoft Quantum Development Kit
description: Table of contents for the Q# standard libraries for Microsoft Quantum Development Kit
author: {AUTHOR}
ms.author: {MS_AUTHOR}
ms.date: {TIMESTAMP}
Expand All @@ -204,7 +204,7 @@ fn top_index_file_generation() {
| [`Std.Measurement`](xref:Qdk.Std.Measurement-toc) | Items for measuring quantum results. |
| [`Std.Random`](xref:Qdk.Std.Random-toc) | Items for creating random values. |
| [`Std.Range`](xref:Qdk.Std.Range-toc) | Items for working with ranges. |
| [`Std.ResourceEstimation`](xref:Qdk.Std.ResourceEstimation-toc) | Items for working with the Azure Quantum Resource Estimator. |
| [`Std.ResourceEstimation`](xref:Qdk.Std.ResourceEstimation-toc) | Items for working with the Microsoft Quantum Resource Estimator. |
| [`Microsoft.Quantum.Unstable.Arithmetic`](xref:Qdk.Microsoft.Quantum.Unstable.Arithmetic-toc) | Items for working with quantum arithmetic operations. |
| [`Microsoft.Quantum.Unstable.StatePreparation`](xref:Qdk.Microsoft.Quantum.Unstable.StatePreparation-toc) | Items for preparing a quantum state. |
| [`Microsoft.Quantum.Unstable.TableLookup`](xref:Qdk.Microsoft.Quantum.Unstable.TableLookup-toc) | Items for performing quantum table lookups. |
Expand Down
2 changes: 1 addition & 1 deletion compiler/qsc_doc_gen/src/table_of_contents.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The Q# standard library contains the following namespaces:
| [`Std.Measurement`](xref:Qdk.Std.Measurement-toc) | Items for measuring quantum results. |
| [`Std.Random`](xref:Qdk.Std.Random-toc) | Items for creating random values. |
| [`Std.Range`](xref:Qdk.Std.Range-toc) | Items for working with ranges. |
| [`Std.ResourceEstimation`](xref:Qdk.Std.ResourceEstimation-toc) | Items for working with the Azure Quantum Resource Estimator. |
| [`Std.ResourceEstimation`](xref:Qdk.Std.ResourceEstimation-toc) | Items for working with the Microsoft Quantum Resource Estimator. |
| [`Microsoft.Quantum.Unstable.Arithmetic`](xref:Qdk.Microsoft.Quantum.Unstable.Arithmetic-toc) | Items for working with quantum arithmetic operations. |
| [`Microsoft.Quantum.Unstable.StatePreparation`](xref:Qdk.Microsoft.Quantum.Unstable.StatePreparation-toc) | Items for preparing a quantum state. |
| [`Microsoft.Quantum.Unstable.TableLookup`](xref:Qdk.Microsoft.Quantum.Unstable.TableLookup-toc) | Items for performing quantum table lookups. |
Expand Down
2 changes: 1 addition & 1 deletion jupyterlab/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To run Q# in Jupyter notebooks, remember to also install the `qsharp` package: [

## Support

For more information about the Azure Quantum Development Kit, visit [https://aka.ms/AQ/Documentation](https://aka.ms/AQ/Documentation).
For more information about the Microsoft Quantum Development Kit, visit [https://aka.ms/qdk](https://aka.ms/qdk).

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion npm/qsharp/ux/estimatesPanel.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ export function EstimatesPanel(props: {
{props.calculating ? (
<Spinner style="position: absolute; top: 11px; left: 4px;" />
) : null}
<h1>Azure Quantum Resource Estimator</h1>
<h1>Microsoft Quantum Resource Estimator</h1>
</div>
<EstimatesOverview
estimatesData={props.estimatesData}
Expand Down
2 changes: 1 addition & 1 deletion npm/qsharp/ux/output_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ classoption:

# Output data

In this document, we describe all output parameters which are printed by the Azure Quantum Resource Estimator. Second-level headings contain one group in the output that consists of a header and a table with resource estimation data. Each third-level heading corresponds to an entry, which is preceded by a short description text in italic and a long description text. The short description text will be always visible in the third column next to the value, whereas the long description text will be visible as a tooltip when hovering over the corresponding row in the table. The description texts may contain some variable names such as `variable` or $\mathtt{variable}$ in formulas. These will be substituted by the actual computed values extracted from the resource estimates.
In this document, we describe all output parameters which are printed by the Microsoft Quantum Resource Estimator. Second-level headings contain one group in the output that consists of a header and a table with resource estimation data. Each third-level heading corresponds to an entry, which is preceded by a short description text in italic and a long description text. The short description text will be always visible in the third column next to the value, whereas the long description text will be visible as a tooltip when hovering over the corresponding row in the table. The description texts may contain some variable names such as `variable` or $\mathtt{variable}$ in formulas. These will be substituted by the actual computed values extracted from the resource estimates.

## Physical resource estimates

Expand Down
2 changes: 1 addition & 1 deletion npm/qsharp/ux/scatterChart.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ export function ScatterChart(props: {
x={xLeftMargin - axisTitleHeight}
y={-svgHeight + yMargin}
>
Created with Azure Quantum Resource Estimator
Created with Microsoft Quantum Resource Estimator
</text>
<g>
{props.data.map((series, seriesIdx) => {
Expand Down
2 changes: 1 addition & 1 deletion pip/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ To disable sending telemetry from this package, set the environment variable `QS

## Support

For more information about the Azure Quantum Development Kit, visit [https://aka.ms/AQ/Documentation](https://aka.ms/AQ/Documentation).
For more information about the Microsoft Quantum Development Kit, visit [https://aka.ms/qdk](https://aka.ms/qdk).

## Contributing

Expand Down
6 changes: 3 additions & 3 deletions resource_estimator/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Azure Quantum Resource Estimator
# Microsoft Quantum Resource Estimator

The implementation for the Resource Estimator is broken up into two major components:

- [counts](./src/counts.rs) - performs program execution tracing to capture the logical qubit and gate counts for the given program
- [estimates](./src/estimates.rs) - takes in logical counts and a configuration to produce the set of corresponding physical resource estimates

For more information about the Azure Quantum Resource Estimator, see [the official documentation](https://learn.microsoft.com/en-us/azure/quantum/intro-to-resource-estimation).
For more information about the Microsoft Quantum Resource Estimator, see [the official documentation](https://learn.microsoft.com/en-us/azure/quantum/intro-to-resource-estimation).

The theoretical models used in Azure Quantum Resource Estimator are described in [Beverland at al. "Assessing requirements to scale to practical quantum advantage"](https://arxiv.org/abs/2211.07629).
The theoretical models used in Microsoft Quantum Resource Estimator are described in [Beverland at al. "Assessing requirements to scale to practical quantum advantage"](https://arxiv.org/abs/2211.07629).

## Using the resource estimator crate for customizable tasks

Expand Down
2 changes: 1 addition & 1 deletion samples/estimation/EkeraHastadFactoring.qs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
/// [ia.cr/2017/077](https://eprint.iacr.org/2017/077) based on the
/// implementation described in
/// [arXiv:1905.09749](https://arxiv.org/abs/1905.09749). This makes it ideal
/// for use with the Azure Quantum Resource Estimator.
/// for use with the Microsoft Quantum Resource Estimator.
import Std.Convert.*;
import Std.Math.*;
import Std.ResourceEstimation.*;
Expand Down
2 changes: 1 addition & 1 deletion samples/estimation/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Resource Estimation

This folder contains samples that show how to use the Azure Quantum Resource Estimator.
This folder contains samples that show how to use the Microsoft Quantum Resource Estimator.

* [EkeraHastadFactoring.qs](./EkeraHastadFactoring.qs): Resource estimation for integer factorization using Ekerå-Håstad algorithm (Stand-alone Q# version).
* [estimation-factoring.ipynb](./estimation-factoring.ipynb): Uses EkeraHastadFactoring.qs in a Jupyter notebook to pre-configure error budget.
Expand Down
4 changes: 2 additions & 2 deletions samples/estimation/ShorRE.qs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
/// In this sample we concentrate on costing the `EstimateFrequency`
/// operation, which is the core quantum operation in Shor's algorithm, and
/// we omit the classical pre- and post-processing. This makes it ideal for
/// use with the Azure Quantum Resource Estimator.
/// use with the Microsoft Quantum Resource Estimator.
import Std.Arrays.*;
import Std.Canon.*;
import Std.Convert.*;
Expand Down Expand Up @@ -68,7 +68,7 @@ operation EstimateFrequency(
H(c);
} apply {
// `BeginEstimateCaching` and `EndEstimateCaching` are the operations
// exposed by Azure Quantum Resource Estimator. These will instruct
// exposed by Microsoft Quantum Resource Estimator. These will instruct
// resource counting such that the if-block will be executed
// only once, its resources will be cached, and appended in
// every other iteration.
Expand Down
6 changes: 3 additions & 3 deletions samples/estimation/estimation-qiskit.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -421,7 +421,7 @@
"(including a crossing pre-factor $a$ which can be extracted numerically for\n",
"simulations) are listed below.\n",
"\n",
"In Azure Quantum Resource Estimation we can abstract the quantum error\n",
"In Microsoft Quantum Resource Estimation we can abstract the quantum error\n",
"correction scheme based on the above formula by providing values for the\n",
"crossing pre-factor $a$ and the error correction threshold $p^*$. Further, one\n",
"needs to specify the logical cycle time, i.e., the time to execute a single\n",
Expand Down Expand Up @@ -590,7 +590,7 @@
"name": "python3"
},
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"display_name": ".venv",
"language": "python",
"name": "python3"
},
Expand All @@ -604,7 +604,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.9"
"version": "3.12.10"
},
"microsoft": {
"host": {
Expand Down
2 changes: 1 addition & 1 deletion samples/notebooks/iterative_phase_estimation.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"\n",
"We also configure the target profile as `Adaptive_RI` to indicate we use the QIR profile with support for mid-circuit measurement, measurement-based control flow, and classical integer computation as part of compilation.\n",
"\n",
"Replace the `subscription_id`, `resource_group`, `name`, and `location` connection parameters with the values for your configured Azure Quantum Workspace, or try copying the Python code for connecting to your workspace from the VS Code Azure Quantum Extension."
"Replace the `subscription_id`, `resource_group`, `name`, and `location` connection parameters with the values for your configured Azure Quantum Workspace, or try copying the Python code for connecting to your workspace from the VS Code Microsoft Quantum Extension."
]
},
{
Expand Down
6 changes: 3 additions & 3 deletions samples/notebooks/repeat_until_success.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"\n",
"We also configure the target profile as `Adaptive_RI` to indicate we use the QIR profile with support for mid-circuit measurement, measurement-based control flow, and classical integer computation as part of compilation.\n",
"\n",
"Replace the `subscription_id`, `resource_group`, `name`, and `location` connection parameters with the values for your configured Azure Quantum Workspace, or try copying the Python code for connecting to your workspace from the VS Code Azure Quantum Extension."
"Replace the `subscription_id`, `resource_group`, `name`, and `location` connection parameters with the values for your configured Azure Quantum Workspace, or try copying the Python code for connecting to your workspace from the VS Code Microsoft Quantum Extension."
]
},
{
Expand Down Expand Up @@ -340,7 +340,7 @@
"name": "python3"
},
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"display_name": ".venv",
"language": "python",
"name": "python3"
},
Expand All @@ -354,7 +354,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.6"
"version": "3.12.10"
},
"nteract": {
"version": "[email protected]"
Expand Down
4 changes: 2 additions & 2 deletions version.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,8 @@ def update_file(file: str, old_text: str, new_text: str):
)
update_file(
os.path.join(root_dir, "vscode/package.json"),
r"[DEV BUILD] Azure Quantum Development Kit",
r"Azure Quantum Development Kit",
r"[DEV BUILD] Microsoft Quantum Development Kit",
r"Microsoft Quantum Development Kit",
)

else:
Expand Down
6 changes: 3 additions & 3 deletions vscode/README-DEV.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# [DEV BUILD] Azure Quantum Development Kit
# [DEV BUILD] Microsoft Quantum Development Kit

This is a development build of the Azure Quantum Development Kit, and is intended for early testing
This is a development build of the Microsoft Quantum Development Kit, and is intended for early testing
of upcoming features.

To install the tested version of this extension, visit <https://marketplace.visualstudio.com/items?itemName=quantum.qsharp-lang-vscode>.
The README for the stable build contains details on features and usage.

For more information about the Modern QDK and Azure Quantum, visit [https://aka.ms/AQ/Documentation](https://aka.ms/AQ/Documentation).
For more information about the QDK and Microsoft Quantum, visit [https://aka.ms/qdk](https://aka.ms/qdk).
4 changes: 2 additions & 2 deletions vscode/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Azure Quantum Development Kit (QDK)
# Microsoft Quantum Development Kit (QDK)

This extension brings rich Q# language support to VS Code. Develop, build, and run your Q# code from VS Code either locally on simulators, or by submitting a job to Azure Quantum.

Expand All @@ -19,7 +19,7 @@ The Q# extension currently supports:
- Snippet and sample support
- Completions

For more information about the QDK and Azure Quantum, visit [https://aka.ms/AQ/Documentation](https://aka.ms/AQ/Documentation).
For more information about the QDK and Microsoft Quantum, visit [https://aka.ms/qdk](https://aka.ms/qdk).

## Contributing

Expand Down
14 changes: 7 additions & 7 deletions vscode/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "qsharp-lang-vscode-dev",
"displayName": "[DEV BUILD] Azure Quantum Development Kit (QDK)",
"displayName": "[DEV BUILD] Microsoft Quantum Development Kit (QDK)",
"description": "Q# and OpenQASM Language Support",
"version": "0.0.0",
"publisher": "quantum",
Expand Down Expand Up @@ -31,13 +31,13 @@
"walkthroughs": [
{
"id": "qsharp-vscode.welcome",
"title": "The Azure Quantum Development Kit",
"description": "Getting started with the Azure Quantum Development Kit in VS Code",
"title": "The Microsoft Quantum Development Kit",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe just "Microsoft Quantum Development Kit"? (or are we going for something like "The Batman" 😜)

"description": "Getting started with the Microsoft Quantum Development Kit in VS Code",
"steps": [
{
"id": "qsharp-vscode.welcome.editor",
"title": "Welcome to the Azure Quantum Development Kit",
"description": "The Azure Quantum Development Kit (QDK) is an open-source SDK that you can use to write quantum programs and execute them on quantum hardware. This walkthrough will show you how to get started with the Azure Quantum Development Kit in VS Code.\n\nThe QDK gives you rich editor support for writing quantum programs, such as error checking, signature help, completion lists, safely renaming identifiers, and much more.",
"title": "Welcome to the Microsoft Quantum Development Kit",
"description": "The Microsoft Quantum Development Kit (QDK) is an open-source SDK that you can use to write quantum programs and execute them on quantum hardware. This walkthrough will show you how to get started with the Microsoft Quantum Development Kit in VS Code.\n\nThe QDK gives you rich editor support for writing quantum programs, such as error checking, signature help, completion lists, safely renaming identifiers, and much more.",
"media": {
"image": "resources/intellisense.png",
"altText": "Intellisense"
Expand Down Expand Up @@ -432,12 +432,12 @@
{
"command": "qsharp-vscode.setTargetProfile",
"category": "QDK",
"title": "Set the Azure Quantum QIR target profile"
"title": "Set the QIR target profile"
},
{
"command": "qsharp-vscode.createNotebook",
"category": "QDK",
"title": "Create an Azure Quantum notebook"
"title": "Create a Microsoft Quantum notebook"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one creates a sample that actually uses Azure Quantum, so the name may actually be appropriate?

},
{
"command": "qsharp-vscode.openPlayground",
Expand Down
Loading