Skip to content

Commit

Permalink
Update doc (fix links within list ul ol)
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisgdt committed Jan 7, 2023
1 parent 9be94c7 commit d46bfbb
Show file tree
Hide file tree
Showing 47 changed files with 547 additions and 601 deletions.
54 changes: 2 additions & 52 deletions delbot-core/docs/assets/main.js

Large diffs are not rendered by default.

23 changes: 23 additions & 0 deletions delbot-core/docs/assets/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
/* Light */
--light-color-background: #f2f4f8;
--light-color-background-secondary: #eff0f1;
--light-color-warning-text: #222;
--light-color-background-warning: #e6e600;
--light-color-icon-background: var(--light-color-background);
--light-color-accent: #c5c7c9;
--light-color-text: #222;
Expand All @@ -21,6 +23,8 @@
/* Dark */
--dark-color-background: #2b2e33;
--dark-color-background-secondary: #1e2024;
--dark-color-background-warning: #bebe00;
--dark-color-warning-text: #222;
--dark-color-icon-background: var(--dark-color-background-secondary);
--dark-color-accent: #9096a2;
--dark-color-text: #f5f5f5;
Expand All @@ -42,6 +46,8 @@
:root {
--color-background: var(--light-color-background);
--color-background-secondary: var(--light-color-background-secondary);
--color-background-warning: var(--light-color-background-warning);
--color-warning-text: var(--light-color-warning-text);
--color-icon-background: var(--light-color-icon-background);
--color-accent: var(--light-color-accent);
--color-text: var(--light-color-text);
Expand All @@ -64,6 +70,8 @@
:root {
--color-background: var(--dark-color-background);
--color-background-secondary: var(--dark-color-background-secondary);
--color-background-warning: var(--dark-color-background-warning);
--color-warning-text: var(--dark-color-warning-text);
--color-icon-background: var(--dark-color-icon-background);
--color-accent: var(--dark-color-accent);
--color-text: var(--dark-color-text);
Expand Down Expand Up @@ -93,6 +101,8 @@ body {
:root[data-theme="light"] {
--color-background: var(--light-color-background);
--color-background-secondary: var(--light-color-background-secondary);
--color-background-warning: var(--light-color-background-warning);
--color-warning-text: var(--light-color-warning-text);
--color-icon-background: var(--light-color-icon-background);
--color-accent: var(--light-color-accent);
--color-text: var(--light-color-text);
Expand All @@ -113,6 +123,8 @@ body {
:root[data-theme="dark"] {
--color-background: var(--dark-color-background);
--color-background-secondary: var(--dark-color-background-secondary);
--color-background-warning: var(--dark-color-background-warning);
--color-warning-text: var(--dark-color-warning-text);
--color-icon-background: var(--dark-color-icon-background);
--color-accent: var(--dark-color-accent);
--color-text: var(--dark-color-text);
Expand All @@ -130,6 +142,11 @@ body {
--color-scheme: var(--dark-color-scheme);
}

.always-visible,
.always-visible .tsd-signatures {
display: inherit !important;
}

h1,
h2,
h3,
Expand Down Expand Up @@ -1237,6 +1254,12 @@ img {
text-decoration: line-through;
}

.warning {
padding: 1rem;
color: var(--color-warning-text);
background: var(--color-background-warning);
}

* {
scrollbar-width: thin;
scrollbar-color: var(--color-accent) var(--color-icon-background);
Expand Down
22 changes: 11 additions & 11 deletions delbot-core/docs/classes/data.Data.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ <h4>Hierarchy</h4>
<li><a href="data.DataMovementMatrix.html" class="tsd-signature-type" data-tsd-kind="Class">DataMovementMatrix</a></li>
<li><a href="data.DataFeatures.html" class="tsd-signature-type" data-tsd-kind="Class">DataFeatures</a></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/d07c50d/delbot-core/src/data.ts#L42">src/data.ts:42</a></li></ul></aside>
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/9be94c7/delbot-core/src/data.ts#L42">src/data.ts:42</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -90,7 +90,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>args: <a href="../interfaces/data.DataProperties.html" class="tsd-signature-type" data-tsd-kind="Interface">DataProperties</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="data.Data.html" class="tsd-signature-type" data-tsd-kind="Class">Data</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/d07c50d/delbot-core/src/data.ts#L67">src/data.ts:67</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/9be94c7/delbot-core/src/data.ts#L67">src/data.ts:67</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="mayNormalizeData" class="tsd-anchor"></a>
Expand All @@ -101,28 +101,28 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</co
of the model will fail.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/d07c50d/delbot-core/src/data.ts#L65">src/data.ts:65</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/9be94c7/delbot-core/src/data.ts#L65">src/data.ts:65</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="numClasses" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>num<wbr/>Classes</span><a href="#numClasses" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">num<wbr/>Classes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">1</span></div>
<div class="tsd-comment tsd-typography"><p>The number of class for labels and model output, 1 or 2 for binary classification.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/d07c50d/delbot-core/src/data.ts#L46">src/data.ts:46</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/9be94c7/delbot-core/src/data.ts#L46">src/data.ts:46</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="xSize" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>x<wbr/>Size</span><a href="#xSize" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">x<wbr/>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<div class="tsd-comment tsd-typography"><p>The second shape of all 3d tensors (or first in case we ignore the batch size), defined in subclasses.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/d07c50d/delbot-core/src/data.ts#L52">src/data.ts:52</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/9be94c7/delbot-core/src/data.ts#L52">src/data.ts:52</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="ySize" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>y<wbr/>Size</span><a href="#ySize" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">y<wbr/>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<div class="tsd-comment tsd-typography"><p>The third shape of 3d tensor (or second in case we ignore the batch size), defined in subclasses.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/d07c50d/delbot-core/src/data.ts#L58">src/data.ts:58</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/9be94c7/delbot-core/src/data.ts#L58">src/data.ts:58</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="addLabel" class="tsd-anchor"></a>
Expand All @@ -148,23 +148,23 @@ <h5>userIndex: <span class="tsd-signature-type">number</span></h5>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/d07c50d/delbot-core/src/data.ts#L82">src/data.ts:82</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/9be94c7/delbot-core/src/data.ts#L82">src/data.ts:82</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getXSize" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>getXSize</span><a href="#getXSize" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-anchor-link" id="getXSize.getXSize-1">getXSize<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getXSize.getXSize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/d07c50d/delbot-core/src/data.ts#L106">src/data.ts:106</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/9be94c7/delbot-core/src/data.ts#L106">src/data.ts:106</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getYSize" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>getYSize</span><a href="#getYSize" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-anchor-link" id="getYSize.getYSize-1">getYSize<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getYSize.getYSize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/d07c50d/delbot-core/src/data.ts#L110">src/data.ts:110</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/9be94c7/delbot-core/src/data.ts#L110">src/data.ts:110</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="loadDataSet" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagAbstract">Abstract</code> <span>load<wbr/>Data<wbr/>Set</span><a href="#loadDataSet" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
Expand Down Expand Up @@ -195,15 +195,15 @@ <h5>dataset<wbr/>Data<span class="tsd-signature-symbol">: </span><span class="ts
<li class="tsd-parameter">
<h5>dataset<wbr/>Labels<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/d07c50d/delbot-core/src/data.ts#L104">src/data.ts:104</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/9be94c7/delbot-core/src/data.ts#L104">src/data.ts:104</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="mayNormalize" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>may<wbr/>Normalize</span><a href="#mayNormalize" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-anchor-link" id="mayNormalize.mayNormalize-1">may<wbr/>Normalize<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#mayNormalize.mayNormalize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/d07c50d/delbot-core/src/data.ts#L114">src/data.ts:114</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/9be94c7/delbot-core/src/data.ts#L114">src/data.ts:114</a></li></ul></aside></li></ul></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Expand Down
Loading

0 comments on commit d46bfbb

Please # to comment.