Skip to content

Commit

Permalink
[DOC] update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bxdd committed Jan 13, 2024
1 parent b7f48bb commit 69310e7
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ The learnware paradigm consists of two distinct stages:
<img src="./docs/_static/img/learnware_framework.svg" width="70%"/>
</div>

The engine architecture is designed based on the guidelines including _decoupling_, _autonomy_, _reusability_, and _scalability_. The above architecture diagram illustrates the architecture and framework from the perspectives of both modules andprocesses
The architecture is designed based on the guidelines including _decoupling_, _autonomy_, _reusability_, and _scalability_. The above architecture diagram illustrates the architecture and framework from the perspectives of both modules and workflows.

- At the workflow level, the `learnware` package consists of `Submitting Stage` and `Deploying Stage`.

Expand Down
41 changes: 37 additions & 4 deletions docs/start/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,44 @@ Procedure of Learnware Paradigm
:align: center


Learnware Package Design
==========================
Framework and Architecture Design
==================================

.. image:: ../_static/img/learnware_framework.svg
:align: center

At the workflow level, the ``learnware`` package consists of ``Submitting Stage`` and ``Deploying Stage``.
At the module level, the ``learnware`` package is a platform that consists of above components. The components are designed as loose-coupled modules and each component could be used stand-alone.
The architecture is designed based on the guidelines including *decoupling*, *autonomy*, *reusability*, and *scalability*. The above architecture diagram illustrates the architecture and framework from the perspectives of both modules and workflows.

- At the workflow level, the ``learnware`` package consists of ``Submitting Stage`` and ``Deploying Stage``.

+---------------------+-------------------------------------------------------------------------------------------------------------------+
| Module | Workflow |
+=====================+===================================================================================================================+
| ``Submitting Stage``| The learnware developers submit learnwares to the learnware market, which conducts usability checks and further |
| | organization of these learnwares. |
+---------------------+-------------------------------------------------------------------------------------------------------------------+
| ``Deploying Stage`` | The `learnware` package identifies learnwares according to users’ task requirements and provides efficient |
| | reuse and deployment methods. |
+---------------------+-------------------------------------------------------------------------------------------------------------------+

- At the module level, the ``learnware`` package is a platform that consists of ``Learnware``, ``Market``, ``Specification``, ``Model``, ``Reuse``, and ``Interface`` modules.

+------------------+------------------------------------------------------------------------------------------------------------+
| Module | Description |
+==================+============================================================================================================+
| ``Learnware`` | The specific learnware, consisting of specification module, and user model module. |
+------------------+------------------------------------------------------------------------------------------------------------+
| ``Market`` | Designed for learnware organization, identification, and usability testing. |
+------------------+------------------------------------------------------------------------------------------------------------+
| ``Specification``| Generating and storing statistical and semantic information of learnware, which can be used for learnware |
| | search and reuse. |
+------------------+------------------------------------------------------------------------------------------------------------+
| ``Model`` | Including the base model and the model container, which can provide unified interfaces and automatically |
| | create isolated runtime environments. |
+------------------+------------------------------------------------------------------------------------------------------------+
| ``Reuse`` | Including the data-free reuser, data-dependent reuser, and aligner, which can deploy and reuse learnware |
| | for user tasks. |
+------------------+------------------------------------------------------------------------------------------------------------+
| ``Interface`` | The interface for network communication with the `Beimingwu` backend. |
+------------------+------------------------------------------------------------------------------------------------------------+

0 comments on commit 69310e7

Please sign in to comment.