Skip to content

Commit 4049250

Browse files
committed
README comments
1 parent 606dd34 commit 4049250

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

test_files/guppy_optimization/README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@ the equivalent flat program to `pytket`.
55

66
Each example is in its own directory, containing:
77
- A `.py` [uv script](https://docs.astral.sh/uv/guides/scripts/) that defines the guppy program for a pinned version of guppylang.
8-
- If possible, a `.flat.py` script that defines the same program using `comptime` or manual loop peeling.
9-
- A `.opt.py` script that defines the optimized version of the program, which we
10-
expect to obtain after optimizing the previous versions.
8+
- A `.flat.py` script that defines the same program using `comptime` or manual loop peeling, if applicable.
9+
- A `.opt.py` script that defines a hand-optimized version of the program, indicative of the greatest optimization we believe can be achieved by the compiler.
1110

1211
- The `.hugr` files generated for each of the previous scripts.
1312

@@ -16,6 +15,5 @@ the `.mmd` mermaid files generated for each of the previous programs. Go to
1615
<http://mermaid.live> to view them.
1716
We do not generate these for large programs, as they get too large to view.
1817

19-
Run `just regenerate` in this directory to regenerate the `.hugr` files.
20-
The guppylang version used is defined in the `justfile`.
21-
The mermaid diagrams will only be generated if the `hugr` CLI is installed.
18+
Run `just regenerate` in this directory to regenerate the `.hugr` files and mermaid diagrams.
19+
The guppylang version used is defined by each script.

0 commit comments

Comments
 (0)