Rename package

Author: lizekai-richard

README.md

@@ -128,7 +128,7 @@ Install DD-Ranking with `pip` or from [source](https://github.com/NUS-HPC-AI-Lab
 From pip
 
 ```bash
-pip install dd_ranking
+pip install ddranking
 ```
 
 From source
@@ -143,8 +143,8 @@ Below is a step-by-step guide on how to use our `dd_ranking`. This demo is based
 **Step1**: Intialize a soft-label metric evaluator object. Config files are recommended for users to specify hyper-parameters. Sample config files are provided [here](https://github.com/NUS-HPC-AI-Lab/DD-Ranking/tree/main/configs).
 
 ```python
-from dd_ranking.metrics import SoftLabelEvaluator
-from dd_ranking.config import Config
+from ddranking.metrics import SoftLabelEvaluator
+from ddranking.config import Config
 
 config = Config.from_file("./configs/Demo_Soft_Label.yaml")
 soft_label_metric_calc = SoftLabelEvaluator(config)

book/getting-started/installation.html

@@ -157,7 +157,7 @@ <h1 class="menu-title">DD-Ranking API Documentation</h1>
                     <main>
                         <h2 id="installation"><a class="header" href="#installation">Installation</a></h2>
 <p>From pip</p>
-<pre><code class="language-bash">pip install dd_ranking
+<pre><code class="language-bash">pip install ddranking
 </code></pre>
 <p>From source</p>
 <pre><code class="language-bash">python setup.py install

book/getting-started/quick-start.html

@@ -158,8 +158,8 @@ <h1 class="menu-title">DD-Ranking API Documentation</h1>
                         <h2 id="quick-start"><a class="header" href="#quick-start">Quick Start</a></h2>
 <p>Below is a step-by-step guide on how to use our <code>dd_ranking</code>. This demo is based on soft labels (source code can be found in <code>demo_soft.py</code>). You can find hard label demo in <code>demo_hard.py</code>.</p>
 <p><strong>Step1</strong>: Intialize a soft-label metric evaluator object. Config files are recommended for users to specify hyper-parameters. Sample config files are provided <a href="https://github.com/NUS-HPC-AI-Lab/DD-Ranking/tree/main/configs">here</a>.</p>
-<pre><code class="language-python">from dd_ranking.metrics import SoftLabelEvaluator
-from dd_ranking.config import Config
+<pre><code class="language-python">from ddranking.metrics import SoftLabelEvaluator
+from ddranking.config import Config
 
 &gt;&gt;&gt; config = Config.from_file("./configs/Demo_Soft_Label.yaml")
 &gt;&gt;&gt; soft_label_metric_calc = SoftLabelEvaluator(config)

book/print.html

@@ -230,16 +230,16 @@ <h2 id="dd-ranking-score"><a class="header" href="#dd-ranking-score">DD-Ranking
 </ul>
 <div style="break-before: page; page-break-before: always;"></div><h2 id="installation"><a class="header" href="#installation">Installation</a></h2>
 <p>From pip</p>
-<pre><code class="language-bash">pip install dd_ranking
+<pre><code class="language-bash">pip install ddranking
 </code></pre>
 <p>From source</p>
 <pre><code class="language-bash">python setup.py install
 </code></pre>
 <div style="break-before: page; page-break-before: always;"></div><h2 id="quick-start"><a class="header" href="#quick-start">Quick Start</a></h2>
 <p>Below is a step-by-step guide on how to use our <code>dd_ranking</code>. This demo is based on soft labels (source code can be found in <code>demo_soft.py</code>). You can find hard label demo in <code>demo_hard.py</code>.</p>
 <p><strong>Step1</strong>: Intialize a soft-label metric evaluator object. Config files are recommended for users to specify hyper-parameters. Sample config files are provided <a href="https://github.com/NUS-HPC-AI-Lab/DD-Ranking/tree/main/configs">here</a>.</p>
-<pre><code class="language-python">from dd_ranking.metrics import SoftLabelEvaluator
-from dd_ranking.config import Config
+<pre><code class="language-python">from ddranking.metrics import SoftLabelEvaluator
+from ddranking.config import Config
 
 &gt;&gt;&gt; config = Config.from_file("./configs/Demo_Soft_Label.yaml")
 &gt;&gt;&gt; soft_label_metric_calc = SoftLabelEvaluator(config)