From ebd475975cfb19976bcc911277a8029e584b562c Mon Sep 17 00:00:00 2001
From: bxdd <bxddream@gmail.com>
Date: Tue, 25 Apr 2023 14:52:42 +0800
Subject: [PATCH] [DOC] Add install doc

---
 docs/index.rst             |  2 +-
 docs/start/install.rst     | 58 ++++++++++++++++++++++++++++++++++++--
 docs/workflow/identify.rst |  4 +--
 3 files changed, 59 insertions(+), 5 deletions(-)

diff --git a/docs/index.rst b/docs/index.rst
index 1b6afcf..3fcb1ed 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -25,7 +25,7 @@ Document Structure
 
    Introduction <start/intro.rst>
    Quick Start <start/quick.rst>
-   Installation Guide <start/install.rst>
+   Installation <start/install.rst>
    Experiments and Examples <start/performance.rst>
 
 .. toctree::
diff --git a/docs/start/install.rst b/docs/start/install.rst
index 0c61488..5ceffcb 100644
--- a/docs/start/install.rst
+++ b/docs/start/install.rst
@@ -1,3 +1,57 @@
-===================
+========================
 Installation Guide
-===================
+========================
+
+
+``Learnware Market`` Installation
+=================================
+.. note::
+
+   ``Learnware Market`` supports `Windows`, `Linux` and `Macos`. It's recommended to use ``Learnware Market`` in `Linux`. ``Learnware Market`` supports Python3, which is up to Python3.8.
+
+Users can easily install ``Learnware Market`` by pip according to the following command:
+
+- For Windows and Linux users:
+
+    .. code-block:: bash
+
+        pip install learnware
+
+- For macOS users:
+
+    .. code-block:: bash
+
+        conda install -c pytorch faiss
+        pip install learnware
+
+
+Also, Users can install ``Learnware Market`` by the source code according to the following steps:
+
+- Enter the root directory of ``Learnware Market``, in which the file ``setup.py`` exists.
+- Then, please execute the following command to install the environment dependencies and install ``Learnware Market``:
+
+- For Windows and Linux users:
+
+    .. code-block:: bash
+        
+        $ git clone https://git.nju.edu.cn/learnware/learnware-market.git && cd learnware-market
+        $ python setup.py install
+
+- For macOS users:
+
+    .. code-block:: bash
+        
+        $ conda install -c pytorch faiss
+        $ git clone https://git.nju.edu.cn/learnware/learnware-market.git && cd learnware-market
+        $ python setup.py install
+
+.. note::
+   It's recommended to use anaconda/miniconda to setup the environment.
+
+Use the following code to make sure the installation successful:
+
+.. code-block:: python
+
+   >>> import learnware
+   >>> learnware.__version__
+   <LATEST VERSION>
\ No newline at end of file
diff --git a/docs/workflow/identify.rst b/docs/workflow/identify.rst
index daf4c65..e439e32 100644
--- a/docs/workflow/identify.rst
+++ b/docs/workflow/identify.rst
@@ -28,7 +28,7 @@ The semantic specification ``user_semantic`` is stored in a ``dict``, with keywo
    :align: center
 
 
-The user's statistical information ``stat_info`` is stored in a ``json`` file, e.g., ``stat.json``. The generation of this file is seen in `这是一个语义规约生成的链接`_.
+The user's statistical information ``stat_info`` is stored in a ``json`` file, e.g., ``stat.json``. The generation of this file is seen in `Learnware Preparation <./submit>`_.
 
 
 
@@ -37,7 +37,7 @@ Semantic Specification Search
 To search for learnwares that fit your task purpose, 
 the user should first provide a semantic specification ``user_semantic`` that describes the characteristics of your task.
 The Learnware Market will perform a first-stage search based on ``user_semantic``,
-identifying potentially helpful leranwares whose models solve tasks similar to your requirements. 
+identifying potentially helpful leaarnwares whose models solve tasks similar to your requirements. 
 
 .. code-block:: python