Skip to content

Commit 7a4b790

Browse files
Update doc
1 parent 48c8d3d commit 7a4b790

File tree

4 files changed

+6
-2
lines changed

4 files changed

+6
-2
lines changed

book/getting-started/quick-start.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,8 @@ <h2 id="quick-start"><a class="header" href="#quick-start">Quick Start</a></h2>
215215
</code></pre>
216216
<p><strong>Step 3:</strong> Compute the metric.</p>
217217
<pre><code class="language-python">&gt;&gt;&gt; metric = soft_label_metric_calc.compute_metrics(image_tensor=syn_images, soft_labels=soft_labels, syn_lr=syn_lr)
218+
# alternatively, you can specify the image folder path to compute the metric
219+
&gt;&gt;&gt; metric = soft_label_metric_calc.compute_metrics(image_path='./your/path/to/syn/images', soft_labels=soft_labels, syn_lr=syn_lr)
218220
</code></pre>
219221
<p>The following results will be returned to you:</p>
220222
<ul>

book/print.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,8 @@ <h2 id="dd-ranking-score"><a class="header" href="#dd-ranking-score">DD-Ranking
295295
</code></pre>
296296
<p><strong>Step 3:</strong> Compute the metric.</p>
297297
<pre><code class="language-python">&gt;&gt;&gt; metric = soft_label_metric_calc.compute_metrics(image_tensor=syn_images, soft_labels=soft_labels, syn_lr=syn_lr)
298+
# alternatively, you can specify the image folder path to compute the metric
299+
&gt;&gt;&gt; metric = soft_label_metric_calc.compute_metrics(image_path='./your/path/to/syn/images', soft_labels=soft_labels, syn_lr=syn_lr)
298300
</code></pre>
299301
<p>The following results will be returned to you:</p>
300302
<ul>

book/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

book/searchindex.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)