Skip to content
This repository has been archived by the owner on Jan 12, 2024. It is now read-only.

Deprecation of %estimate magic command #747

Open
wants to merge 3 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
4 changes: 3 additions & 1 deletion src/Jupyter/Magic/EstimateMagic.cs
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,16 @@ public EstimateMagic(ISymbolResolver resolver, ILogger<EstimateMagic> logger) :
{
Summary = "Runs a given function or operation on the ResourcesEstimator target machine.",
Description = @"
> [!NOTE]
> The `%estimate` magic command and the QDK ResourcesEstimator have been deprecated.

The ResourcesEstimator estimates statistics about how many resources the given
operation needs for execution. The resources it calculates include:

- Counts for each primitive operation
- Depth (lower bound for the T-gate depth of the quantum circuit)
- Width (lower bound for the maximum number of qubits used for the computation)

See the [ResourcesEstimator user guide](https://docs.microsoft.com/azure/quantum/user-guide/machines/resources-estimator) to learn more.

#### Required parameters

Expand Down
3 changes: 1 addition & 2 deletions src/Jupyter/Magic/WhoMagic.cs
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@ public WhoMagic(ISnippets snippets, ILogger<WhoMagic> logger) : base(
Summary = "Lists the Q# operations available in the current session.",
Description = @"
This magic command returns a list of Q# operations and functions that are available
in the current IQ# session for use with magic commands such as `%simulate`
and `%estimate`.
in the current IQ# session for use with magic commands such as `%simulate`.

The list will include Q# operations and functions which have been defined interactively
within cells in the current notebook (after the cells have been executed),
Expand Down