Skip to content

Commit 7b503dd

Browse files
committed
update the documentation
1 parent ebf0d80 commit 7b503dd

42 files changed

Lines changed: 632 additions & 1972 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

_modules/MRCpy/base_mrc.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -459,7 +459,7 @@ <h1>Source code for MRCpy.base_mrc</h1><div class="highlight"><pre>
459459

460460
<span class="k">return</span> <span class="bp">self</span></div>
461461

462-
<div class="viewcode-block" id="BaseMRC.compute_features"><a class="viewcode-back" href="../../generated/MRCpy.BaseMRC.html#MRCpy.BaseMRC.compute_features">[docs]</a> <span class="k">def</span> <span class="nf">compute_features</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X</span><span class="p">):</span>
462+
<span class="k">def</span> <span class="nf">compute_features</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X</span><span class="p">):</span>
463463
<span class="sd">&#39;&#39;&#39;</span>
464464
<span class="sd"> Compute the features (without one-hot encoding) corresponding</span>
465465
<span class="sd"> to instances given for learning the classifiers (in case of</span>
@@ -476,9 +476,9 @@ <h1>Source code for MRCpy.base_mrc</h1><div class="highlight"><pre>
476476
<span class="sd"> Feature corresponding with each instance.</span>
477477
<span class="sd"> &#39;&#39;&#39;</span>
478478

479-
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">phi</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span><span class="n">X</span><span class="p">)</span></div>
479+
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">phi</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span><span class="n">X</span><span class="p">)</span>
480480

481-
<div class="viewcode-block" id="BaseMRC.compute_tau"><a class="viewcode-back" href="../../generated/MRCpy.BaseMRC.html#MRCpy.BaseMRC.compute_tau">[docs]</a> <span class="k">def</span> <span class="nf">compute_tau</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X_transform</span><span class="p">,</span> <span class="n">Y</span><span class="p">):</span>
481+
<span class="k">def</span> <span class="nf">compute_tau</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X_transform</span><span class="p">,</span> <span class="n">Y</span><span class="p">):</span>
482482
<span class="sd">&#39;&#39;&#39;</span>
483483
<span class="sd"> Compute mean estimate tau using the given training instances.</span>
484484

@@ -500,9 +500,9 @@ <h1>Source code for MRCpy.base_mrc</h1><div class="highlight"><pre>
500500
<span class="sd"> or (1, n_features) for binary classification.</span>
501501
<span class="sd"> &#39;&#39;&#39;</span>
502502

503-
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">phi</span><span class="o">.</span><span class="n">est_exp</span><span class="p">(</span><span class="n">X_transform</span><span class="p">,</span> <span class="n">Y</span><span class="p">)</span></div>
503+
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">phi</span><span class="o">.</span><span class="n">est_exp</span><span class="p">(</span><span class="n">X_transform</span><span class="p">,</span> <span class="n">Y</span><span class="p">)</span>
504504

505-
<div class="viewcode-block" id="BaseMRC.compute_lambda"><a class="viewcode-back" href="../../generated/MRCpy.BaseMRC.html#MRCpy.BaseMRC.compute_lambda">[docs]</a> <span class="k">def</span> <span class="nf">compute_lambda</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X_transform</span><span class="p">,</span> <span class="n">Y</span><span class="p">,</span> <span class="n">tau_mat</span><span class="p">):</span>
505+
<span class="k">def</span> <span class="nf">compute_lambda</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X_transform</span><span class="p">,</span> <span class="n">Y</span><span class="p">,</span> <span class="n">tau_mat</span><span class="p">):</span>
506506
<span class="sd">&#39;&#39;&#39;</span>
507507
<span class="sd"> Compute deviation in the mean estimate tau</span>
508508
<span class="sd"> using the given training instances.</span>
@@ -528,7 +528,7 @@ <h1>Source code for MRCpy.base_mrc</h1><div class="highlight"><pre>
528528
<span class="sd"> set constraints. Shape matches tau_mat.</span>
529529
<span class="sd"> &#39;&#39;&#39;</span>
530530

531-
<span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">s</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">phi</span><span class="o">.</span><span class="n">est_std</span><span class="p">(</span><span class="n">X_transform</span><span class="p">,</span> <span class="n">Y</span><span class="p">,</span> <span class="n">tau_mat</span><span class="p">))</span> <span class="o">/</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">X_transform</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span></div>
531+
<span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">s</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">phi</span><span class="o">.</span><span class="n">est_std</span><span class="p">(</span><span class="n">X_transform</span><span class="p">,</span> <span class="n">Y</span><span class="p">,</span> <span class="n">tau_mat</span><span class="p">))</span> <span class="o">/</span> <span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">X_transform</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
532532

533533
<div class="viewcode-block" id="BaseMRC.minimax_risk"><a class="viewcode-back" href="../../generated/MRCpy.BaseMRC.html#MRCpy.BaseMRC.minimax_risk">[docs]</a> <span class="k">def</span> <span class="nf">minimax_risk</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X</span><span class="p">,</span> <span class="n">tau_mat</span><span class="p">,</span> <span class="n">lambda_mat</span><span class="p">,</span> <span class="n">n_classes</span><span class="p">):</span>
534534
<span class="sd">&#39;&#39;&#39;</span>
@@ -602,7 +602,7 @@ <h1>Source code for MRCpy.base_mrc</h1><div class="highlight"><pre>
602602
<span class="s1">&#39; This functions needs to be implemented&#39;</span> <span class="o">+</span>
603603
<span class="s1">&#39; by a sub-class implementing a MRC.&#39;</span><span class="p">)</span></div>
604604

605-
<div class="viewcode-block" id="BaseMRC.compute_phi"><a class="viewcode-back" href="../../generated/MRCpy.BaseMRC.html#MRCpy.BaseMRC.compute_phi">[docs]</a> <span class="k">def</span> <span class="nf">compute_phi</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X</span><span class="p">):</span>
605+
<span class="k">def</span> <span class="nf">compute_phi</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X</span><span class="p">):</span>
606606
<span class="sd">&#39;&#39;&#39;</span>
607607
<span class="sd"> Compute the feature mapping corresponding to instances given</span>
608608
<span class="sd"> for learning the classifiers (in case of training) and</span>
@@ -614,7 +614,7 @@ <h1>Source code for MRCpy.base_mrc</h1><div class="highlight"><pre>
614614
<span class="sd"> Instances to be converted to features.</span>
615615
<span class="sd"> &#39;&#39;&#39;</span>
616616

617-
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">phi</span><span class="o">.</span><span class="n">eval_x</span><span class="p">(</span><span class="n">X</span><span class="p">)</span></div>
617+
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">phi</span><span class="o">.</span><span class="n">eval_x</span><span class="p">(</span><span class="n">X</span><span class="p">)</span>
618618

619619
<div class="viewcode-block" id="BaseMRC.predict"><a class="viewcode-back" href="../../generated/MRCpy.BaseMRC.html#MRCpy.BaseMRC.predict">[docs]</a> <span class="k">def</span> <span class="nf">predict</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X</span><span class="p">):</span>
620620
<span class="sd">&#39;&#39;&#39;</span>

0 commit comments

Comments
 (0)