Skip to content
This repository was archived by the owner on Nov 13, 2024. It is now read-only.

Add documentation for %trace #1010

Merged
merged 4 commits into from
Aug 18, 2020
Merged

Add documentation for %trace #1010

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eababa1
Add documentation for %trace
Aug 11, 2020
ea04de3
Change sample link to master branch
Aug 11, 2020
c091650
Remove locale from link
Aug 11, 2020
ebc0f43
Update IQ# trace magic link
Aug 11, 2020
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
Binary file added articles/media/trace_example.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions articles/user-guide/host-programs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -565,3 +565,11 @@ So, to run `MeasureSuperpositionArray`, we need to define a "wrapper" operation
<img src="../media/hostprograms_jupyter_wrapper_def_sim_crop.png" alt="Wrapper function and simulate Jupyter cell" width="550">

This operation can of course be used similarly with `%estimate` and other execution commands.

### Visualizing Q# programs

In a Q# Jupyter Notebook, you can visualize your Q# programs using the `%trace` magic command (more details about the command [here](xref:microsoft.quantum.iqsharp.magic-ref.trace)). Given a Q# operation as an argument, `%trace` will simulate that operation and trace out the gates in an execution path. This execution path is then rendered and output as a visualization within the Jupyter Notebook. For example, this is a visualization of a non-deterministic Q# program:

<img src="../media/trace_example.png" alt="Trace example" width="500">

You can find a more detailed explanation of the `%trace` magic command and how to use it in this [Jupyter Notebook sample](https://github.com/microsoft/Quantum/blob/master/samples/diagnostics/program-visualization/TraceExample.ipynb).