update

KindXiaoming · Apr 29, 2024 · b5da1c0 · b5da1c0
1 parent f983f96
commit b5da1c0
Show file tree

Hide file tree

Showing 22 changed files with 38 additions and 10 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -16,7 +16,8 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = ["sphinx_rtd_theme",
-              "sphinx.ext.autodoc"
+              "sphinx.ext.autodoc",
+              "sphinx.ext.autosectionlabel"
               ]
 
 templates_path = ['_templates']

diff --git a/docs/demos.rst b/docs/demos.rst
@@ -1,3 +1,5 @@
+.. _api-demo:
+
 API Demos
 ---------
 

diff --git a/docs/examples.rst b/docs/examples.rst
@@ -1,3 +1,5 @@
+.. _examples:
+
 Examples
 --------
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -6,21 +6,22 @@
 Welcome to Kolmogorov Aarnold Network (KAN) documentation!
 ==========================================================
 
-This documentation is for the paper "KAN: Kolmogorov-Arnold Networks" and the github repo can be found here.
-
 .. image:: kan_plot.png
 
+This documentation is for the paper "KAN: Kolmogorov-Arnold Networks" and the github repo can be found here.
+Kolmogorov-Arnold Networks, inspired by the Kolmogorov-Arnold representation theorem, are promising alternatives
+of Multi-Layer Preceptrons (MLPs). KANs have activation functions on edges, whereas MLPs have activation functions on nodes.
+This simple change makes KAN better than MLPs in terms of both accuracy and interpretability.
+
 Get the latest news at `CNN`_. (Add links to paper and github repo)
 
 .. _CNN: http://cnn.com/
 
-There are two ways to install kan. The first way is via pip install
-
-.. code-block:: python
+Installation
+------------
 
-   pip install pykan
-   
-The second way is via github
+Installation via github
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. code-block:: python
 
@@ -29,6 +30,24 @@ The second way is via github
    pip install -e .
    # pip install -r requirements.txt # install requirements
 
+
+Installation via PyPI (soon)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: python
+
+   pip install pykan
+   
+
+Get started
+-----------
+
+* Quickstart: :ref:`hello-kan`
+* KANs in Action: :ref:`api-demo`, :ref:`examples`
+* API (advanced): :ref:`api`.
+
+
+
 .. toctree::
    :maxdepth: 1
    :caption: Contents:

diff --git a/docs/intro.rst b/docs/intro.rst
@@ -1,3 +1,5 @@
+.. _hello-kan:
+
 Hello, KAN!
 ===========
 

diff --git a/docs/modules.rst b/docs/modules.rst
@@ -1,3 +1,5 @@
+.. _api:
+
 API
 ===
 

diff --git a/figures/sp_0_0_0.png b/figures/sp_0_0_0.png
diff --git a/figures/sp_0_0_1.png b/figures/sp_0_0_1.png
diff --git a/figures/sp_0_0_2.png b/figures/sp_0_0_2.png
diff --git a/figures/sp_0_0_3.png b/figures/sp_0_0_3.png
diff --git a/figures/sp_0_0_4.png b/figures/sp_0_0_4.png
diff --git a/figures/sp_0_1_0.png b/figures/sp_0_1_0.png
diff --git a/figures/sp_0_1_1.png b/figures/sp_0_1_1.png
diff --git a/figures/sp_0_1_2.png b/figures/sp_0_1_2.png
diff --git a/figures/sp_0_1_3.png b/figures/sp_0_1_3.png
diff --git a/figures/sp_0_1_4.png b/figures/sp_0_1_4.png
diff --git a/figures/sp_1_0_0.png b/figures/sp_1_0_0.png
diff --git a/figures/sp_1_1_0.png b/figures/sp_1_1_0.png
diff --git a/figures/sp_1_2_0.png b/figures/sp_1_2_0.png
diff --git a/figures/sp_1_3_0.png b/figures/sp_1_3_0.png
diff --git a/figures/sp_1_4_0.png b/figures/sp_1_4_0.png
diff --git a/requirements.txt b/requirements.txt
@@ -1,6 +1,6 @@
 matplotlib==3.6.2
 moviepy==1.0.3
-numpy==1.26.4
+numpy==1.24.4
 scikit_learn==1.1.3
 setuptools==65.5.0
 sphinx_rtd_theme==2.0.0
-Original file line number
+Diff line change
@@ -1,3 +1,5 @@
+    .. _api:
     API
     ===
@@ Expand Down @@