Skip to content

Commit 48c8d3d

Browse files
Update readme and doc
1 parent 148fab0 commit 48c8d3d

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
Fair and benchmark for dataset distillation.
1414
</h3> -->
1515
<p align="center">
16-
| <a href="https://nus-hpc-ai-lab.github.io/DD-Ranking/"><b>Documentation</b></a> | <a href="https://huggingface.co/spaces/Soptq/DD-Ranking"><b>Leaderboard</b></a> | <a href=""><b>Paper </b> (Coming Soon)</a> | <a href=""><b>Twitter/X</b> (Coming Soon)</a> | <a href=""><b>Developer Slack</b> (Coming Soon)</a> |
16+
| <a href="https://nus-hpc-ai-lab.github.io/DD-Ranking/"><b>Documentation</b></a> | <a href="https://huggingface.co/spaces/Soptq/DD-Ranking"><b>Leaderboard</b></a> | <a href=""><b>Paper </b> (Coming Soon)</a> | <a href=""><b>Twitter/X</b> (Coming Soon)</a> | <a href="https://join.slack.com/t/dd-ranking/shared_invite/zt-2xlcuq1mf-hmVcfrtqrIB3qXRjwgB03A"><b>Developer Slack</b></a> |
1717
</p>
1818

1919

@@ -206,10 +206,12 @@ soft_labels = torch.load('/your/path/to/syn/labels.pt')
206206
syn_lr = torch.load('/your/path/to/syn/lr.pt')
207207
```
208208

209-
**Step 3:** Compute the xxx metric.
209+
**Step 3:** Compute the metric.
210210

211211
```python
212-
metric = soft_label_metric_calc.compute_metrics(syn_images, soft_labels=soft_labels, syn_lr=syn_lr)
212+
metric = soft_label_metric_calc.compute_metrics(image_tensor=syn_images, soft_labels=soft_labels, syn_lr=syn_lr)
213+
# alternatively, you can specify the image folder path to compute the metric
214+
metric = soft_label_metric_calc.compute_metrics(image_path='./your/path/to/syn/images', soft_labels=soft_labels, syn_lr=syn_lr)
213215
```
214216

215217
The following results will be returned to you:

doc/getting-started/quick-start.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ For detailed explanation for hyper-parameters, please refer to our <a href="">do
7272

7373
```python
7474
>>> metric = soft_label_metric_calc.compute_metrics(image_tensor=syn_images, soft_labels=soft_labels, syn_lr=syn_lr)
75+
# alternatively, you can specify the image folder path to compute the metric
76+
>>> metric = soft_label_metric_calc.compute_metrics(image_path='./your/path/to/syn/images', soft_labels=soft_labels, syn_lr=syn_lr)
7577
```
7678

7779
The following results will be returned to you:

0 commit comments

Comments
 (0)