beimingwu
/
learnware
Not watched
1
0
Fork 0
Code
Releases 1 Wiki evaluate Activity
Issues 0 Pull Requests 0 Datasets Model Cloudbrain HPC
You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tree: ade2fcb45f
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'ade2fcb45f'
${ noResults }
learnware/docs/_build/html/references/api.html

334 lines
25 kB
Raw Blame History 

  1. <!DOCTYPE html>

  2. <html class="writer-html5" lang="en-US" >

  3. <head>

  4.   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

  5. 

  6.   <meta name="viewport" content="width=device-width, initial-scale=1.0" />

  7.   <title>API Reference &mdash; learnware 0.1.0.99 documentation</title>

  8.       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

  9.       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />

  10.   <!--[if lt IE 9]>

  11.     <script src="../_static/js/html5shiv.min.js"></script>

  12.   <![endif]-->

  13.   

  14.         <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>

  15.         <script src="../_static/doctools.js"></script>

  16.         <script src="../_static/sphinx_highlight.js"></script>

  17.     <script src="../_static/js/theme.js"></script>

  18.     <link rel="index" title="Index" href="../genindex.html" />

  19.     <link rel="search" title="Search" href="../search.html" />

  20.     <link rel="prev" title="Specification" href="../components/spec.html" /> 

  21. </head>

  22. 

  23. <body class="wy-body-for-nav"> 

  24.   <div class="wy-grid-for-nav">

  25.     <nav data-toggle="wy-nav-shift" class="wy-nav-side">

  26.       <div class="wy-side-scroll">

  27.         <div class="wy-side-nav-search" >

  28. 

  29.           

  30.           

  31.           <a href="../index.html">

  32.             

  33.           </a>

  34. <div role="search">

  35.   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">

  36.     <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />

  37.     <input type="hidden" name="check_keywords" value="yes" />

  38.     <input type="hidden" name="area" value="default" />

  39.   </form>

  40. </div>

  41.         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">

  42.               <ul>

  43. <li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>

  44. </ul>

  45. <p class="caption" role="heading"><span class="caption-text">GETTING STARTED:</span></p>

  46. <ul>

  47. <li class="toctree-l1"><a class="reference internal" href="../introduction/intro.html">Introduction</a></li>

  48. </ul>

  49. <p class="caption" role="heading"><span class="caption-text">COMPONENTS:</span></p>

  50. <ul>

  51. <li class="toctree-l1"><a class="reference internal" href="../components/market.html">Market</a></li>

  52. <li class="toctree-l1"><a class="reference internal" href="../components/spec.html">Specification</a></li>

  53. </ul>

  54. <p class="caption" role="heading"><span class="caption-text">REFERENCES:</span></p>

  55. <ul class="current">

  56. <li class="toctree-l1 current"><a class="current reference internal" href="#">API</a><ul>

  57. <li class="toctree-l2"><a class="reference internal" href="#market">Market</a><ul>

  58. <li class="toctree-l3"><a class="reference internal" href="#learnware.market.LearnwareMarket"><code class="docutils literal notranslate"><span class="pre">LearnwareMarket</span></code></a></li>

  59. </ul>

  60. </li>

  61. <li class="toctree-l2"><a class="reference internal" href="#learnware">Learnware</a><ul>

  62. <li class="toctree-l3"><a class="reference internal" href="#learnware.learnware.Learnware"><code class="docutils literal notranslate"><span class="pre">Learnware</span></code></a></li>

  63. </ul>

  64. </li>

  65. <li class="toctree-l2"><a class="reference internal" href="#specification">Specification</a><ul>

  66. <li class="toctree-l3"><a class="reference internal" href="#learnware.specification.Specification"><code class="docutils literal notranslate"><span class="pre">Specification</span></code></a></li>

  67. <li class="toctree-l3"><a class="reference internal" href="#learnware.specification.StatSpecification"><code class="docutils literal notranslate"><span class="pre">StatSpecification</span></code></a></li>

  68. </ul>

  69. </li>

  70. </ul>

  71. </li>

  72. </ul>

  73. 

  74.         </div>

  75.       </div>

  76.     </nav>

  77. 

  78.     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >

  79.           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>

  80.           <a href="../index.html">learnware</a>

  81.       </nav>

  82. 

  83.       <div class="wy-nav-content">

  84.         <div class="rst-content">

  85.           <div role="navigation" aria-label="Page navigation">

  86.   <ul class="wy-breadcrumbs">

  87.       <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>

  88.       <li class="breadcrumb-item active">API Reference</li>

  89.       <li class="wy-breadcrumbs-aside">

  90.             <a href="../_sources/references/api.rst.txt" rel="nofollow"> View page source</a>

  91.       </li>

  92.   </ul>

  93.   <hr/>

  94. </div>

  95.           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">

  96.            <div itemprop="articleBody">

  97.              

  98.   <section id="api-reference">

  99. <span id="api"></span><h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this heading"></a></h1>

  100. <p>Here you can find all <code class="docutils literal notranslate"><span class="pre">learnware</span></code> interfaces.</p>

  101. <section id="market">

  102. <h2>Market<a class="headerlink" href="#market" title="Permalink to this heading"></a></h2>

  103. <dl class="py class">

  104. <dt class="sig sig-object py" id="learnware.market.LearnwareMarket">

  105. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">learnware.market.</span></span><span class="sig-name descname"><span class="pre">LearnwareMarket</span></span><a class="headerlink" href="#learnware.market.LearnwareMarket" title="Permalink to this definition"></a></dt>

  106. <dd><p>Market for Learnware</p>

  107. <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Provide some python examples</span>

  108. <span class="n">learnmarket</span> <span class="o">=</span> <span class="n">LearnwareMarket</span><span class="p">()</span>

  109. </pre></div>

  110. </div>

  111. <dl class="py method">

  112. <dt class="sig sig-object py" id="learnware.market.LearnwareMarket.add_learnware">

  113. <span class="sig-name descname"><span class="pre">add_learnware</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">learnware_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">model_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stat_spec_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">properties</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">desc</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#learnware.market.LearnwareMarket.add_learnware" title="Permalink to this definition"></a></dt>

  114. <dd><p>Add a learnware into the market.</p>

  115. <div class="admonition note">

  116. <p class="admonition-title">Note</p>

  117. <p>Given a prediction of a certain time, all signals before this time will be prepared well.</p>

  118. </div>

  119. <dl class="field-list simple">

  120. <dt class="field-odd">Parameters<span class="colon">:</span></dt>

  121. <dd class="field-odd"><ul class="simple">

  122. <li><p><strong>learnware_name</strong> (<em>str</em>) – Name of new learnware.</p></li>

  123. <li><p><strong>model_path</strong> (<em>str</em>) – Filepath for learnware model, a zipped file.</p></li>

  124. <li><p><strong>stat_spec_path</strong> (<em>str</em>) – Filepath for statistical specification, a ‘.npy’ file.

  125. How to pass parameters requires further discussion.</p></li>

  126. <li><p><strong>properties</strong> (<em>dict</em>) – property for new learnware, in dictionary format.</p></li>

  127. <li><p><strong>desc</strong> (<em>str</em>) – Brief desciption for new learnware.</p></li>

  128. </ul>

  129. </dd>

  130. <dt class="field-even">Returns<span class="colon">:</span></dt>

  131. <dd class="field-even"><p>str indicating model_id, bool indicating whether the learnware is added successfully.</p>

  132. </dd>

  133. <dt class="field-odd">Return type<span class="colon">:</span></dt>

  134. <dd class="field-odd"><p>Tuple[str, bool]</p>

  135. </dd>

  136. <dt class="field-even">Raises<span class="colon">:</span></dt>

  137. <dd class="field-even"><p><strong>FileNotFoundError</strong> – file for model or statistical specification not found</p>

  138. </dd>

  139. </dl>

  140. </dd></dl>

  141. 

  142. <dl class="py method">

  143. <dt class="sig sig-object py" id="learnware.market.LearnwareMarket.delete_learnware">

  144. <span class="sig-name descname"><span class="pre">delete_learnware</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#learnware.market.LearnwareMarket.delete_learnware" title="Permalink to this definition"></a></dt>

  145. <dd><blockquote>

  146. <div><p>deleted a learnware from market</p>

  147. </div></blockquote>

  148. <dl class="field-list simple">

  149. <dt class="field-odd">Parameters<span class="colon">:</span></dt>

  150. <dd class="field-odd"><p><strong>id</strong> (<em>str</em>) – id of learnware to be deleted</p>

  151. </dd>

  152. <dt class="field-even">Returns<span class="colon">:</span></dt>

  153. <dd class="field-even"><p>True if the target learnware is deleted successfully.</p>

  154. </dd>

  155. <dt class="field-odd">Return type<span class="colon">:</span></dt>

  156. <dd class="field-odd"><p>bool</p>

  157. </dd>

  158. <dt class="field-even">Raises<span class="colon">:</span></dt>

  159. <dd class="field-even"><p><strong>Exception</strong> – Raise an excpetion when give id is NOT found in learnware list</p>

  160. </dd>

  161. </dl>

  162. </dd></dl>

  163. 

  164. <dl class="py method">

  165. <dt class="sig sig-object py" id="learnware.market.LearnwareMarket.get_learnware_by_ids">

  166. <span class="sig-name descname"><span class="pre">get_learnware_by_ids</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#learnware.learnware.Learnware" title="learnware.learnware.base.Learnware"><span class="pre">Learnware</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#learnware.learnware.Learnware" title="learnware.learnware.base.Learnware"><span class="pre">Learnware</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#learnware.market.LearnwareMarket.get_learnware_by_ids" title="Permalink to this definition"></a></dt>

  167. <dd><blockquote>

  168. <div><p>Get Learnware from market by id</p>

  169. </div></blockquote>

  170. <dl class="field-list simple">

  171. <dt class="field-odd">Parameters<span class="colon">:</span></dt>

  172. <dd class="field-odd"><p><strong>id</strong> (<em>Union</em><em>[</em><em>str</em><em>, </em><em>List</em><em>[</em><em>str</em><em>]</em><em>]</em>) – Given one id or a list of ids as target.</p>

  173. </dd>

  174. <dt class="field-even">Returns<span class="colon">:</span></dt>

  175. <dd class="field-even"><p><p>Return a Learnware object or a list of Learnware objects based on the type of input param.</p>

  176. <ul class="simple">

  177. <li><p>The returned items are search results.</p></li>

  178. <li><p>’None’ indicating the target id not found.</p></li>

  179. </ul>

  180. </p>

  181. </dd>

  182. <dt class="field-odd">Return type<span class="colon">:</span></dt>

  183. <dd class="field-odd"><p>Union[<a class="reference internal" href="#learnware.learnware.Learnware" title="learnware.learnware.Learnware">Learnware</a>, List[<a class="reference internal" href="#learnware.learnware.Learnware" title="learnware.learnware.Learnware">Learnware</a>]]</p>

  184. </dd>

  185. </dl>

  186. </dd></dl>

  187. 

  188. <dl class="py method">

  189. <dt class="sig sig-object py" id="learnware.market.LearnwareMarket.get_property_list">

  190. <span class="sig-name descname"><span class="pre">get_property_list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#learnware.market.LearnwareMarket.get_property_list" title="Permalink to this definition"></a></dt>

  191. <dd><p>Return all properties available</p>

  192. <dl class="field-list simple">

  193. <dt class="field-odd">Returns<span class="colon">:</span></dt>

  194. <dd class="field-odd"><p>All properties in dictionary format</p>

  195. </dd>

  196. <dt class="field-even">Return type<span class="colon">:</span></dt>

  197. <dd class="field-even"><p>dict</p>

  198. </dd>

  199. </dl>

  200. </dd></dl>

  201. 

  202. <dl class="py method">

  203. <dt class="sig sig-object py" id="learnware.market.LearnwareMarket.reload_market">

  204. <span class="sig-name descname"><span class="pre">reload_market</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">market_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">property_list_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">load_mode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'database'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#learnware.market.LearnwareMarket.reload_market" title="Permalink to this definition"></a></dt>

  205. <dd><p>Reload the market when server restared.</p>

  206. <dl class="field-list simple">

  207. <dt class="field-odd">Parameters<span class="colon">:</span></dt>

  208. <dd class="field-odd"><ul class="simple">

  209. <li><p><strong>market_path</strong> (<em>str</em>) – Directory for market data. ‘_IP_:_port_’ for loading from database.</p></li>

  210. <li><p><strong>property_list_path</strong> (<em>str</em>) – Directory for available properties. Should be a json file.</p></li>

  211. <li><p><strong>load_mode</strong> (<em>str</em><em>, </em><em>optional</em>) – Type of reload source. Currently, only ‘database’ is available. Defaults to ‘database’, by default “database”</p></li>

  212. </ul>

  213. </dd>

  214. <dt class="field-even">Returns<span class="colon">:</span></dt>

  215. <dd class="field-even"><p>A flag indicating whether the market is reload successfully.</p>

  216. </dd>

  217. <dt class="field-odd">Return type<span class="colon">:</span></dt>

  218. <dd class="field-odd"><p>bool</p>

  219. </dd>

  220. <dt class="field-even">Raises<span class="colon">:</span></dt>

  221. <dd class="field-even"><ul class="simple">

  222. <li><p><strong>NotImplementedError</strong> – Reload method NOT implemented. Currently, only loading from database is supported.</p></li>

  223. <li><p><strong>FileNotFoundError</strong> – Loading source/property_list NOT found. Check whether the source and property_list are available.</p></li>

  224. </ul>

  225. </dd>

  226. </dl>

  227. </dd></dl>

  228. 

  229. <dl class="py method">

  230. <dt class="sig sig-object py" id="learnware.market.LearnwareMarket.search_learnware">

  231. <span class="sig-name descname"><span class="pre">search_learnware</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target_properties</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_stat_specification</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#learnware.market.LearnwareMarket.search_learnware" title="Permalink to this definition"></a></dt>

  232. <dd><blockquote>

  233. <div><p>Search Learnware based on properties and statistical specification.</p>

  234. <ul class="simple">

  235. <li><p>Return random learnwares when both target_properties and target_stat_specification is None</p></li>

  236. <li><p>Search only based on properties when target_stat_specification is None</p></li>

  237. <li><p>Filter through properties and rank according to statistical specification otherwise</p></li>

  238. </ul>

  239. </div></blockquote>

  240. <dl class="field-list simple">

  241. <dt class="field-odd">Parameters<span class="colon">:</span></dt>

  242. <dd class="field-odd"><ul class="simple">

  243. <li><p><strong>target_properties</strong> (<em>dict</em><em>, </em><em>optional</em>) – Properties selected by user, by default None</p></li>

  244. <li><p><strong>target_stat_specification</strong> (<em>str</em><em>, </em><em>optional</em>) – statistical specification uploaded by user, by default None</p></li>

  245. </ul>

  246. </dd>

  247. <dt class="field-even">Returns<span class="colon">:</span></dt>

  248. <dd class="field-even"><p><p>return two items:</p>

  249. <ul class="simple">

  250. <li><p>first is recommended combination, None when no recommended combination is calculated or statistical specification is not provided.</p></li>

  251. <li><p>second is a list of matched learnwares</p></li>

  252. </ul>

  253. </p>

  254. </dd>

  255. <dt class="field-odd">Return type<span class="colon">:</span></dt>

  256. <dd class="field-odd"><p>Tuple[Any, Dict[str, List[Any]]]</p>

  257. </dd>

  258. <dt class="field-even">Raises<span class="colon">:</span></dt>

  259. <dd class="field-even"><p><strong>FileNotFoundError</strong> – Give file path is empty.</p>

  260. </dd>

  261. </dl>

  262. </dd></dl>

  263. 

  264. <dl class="py method">

  265. <dt class="sig sig-object py" id="learnware.market.LearnwareMarket.update_learnware">

  266. <span class="sig-name descname"><span class="pre">update_learnware</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#learnware.market.LearnwareMarket.update_learnware" title="Permalink to this definition"></a></dt>

  267. <dd><blockquote>

  268. <div><p>Update Learnware with id and content to be updated.

  269. Empty interface. TODO</p>

  270. </div></blockquote>

  271. <dl class="field-list simple">

  272. <dt class="field-odd">Parameters<span class="colon">:</span></dt>

  273. <dd class="field-odd"><p><strong>id</strong> (<em>str</em>) – id of target learnware.</p>

  274. </dd>

  275. </dl>

  276. </dd></dl>

  277. 

  278. </dd></dl>

  279. 

  280. </section>

  281. <section id="learnware">

  282. <h2>Learnware<a class="headerlink" href="#learnware" title="Permalink to this heading"></a></h2>

  283. <dl class="py class">

  284. <dt class="sig sig-object py" id="learnware.learnware.Learnware">

  285. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">learnware.learnware.</span></span><span class="sig-name descname"><span class="pre">Learnware</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">model_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">specification</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#learnware.specification.Specification" title="learnware.specification.base.Specification"><span class="pre">Specification</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">desc</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#learnware.learnware.Learnware" title="Permalink to this definition"></a></dt>

  286. <dd></dd></dl>

  287. 

  288. </section>

  289. <section id="specification">

  290. <h2>Specification<a class="headerlink" href="#specification" title="Permalink to this heading"></a></h2>

  291. <dl class="py class">

  292. <dt class="sig sig-object py" id="learnware.specification.Specification">

  293. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">learnware.specification.</span></span><span class="sig-name descname"><span class="pre">Specification</span></span><a class="headerlink" href="#learnware.specification.Specification" title="Permalink to this definition"></a></dt>

  294. <dd></dd></dl>

  295. 

  296. <dl class="py class">

  297. <dt class="sig sig-object py" id="learnware.specification.StatSpecification">

  298. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">learnware.specification.</span></span><span class="sig-name descname"><span class="pre">StatSpecification</span></span><a class="headerlink" href="#learnware.specification.StatSpecification" title="Permalink to this definition"></a></dt>

  299. <dd></dd></dl>

  300. 

  301. </section>

  302. </section>

  303. 

  304. 

  305.            </div>

  306.           </div>

  307.           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">

  308.         <a href="../components/spec.html" class="btn btn-neutral float-left" title="Specification" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>

  309.     </div>

  310. 

  311.   <hr/>

  312. 

  313.   <div role="contentinfo">

  314.     <p>&#169; Copyright 2023, LAMDA Group.</p>

  315.   </div>

  316. 

  317.   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

  318.     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>

  319.     provided by <a href="https://readthedocs.org">Read the Docs</a>.

  320.    

  321. 

  322. </footer>

  323.         </div>

  324.       </div>

  325.     </section>

  326.   </div>

  327.   <script>

  328.       jQuery(function () {

  329.           SphinxRtdTheme.Navigation.enable(true);

  330.       });

  331.   </script> 

  332. 

  333. </body>

  334. </html>