[ci skip] Merge pull request #8 from IsolationKernel/develop

docs 9f52241

Author: xhan97

README.md

@@ -147,19 +147,19 @@ clf.predict([[0.1, 0.3], [0, 0.7], [90, 85]])
 
 ## Features
 
-ikpykit provides a set of key features designed to make time series forecasting with machine learning easy and efficient. For a detailed overview, see the [User Guides](./user_guides/table-of-contents.html).
+IKPyKit provides a set of key features designed to make machine learning tasks easy and efficient. For a detailed overview, see the [User Guides](./user_guides/table-of-contents.html).
 
 ---
 
 ## Examples and tutorials
 
-Explore our extensive list of examples and tutorials (English and Spanish) to get you started with ikpykit. You can find them [here](./examples/examples_english.html).
+Explore our extensive list of examples and tutorials to get you started with IKPyKit. You can find them [here](./examples/examples_english.html).
 
 ---
 
 ## How to contribute
 
-Primarily, ikpykit development consists of adding and creating new *Forecasters*, new validation strategies, or improving the performance of the current code. However, there are many other ways to contribute:
+Primarily, IKPyKit development consists of adding and creating new algorithms, new validation strategies, or improving the performance of the current code. However, there are many other ways to contribute:
 
 - Submit a bug report or feature request on [GitHub Issues](https://github.com/IsolationKernel/ikpykit/issues).
 - Contribute a Jupyter notebook to our [examples](./examples/examples_english.html).
@@ -168,15 +168,15 @@ Primarily, ikpykit development consists of adding and creating new *Forecasters*
 - Translate our documentation into another language.
 - Write a blog post, tweet, or share our project with others.
 
-For more information on how to contribute to ikpykit, see our [Contribution Guide](./contributing/contribution.html).
+For more information on how to contribute to IKPyKit, see our [Contribution Guide](./contributing/contribution.html).
 
-Visit our [authors section](./authors/authors.html) to meet all the contributors to ikpykit.
+Visit our [authors section](./authors/authors.html) to meet all the contributors to IKPyKit.
 
 ---
 
 ## Citation
 
-If you use ikpykit for a scientific publication, we would appreciate citations to the published software.
+If you use IKPyKit for a scientific publication, we would appreciate citations to the published software.
 
 **BibTeX**:
 

index.html

@@ -2205,13 +2205,13 @@ <h4 id="summary">Summary<a class="headerlink" href="#summary" title="Permanent l
 </table>
 <hr />
 <h2 id="features">Features<a class="headerlink" href="#features" title="Permanent link">&para;</a></h2>
-<p>ikpykit provides a set of key features designed to make time series forecasting with machine learning easy and efficient. For a detailed overview, see the <a href="./user_guides/table-of-contents.html">User Guides</a>.</p>
+<p>IKPyKit provides a set of key features designed to make machine learning tasks easy and efficient. For a detailed overview, see the <a href="./user_guides/table-of-contents.html">User Guides</a>.</p>
 <hr />
 <h2 id="examples-and-tutorials">Examples and tutorials<a class="headerlink" href="#examples-and-tutorials" title="Permanent link">&para;</a></h2>
-<p>Explore our extensive list of examples and tutorials (English and Spanish) to get you started with ikpykit. You can find them <a href="./examples/examples_english.html">here</a>.</p>
+<p>Explore our extensive list of examples and tutorials to get you started with IKPyKit. You can find them <a href="./examples/examples_english.html">here</a>.</p>
 <hr />
 <h2 id="how-to-contribute">How to contribute<a class="headerlink" href="#how-to-contribute" title="Permanent link">&para;</a></h2>
-<p>Primarily, ikpykit development consists of adding and creating new <em>Forecasters</em>, new validation strategies, or improving the performance of the current code. However, there are many other ways to contribute:</p>
+<p>Primarily, IKPyKit development consists of adding and creating new algorithms, new validation strategies, or improving the performance of the current code. However, there are many other ways to contribute:</p>
 <ul>
 <li>Submit a bug report or feature request on <a href="https://github.com/IsolationKernel/ikpykit/issues">GitHub Issues</a>.</li>
 <li>Contribute a Jupyter notebook to our <a href="./examples/examples_english.html">examples</a>.</li>
@@ -2220,11 +2220,11 @@ <h2 id="how-to-contribute">How to contribute<a class="headerlink" href="#how-to-
 <li>Translate our documentation into another language.</li>
 <li>Write a blog post, tweet, or share our project with others.</li>
 </ul>
-<p>For more information on how to contribute to ikpykit, see our <a href="./contributing/contribution.html">Contribution Guide</a>.</p>
-<p>Visit our <a href="./authors/authors.html">authors section</a> to meet all the contributors to ikpykit.</p>
+<p>For more information on how to contribute to IKPyKit, see our <a href="./contributing/contribution.html">Contribution Guide</a>.</p>
+<p>Visit our <a href="./authors/authors.html">authors section</a> to meet all the contributors to IKPyKit.</p>
 <hr />
 <h2 id="citation">Citation<a class="headerlink" href="#citation" title="Permanent link">&para;</a></h2>
-<p>If you use ikpykit for a scientific publication, we would appreciate citations to the published software.</p>
+<p>If you use IKPyKit for a scientific publication, we would appreciate citations to the published software.</p>
 <p><strong>BibTeX</strong>:</p>
 <div class="language-text highlight"><pre><span></span><code>@software{IKPyKit,
 author = {Xin Han, Yixiao Ma, Ye Zhu, and Kaiming Ting},

quick-start/how-to-install.html

@@ -1789,16 +1789,6 @@ <h2 id="basic-installation"><strong>Basic installation</strong><a class="headerl
 Latest (unstable):</p>
 <div class="language-bash highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>git+https://github.com/IsolationKernel/ikpykit.git@main<span class="w"> </span>--upgrade
 </code></pre></div>
-<p>Alternatively download the package, install requirements, and manually run the installer:</p>
-<div class="language-bash highlight"><pre><span></span><code>wget<span class="w"> </span>https://github.com/IsolationKernel/ikpykit.git@main
-unzip<span class="w"> </span>ikpykit-main.zip
-rm<span class="w"> </span>ikpyikt-main.zip
-<span class="nb">cd</span><span class="w"> </span>ikpykit-main
-
-pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements.txt
-
-python<span class="w"> </span>setup.py<span class="w"> </span>install
-</code></pre></div>
 <p>Once the installation is completed, you can check whether the installation was successful through:</p>
 <div class="language-py highlight"><pre><span></span><code><span class="kn">import</span><span class="w"> </span><span class="nn">ikpyikt</span>
 <span class="nb">print</span><span class="p">(</span><span class="n">ikpyikt</span><span class="o">.</span><span class="n">__version__</span><span class="p">)</span>

quick-start/how-to-install.md

@@ -19,19 +19,6 @@ Latest (unstable):
 pip install git+https://github.com/IsolationKernel/ikpykit.git@main --upgrade
 ```
 
-Alternatively download the package, install requirements, and manually run the installer:
-
-```bash
-wget https://github.com/IsolationKernel/ikpykit.git@main
-unzip ikpykit-main.zip
-rm ikpyikt-main.zip
-cd ikpykit-main
-
-pip install -r requirements.txt
-
-python setup.py install
-```
-
 Once the installation is completed, you can check whether the installation was successful through:
 
 ```py