UNPKG

@modelx/jsonm

Version:

Construct AI & ML models with JSON using Typescript & Tensorflow

229 lines 9.8 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>@modelx/jsonm</title> <meta name="description" content="Documentation for @modelx/jsonm"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="assets/css/main.css"> <script async src="assets/js/search.js" id="search-script"></script> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base="."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="index.html" class="title">@modelx/jsonm</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <h1>@modelx/jsonm</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>References</h3> <ul class="tsd-index-list"> <li class="tsd-kind-reference"><a href="modules.html#model" class="tsd-kind-icon">Model</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Enumerations</h3> <ul class="tsd-index-list"> <li class="tsd-kind-enum"><a href="enums/modelcategories.html" class="tsd-kind-icon">Model<wbr>Categories</a></li> <li class="tsd-kind-enum"><a href="enums/modeltypes.html" class="tsd-kind-icon">Model<wbr>Types</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Classes</h3> <ul class="tsd-index-list"> <li class="tsd-kind-class"><a href="classes/modelx.html" class="tsd-kind-icon">ModelX</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Interfaces</h3> <ul class="tsd-index-list"> <li class="tsd-kind-interface"><a href="interfaces/sumpreviousrows.html" class="tsd-kind-icon">sum<wbr>Previous<wbr>Rows</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function"><a href="modules.html#getgeneratedstatefulfunction" class="tsd-kind-icon">get<wbr>Generated<wbr>Stateful<wbr>Function</a></li> <li class="tsd-kind-function"><a href="modules.html#sumpreviousrows" class="tsd-kind-icon">sum<wbr>Previous<wbr>Rows</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>References</h2> <section class="tsd-panel tsd-member tsd-kind-reference"> <a name="model" class="tsd-anchor"></a> <h3>Model</h3> Renames and exports <a href="classes/modelx.html">ModelX</a> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="getgeneratedstatefulfunction" class="tsd-anchor"></a> <h3>get<wbr>Generated<wbr>Stateful<wbr>Function</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">get<wbr>Generated<wbr>Stateful<wbr>Function<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">GeneratedStatefulFunctionParams</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">GeneratedStatefulFunction</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/jsonm/blob/fb6b14c/src/model.ts#L311">model.ts:311</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Takes an object that describes a function to be created from a function body string</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><p>getGeneratedStatefulFunction({ variable_name=&#39;myFunctionName&#39;, function_body=&#39;return 3&#39;, function_name_prefix=&#39;customFunction_&#39;, }) =&gt; function customFunction_myFunctionName(state){ &#39;use strict&#39;; return 3; }</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>__namedParameters: <span class="tsd-signature-type">GeneratedStatefulFunctionParams</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">GeneratedStatefulFunction</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="sumpreviousrows" class="tsd-anchor"></a> <h3>sum<wbr>Previous<wbr>Rows</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">sum<wbr>Previous<wbr>Rows<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SumPreviousRowsOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/repetere/jsonm/blob/fb6b14c/src/model.ts#L325">model.ts:325</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>options: <span class="tsd-signature-type">SumPreviousRowsOptions</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="current "> <a href="modules.html">Exports</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-reference"> <a href="modules.html#model" class="tsd-kind-icon">Model</a> </li> <li class=" tsd-kind-enum"> <a href="enums/modelcategories.html" class="tsd-kind-icon">Model<wbr>Categories</a> </li> <li class=" tsd-kind-enum"> <a href="enums/modeltypes.html" class="tsd-kind-icon">Model<wbr>Types</a> </li> <li class=" tsd-kind-class"> <a href="classes/modelx.html" class="tsd-kind-icon">ModelX</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/sumpreviousrows.html" class="tsd-kind-icon">sum<wbr>Previous<wbr>Rows</a> </li> <li class=" tsd-kind-function"> <a href="modules.html#getgeneratedstatefulfunction" class="tsd-kind-icon">get<wbr>Generated<wbr>Stateful<wbr>Function</a> </li> <li class=" tsd-kind-function"> <a href="modules.html#sumpreviousrows" class="tsd-kind-icon">sum<wbr>Previous<wbr>Rows</a> </li> </ul> </nav> </div> </div> </div> <footer> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> </ul> </div> </div> </footer> <div class="overlay"></div> <script src="assets/js/main.js"></script> </body> </html>