Update doc

Author: lizekai-richard

book/community.html

@@ -180,7 +180,7 @@ <h1 id="contributing"><a class="header" href="#contributing">Contributing</a></h
                                 <i class="fa fa-angle-left"></i>
                             </a>
 
-                            <a rel="next prefetch" href="community.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
+                            <a rel="next prefetch" href="getting-started/installation.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                                 <i class="fa fa-angle-right"></i>
                             </a>
 
@@ -194,7 +194,7 @@ <h1 id="contributing"><a class="header" href="#contributing">Contributing</a></h
                         <i class="fa fa-angle-left"></i>
                     </a>
 
-                    <a rel="next prefetch" href="community.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
+                    <a rel="next prefetch" href="getting-started/installation.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                         <i class="fa fa-angle-right"></i>
                     </a>
             </nav>

book/contributing.html

@@ -167,7 +167,7 @@ <h2 id="installation"><a class="header" href="#installation">Installation</a></h
 
                     <nav class="nav-wrapper" aria-label="Page navigation">
                         <!-- Mobile navigation buttons -->
-                            <a rel="prev" href="../community.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
+                            <a rel="prev" href="../contributing.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
                                 <i class="fa fa-angle-left"></i>
                             </a>
 
@@ -181,7 +181,7 @@ <h2 id="installation"><a class="header" href="#installation">Installation</a></h
             </div>
 
             <nav class="nav-wide-wrapper" aria-label="Page navigation">
-                    <a rel="prev" href="../community.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
+                    <a rel="prev" href="../contributing.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
                         <i class="fa fa-angle-left"></i>
                     </a>
 

book/getting-started/installation.html

@@ -222,9 +222,9 @@ <h2 id="quick-start"><a class="header" href="#quick-start">Quick Start</a></h2>
 <li><code>hard_label_recovery std</code>: The standard deviation of hard label recovery scores.</li>
 <li><code>improvement_over_random mean</code>: The mean of improvement over random scores.</li>
 <li><code>improvement_over_random std</code>: The standard deviation of improvement over random scores.</li>
-<li><code>dd_ranking_score mean</code>: The mean of dd ranking scores.</li>
-<li><code>dd_ranking_score std</code>: The standard deviation of dd ranking scores.</li>
 </ul>
+<!-- - `dd_ranking_score mean`: The mean of dd ranking scores.
+- `dd_ranking_score std`: The standard deviation of dd ranking scores. -->
 
                     </main>
 

book/getting-started/quick-start.html

@@ -206,8 +206,9 @@ <h2 id="dd-ranking-score"><a class="header" href="#dd-ranking-score">DD-Ranking
 <li>\(\text{syn-any}\): Synthetic dataset with personalized evaluation methods (hard or soft labels);</li>
 <li>\(\text{rdm-any}\): Randomly selected dataset (under the same compression ratio) with the same personalized evaluation methods.</li>
 </ul>
-<p>To rank different methods, we combine the above two metrics as DD-Ranking Score:</p>
-<p>\[\text{DD-Ranking Score} = \frac{\text{IOR}}{\text{HLR}} = \frac{(\text{Acc.} \text{syn-any}-\text{Acc.} \text{rdm-any})}{(\text{Acc.} \text{full-hard}-\text{Acc.} \text{syn-hard})}\]</p>
+<!-- To rank different methods, we combine the above two metrics as DD-Ranking Score:
+
+\\[\text{DD-Ranking Score} = \frac{\text{IOR}}{\text{HLR}} = \frac{(\text{Acc.} \text{syn-any}-\text{Acc.} \text{rdm-any})}{(\text{Acc.} \text{full-hard}-\text{Acc.} \text{syn-hard})}\\] -->
 
                     </main>
 

book/index.html

@@ -206,8 +206,9 @@ <h2 id="dd-ranking-score"><a class="header" href="#dd-ranking-score">DD-Ranking
 <li>\(\text{syn-any}\): Synthetic dataset with personalized evaluation methods (hard or soft labels);</li>
 <li>\(\text{rdm-any}\): Randomly selected dataset (under the same compression ratio) with the same personalized evaluation methods.</li>
 </ul>
-<p>To rank different methods, we combine the above two metrics as DD-Ranking Score:</p>
-<p>\[\text{DD-Ranking Score} = \frac{\text{IOR}}{\text{HLR}} = \frac{(\text{Acc.} \text{syn-any}-\text{Acc.} \text{rdm-any})}{(\text{Acc.} \text{full-hard}-\text{Acc.} \text{syn-hard})}\]</p>
+<!-- To rank different methods, we combine the above two metrics as DD-Ranking Score:
+
+\\[\text{DD-Ranking Score} = \frac{\text{IOR}}{\text{HLR}} = \frac{(\text{Acc.} \text{syn-any}-\text{Acc.} \text{rdm-any})}{(\text{Acc.} \text{full-hard}-\text{Acc.} \text{syn-hard})}\\] -->
 
                     </main>
 

book/introduction.html

@@ -222,7 +222,7 @@ <h3 id="methods"><a class="header" href="#methods">Methods</a></h3>
 <li>Compute the test accuracy of the surrogate model on the synthetic dataset under hard labels. We tune the learning rate for the best performance if <code>syn_lr</code> is not provided.</li>
 <li>Compute the test accuracy of the surrogate model on the real dataset under the same setting as step 1.</li>
 <li>Compute the test accuracy of the surrogate model on the randomly selected dataset under the same setting as step 1.</li>
-<li>Compute the HLR, IOR, and DD-Ranking scores.</li>
+<li>Compute the HLR and IOR scores.</li>
 </ol>
 <p>The final scores are the average of the scores from <code>num_eval</code> rounds.</p>
 <h4 id="parameters-1"><a class="header" href="#parameters-1">Parameters</a></h4>
@@ -239,8 +239,6 @@ <h4 id="returns"><a class="header" href="#returns">Returns</a></h4>
 <li><strong>hard_label_recovery_std</strong>: Standard deviation of HLR scores from <code>num_eval</code> rounds.</li>
 <li><strong>improvement_over_random_mean</strong>: Mean of improvement over random scores from <code>num_eval</code> rounds.</li>
 <li><strong>improvement_over_random_std</strong>: Standard deviation of improvement over random scores from <code>num_eval</code> rounds.</li>
-<li><strong>dd_ranking_mean</strong>: Mean of DD-Ranking scores from <code>num_eval</code> rounds.</li>
-<li><strong>dd_ranking_std</strong>: Standard deviation of DD-Ranking scores from <code>num_eval</code> rounds.</li>
 </ul>
 <p><strong>Examples:</strong></p>
 <p>with config file:</p>