Browse Source

[DOC] Add install doc

tags/v0.3.2
bxdd 2 years ago
parent
commit
ebd475975c
3 changed files with 59 additions and 5 deletions
  1. +1
    -1
      docs/index.rst
  2. +56
    -2
      docs/start/install.rst
  3. +2
    -2
      docs/workflow/identify.rst

+ 1
- 1
docs/index.rst View File

@@ -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::


+ 56
- 2
docs/start/install.rst View File

@@ -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>

+ 2
- 2
docs/workflow/identify.rst View File

@@ -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



Loading…
Cancel
Save