learnware/docs/index.rst

.. learnware documentation master file, created by
   sphinx-quickstart on Tue Mar 28 22:06:47 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

============================================================
``Learnware`` Documentation
============================================================

The ``learnware`` package provides a fundamental implementation of the central concepts and procedures and encompasses all processes within the *learnware paradigm*,
including the submitting, usability testing, organization, identification, deployment and reuse of learnwares.
Its well-structured design ensures high scalability and facilitates the seamless integration of additional features and techniques in the future.
In addition, the ``learnware`` package serves as the core engine for the `Beimingwu System <https://bmwu.cloud>`_, which supports the computational and algorithmic aspects of ``Beimingwu`` 
and offers rich algorithmic interfaces for learnware-related tasks and research experiments.

.. _user_guide:

Document Structure
====================

.. toctree::
   :hidden:

   Home <self>

.. toctree::
   :maxdepth: 3
   :caption: GETTING STARTED:

   Introduction <start/intro.rst>
   Quick Start <start/quick.rst>
   Installation <start/install.rst>
   Experiments and Examples <start/exp.rst>

.. toctree::
   :maxdepth: 3
   :caption: WORKFLOWS:

   Learnware Preparation and Uploading <workflows/upload.rst>
   Learnware Search <workflows/search.rst>
   Learnware Reuse <workflows/reuse.rst>
   Learnware Client <workflows/client.rst>

.. toctree::
   :maxdepth: 3
   :caption: COMPONENTS:

   Market <components/market.rst>
   Learnware & Reuser <components/learnware.rst>
   Specification <components/spec.rst>
   Model & Container <components/model.rst>

.. toctree::
   :maxdepth: 3
   :caption: ADVANCED TOPICS:

   Anchor Learnware <advanced/anchor.rst>
   Evolvable Specification <advanced/evolve.rst>

.. toctree::
   :maxdepth: 3
   :caption: REFERENCES:

   API <references/api.rst>
   Beimingwu System <references/beimingwu.rst>
   FAQ <references/FAQ.rst>

.. toctree::
   :maxdepth: 3
   :caption: ABOUTS:

   For Developer <about/dev.rst>
   Changelog <about/changelog.rst>
   About us <about/about.rst>