Skip to content

Commit 3f4ecd7

Browse files
committed
Update to report page
1 parent 724c7fe commit 3f4ecd7

File tree

8 files changed

+31
-36
lines changed

8 files changed

+31
-36
lines changed

www/doc/1.3/report-derivation.png

-648 Bytes
Loading

www/doc/1.3/report-error.png

4.46 KB
Loading

www/doc/1.3/report-large.png

-35 Bytes
Loading

www/doc/1.3/report-prog.png

1.94 KB
Loading

www/doc/1.3/report-reproduce.png

7.43 KB
Loading

www/doc/1.3/report-runtime.png

-15.8 KB
Binary file not shown.

www/doc/1.3/report-try-it.png

-5.12 KB
Loading

www/doc/1.3/report.html

Lines changed: 31 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -16,37 +16,29 @@ <h1>Herbie reports</h1>
1616

1717
<h1>The Herbie report</h1>
1818

19-
<p>The Herbie report, which is output by
20-
the <a href="using-web.html">Herbie web commands</a>, lists five items.</p>
19+
<p>Herbie can <a href="using-web.html">generate HTML reports</a>
20+
which give its output expression and also how Herbie found it.</p>
2121

2222
<h2 id="summary">Summary numbers</h2>
2323

24-
<p>First, a brief summary of the results.
25-
For most uses, the “Average Error”
26-
number, which summarizes how accurate the input and output
27-
expressions are, is the most important number in this section.
28-
The other numbers are:
29-
the time Herbie took to improve the program;
30-
the precision Herbie assumed floating-point operations
31-
(which can be set at the <a href="options.html">command line</a>);
32-
and the internal precision used to ensure accurate results.</p>
24+
<p>First, a brief summary of the results. For most uses, the
25+
“Average Error” number, which summarizes how accurate the input
26+
and output expressions are, is the most important number in this
27+
section. The other numbers list time Herbie took to improve the
28+
program and the <a href="input.html#precisions">precision</a> of
29+
floating-point operations.
30+
</p>
3331

3432
<figure>
3533
<img width="100%" src="report-large.png" />
36-
<figcaption>A summary of results from a Herbie report.</figcaption>
34+
<figcaption>Summary numbers from a Herbie report.</figcaption>
3735
</figure>
3836

3937
<h2 id="programs">Input and output programs</h2>
4038

41-
<p>Second, the input and output programs themselves.
42-
These are printed in standard mathematical syntax.
43-
Library functions not often used by mathematicians,
44-
including <code>atan2</code>, <code>expm1</code>,
45-
<code>fma</code>, <code>hypot</code>, <code>lgamma</code>,
46-
<code>log1p</code>, and <code>logb</code>
47-
are drawn with a sub- or super-script asterisk,
48-
while <code>if</code> statements are rendered as in a program.
49-
</p>
39+
<p>Second, the input and output programs themselves. These are
40+
printed in standard mathematical syntax. In the top-right corner,
41+
the drop-down can be used to change to C syntax or raw TeX.</p>
5042

5143
<figure>
5244
<img width="100%" src="report-prog.png" />
@@ -84,7 +76,7 @@ <h2 id="graph">Error graph</h2>
8476
input and output program (both are toggled on).</figcaption>
8577
</figure>
8678

87-
<h2 id="try-it">Try it</h2>
79+
<h2 id="try-it">Interactive inputs</h2>
8880

8981
<p>
9082
Fourth, a form where you can try out specific inputs on the input
@@ -121,23 +113,26 @@ <h2 id="derivation">Derivation</h2>
121113
error at each step, in bits, in gray.</figcaption>
122114
</figure>
123115

124-
<h2 id="time">Runtime information</h2>
125-
126-
<p>Sixth and finally, a breakdown of Herbie's runtime.
127-
This can usually be ignored.
128-
The colored bar is a timeline of Herbie's run,
129-
with each section of the bar sized proportionally to its runtime,
130-
and each color corresponding to a strategy;
131-
hover over that section of the bar to learn which strategy.</p>
132-
133-
<p>If you find a bug, include the code snippet in this section when
134-
filing the bug. Please also include the debug log linked from this block.</p>
135-
116+
<h2 id="reproduction">Reproduction</h2>
117+
118+
<p>Sixth, a command you can use to reproduce this Herbie result.
119+
If you find a bug, include the code snippet in this section when
120+
<a href="https://github.com/uwplse/herbie/issues">filing the
121+
bug</a>. Please also include the debug log linked at the top of the
122+
page.</p>
123+
136124
<figure>
137-
<img width="100%" src="report-runtime.png" />
138-
<figcaption>Runtime breakdown from a Herbie report.</figcaption>
125+
<img width="100%" src="report-reproduce.png" />
126+
<figcaption>Reproduction information for a Herbie run.</figcaption>
139127
</figure>
140128

129+
<h2 id="links">Additional links</h2>
130+
131+
<p>The top of the page has a right-hand menu bar with additional
132+
links. “Log” you to a detailed debug log. “Profile” gives
133+
a <code>gprof</code>-style profile. and “Metrics” gives detailed
134+
internal metrics on Herbie's results.</p>
135+
141136
<p>We expect the report to grow more informative with future
142137
versions. Please <a href="mailto:[email protected]">get in
143138
touch</a> if there is more information you'd like to see.</p>

0 commit comments

Comments
 (0)