updating documentation

_modules/MRCpy/base_mrc.html

@@ -248,16 +248,18 @@ <h1>Source code for MRCpy.base_mrc</h1><div class="highlight"><pre>
 <span class="sd">        To implement a feature mapping, please go through the</span>
 <span class="sd">        :ref:`Feature Mapping` section.</span>
 
-<span class="sd">    **phi_kwargs : Groups the multiple optional parameters</span>
-<span class="sd">                   for the corresponding feature mappings(phi).</span>
+<span class="sd">    **phi_kwargs : Additional parameters for feature mappings.</span>
+<span class="sd">                Groups the multiple optional parameters</span>
+<span class="sd">                for the corresponding feature mappings(phi).</span>
 
-<span class="sd">                   For example in case of fourier features,</span>
-<span class="sd">                   the number of features is given by `n_components`</span>
-<span class="sd">                   parameter which can be passed as argument -</span>
-<span class="sd">                   `MRC(loss=&#39;log&#39;, phi=&#39;fourier&#39;, n_components=500)`</span>
+<span class="sd">                For example in case of fourier features,</span>
+<span class="sd">                the number of features is given by `n_components`</span>
+<span class="sd">                parameter which can be passed as argument -</span>
+<span class="sd">                `MRC(loss=&#39;log&#39;, phi=&#39;fourier&#39;, n_components=500)`</span>
+
+<span class="sd">                The list of arguments for each feature mappings class</span>
+<span class="sd">                can be found in the corresponding documentation.</span>
 
-<span class="sd">                   The list of arguments for each feature mappings class</span>
-<span class="sd">                   can be found in the corresponding documentation.</span>
 <span class="sd">    Attributes</span>
 <span class="sd">    ----------</span>
 <span class="sd">    is_fitted_ : bool</span>
@@ -580,7 +582,7 @@ <h1>Source code for MRCpy.base_mrc</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>
-        &#169; Copyright 2021, Kartheek Reddy Bondugula, Santiago Mazuelas and Aritz Perez.
+        &#169; Copyright 2021, Kartheek Bondugula, Santiago Mazuelas and Aritz Perez.
 
     </p>
   </div>

_modules/MRCpy/cmrc.html

@@ -164,8 +164,8 @@
   <h1>Source code for MRCpy.cmrc</h1><div class="highlight"><pre>
 <span></span><span class="sd">&#39;&#39;&#39;Marginally Constrained Minimax Risk Classification.&#39;&#39;&#39;</span>
 
-<span class="kn">import</span> <span class="nn">warnings</span>
 <span class="kn">import</span> <span class="nn">itertools</span> <span class="k">as</span> <span class="nn">it</span>
+<span class="kn">import</span> <span class="nn">warnings</span>
 
 <span class="kn">import</span> <span class="nn">cvxpy</span> <span class="k">as</span> <span class="nn">cvx</span>
 <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
@@ -247,16 +247,17 @@ <h1>Source code for MRCpy.cmrc</h1><div class="highlight"><pre>
 <span class="sd">        To implement a feature mapping, please go through the</span>
 <span class="sd">        :ref:`Feature Mapping` section.</span>
 
-<span class="sd">    **phi_kwargs : Groups the multiple optional parameters</span>
-<span class="sd">                   for the corresponding feature mappings(phi).</span>
+<span class="sd">    **phi_kwargs : Additional parameters for feature mappings.</span>
+<span class="sd">                Groups the multiple optional parameters</span>
+<span class="sd">                for the corresponding feature mappings(phi).</span>
 
-<span class="sd">                   For example in case of fourier features,</span>
-<span class="sd">                   the number of features is given by `n_components`</span>
-<span class="sd">                   parameter which can be passed as argument -</span>
-<span class="sd">                   `CMRC(loss=&#39;log&#39;, phi=&#39;fourier&#39;, n_components=500)`</span>
+<span class="sd">                For example in case of fourier features,</span>
+<span class="sd">                the number of features is given by `n_components`</span>
+<span class="sd">                parameter which can be passed as argument -</span>
+<span class="sd">                `MRC(loss=&#39;log&#39;, phi=&#39;fourier&#39;, n_components=500)`</span>
 
-<span class="sd">                   The list of arguments for each feature mappings class</span>
-<span class="sd">                   can be found in the corresponding documentation.</span>
+<span class="sd">                The list of arguments for each feature mappings class</span>
+<span class="sd">                can be found in the corresponding documentation.</span>
 
 <span class="sd">    Attributes</span>
 <span class="sd">    ----------</span>
@@ -728,7 +729,7 @@ <h1>Source code for MRCpy.cmrc</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>
-        &#169; Copyright 2021, Kartheek Reddy Bondugula, Santiago Mazuelas and Aritz Perez.
+        &#169; Copyright 2021, Kartheek Bondugula, Santiago Mazuelas and Aritz Perez.
 
     </p>
   </div>

_modules/MRCpy/mrc.html

@@ -164,8 +164,8 @@
   <h1>Source code for MRCpy.mrc</h1><div class="highlight"><pre>
 <span></span><span class="sd">&#39;&#39;&#39;Minimax Risk Classification.&#39;&#39;&#39;</span>
 
-<span class="kn">import</span> <span class="nn">warnings</span>
 <span class="kn">import</span> <span class="nn">itertools</span> <span class="k">as</span> <span class="nn">it</span>
+<span class="kn">import</span> <span class="nn">warnings</span>
 
 <span class="kn">import</span> <span class="nn">cvxpy</span> <span class="k">as</span> <span class="nn">cvx</span>
 <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
@@ -247,16 +247,17 @@ <h1>Source code for MRCpy.mrc</h1><div class="highlight"><pre>
 <span class="sd">        To implement a feature mapping, please go through the</span>
 <span class="sd">        :ref:`Feature Mapping` section.</span>
 
-<span class="sd">    **phi_kwargs : Groups the multiple optional parameters</span>
-<span class="sd">                   for the corresponding feature mappings.</span>
+<span class="sd">    **phi_kwargs : Additional parameters for feature mappings.</span>
+<span class="sd">                Groups the multiple optional parameters</span>
+<span class="sd">                for the corresponding feature mappings(phi).</span>
 
-<span class="sd">                   For example in case of fourier features,</span>
-<span class="sd">                   the number of features is given by `n_components`</span>
-<span class="sd">                   parameter which can be passed as argument -</span>
-<span class="sd">                   `MRC(loss=&#39;log&#39;, phi=&#39;fourier&#39;, n_components=500)`</span>
+<span class="sd">                For example in case of fourier features,</span>
+<span class="sd">                the number of features is given by `n_components`</span>
+<span class="sd">                parameter which can be passed as argument -</span>
+<span class="sd">                `MRC(loss=&#39;log&#39;, phi=&#39;fourier&#39;, n_components=500)`</span>
 
-<span class="sd">                   The list of arguments for each feature mappings class</span>
-<span class="sd">                   can be found in the corresponding documentation.</span>
+<span class="sd">                The list of arguments for each feature mappings class</span>
+<span class="sd">                can be found in the corresponding documentation.</span>
 
 <span class="sd">    Attributes</span>
 <span class="sd">    ----------</span>
@@ -818,7 +819,7 @@ <h1>Source code for MRCpy.mrc</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>
-        &#169; Copyright 2021, Kartheek Reddy Bondugula, Santiago Mazuelas and Aritz Perez.
+        &#169; Copyright 2021, Kartheek Bondugula, Santiago Mazuelas and Aritz Perez.
 
     </p>
   </div>

_modules/MRCpy/phi/base_phi.html

@@ -302,9 +302,7 @@ <h1>Source code for MRCpy.phi.base_phi</h1><div class="highlight"><pre>
 <span class="sd">        :math:`\in` X and y :math:`\in` Y.</span>
 <span class="sd">        The encodings are calculated,</span>
 <span class="sd">        corresponding to the given labels, which is used by the learning stage</span>
-<span class="sd">        for estimating the expected values of :math:`\phi`,</span>
-<span class="sd">        :math:`{\\tau}`</span>
-<span class="sd">        and :math:`\lambda`.</span>
+<span class="sd">        for estimating the expectation of :math:`\phi(x,y)`.</span>
 
 <span class="sd">        Parameters</span>
 <span class="sd">        ----------</span>
@@ -383,9 +381,9 @@ <h1>Source code for MRCpy.phi.base_phi</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="BasePhi.est_exp"><a class="viewcode-back" href="../../../generated/MRCpy.phi.BasePhi.html#MRCpy.phi.BasePhi.est_exp">[docs]</a>    <span class="k">def</span> <span class="nf">est_exp</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">Y</span><span class="p">):</span>
         <span class="sd">&#39;&#39;&#39;</span>
-<span class="sd">        Average value of :math:`\phi` in the supervised dataset (X,Y)</span>
-<span class="sd">        Used in the learning stage as an estimate</span>
-<span class="sd">        of the expected value of :math:`\phi`, :math:`{\\tau}`</span>
+<span class="sd">        Average value of :math:`\phi(x,y)` in the supervised dataset (X,Y).</span>
+<span class="sd">        Used in the learning stage to estimate</span>
+<span class="sd">        the expectation of :math:`\phi(x,y)`, denoted by :math:`{\\tau}`</span>
 
 <span class="sd">        Parameters</span>
 <span class="sd">        ----------</span>
@@ -407,10 +405,11 @@ <h1>Source code for MRCpy.phi.base_phi</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="BasePhi.est_std"><a class="viewcode-back" href="../../../generated/MRCpy.phi.BasePhi.html#MRCpy.phi.BasePhi.est_std">[docs]</a>    <span class="k">def</span> <span class="nf">est_std</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">Y</span><span class="p">):</span>
         <span class="sd">&#39;&#39;&#39;</span>
-<span class="sd">        Standard deviation of :math:`\phi` in the supervised dataset (X,Y)</span>
+<span class="sd">        Standard deviation of :math:`\phi(x,y)`</span>
+<span class="sd">        in the supervised dataset (X,Y).</span>
 <span class="sd">        Used in the learning stage</span>
-<span class="sd">        to estimate the variance in the expected value of</span>
-<span class="sd">        :math:`\phi`, :math:`\lambda`</span>
+<span class="sd">        to estimate the variance in the expectation of</span>
+<span class="sd">        :math:`\phi(x,y)`, denoted by :math:`\lambda`</span>
 
 <span class="sd">        Parameters</span>
 <span class="sd">        ----------</span>
@@ -440,7 +439,7 @@ <h1>Source code for MRCpy.phi.base_phi</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>
-        &#169; Copyright 2021, Kartheek Reddy Bondugula, Santiago Mazuelas and Aritz Perez.
+        &#169; Copyright 2021, Kartheek Bondugula, Santiago Mazuelas and Aritz Perez.
 
     </p>
   </div>

_modules/MRCpy/phi/random_fourier_phi.html

@@ -303,7 +303,7 @@ <h1>Source code for MRCpy.phi.random_fourier_phi</h1><div class="highlight"><pre
 
 <div class="viewcode-block" id="RandomFourierPhi.transform"><a class="viewcode-back" href="../../../generated/MRCpy.phi.RandomFourierPhi.html#MRCpy.phi.RandomFourierPhi.transform">[docs]</a>    <span class="k">def</span> <span class="nf">transform</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="sd">&#39;&#39;&#39;</span>
-<span class="sd">        Compute the random fourier features from the given instances.</span>
+<span class="sd">        Compute the random Fourier features ((:math:`z(x)`)).</span>
 
 <span class="sd">        Parameters</span>
 <span class="sd">        ----------</span>
@@ -439,7 +439,7 @@ <h1>Source code for MRCpy.phi.random_fourier_phi</h1><div class="highlight"><pre
 
   <div role="contentinfo">
     <p>
-        &#169; Copyright 2021, Kartheek Reddy Bondugula, Santiago Mazuelas and Aritz Perez.
+        &#169; Copyright 2021, Kartheek Bondugula, Santiago Mazuelas and Aritz Perez.
 
     </p>
   </div>

_modules/MRCpy/phi/random_relu_phi.html

@@ -186,9 +186,9 @@ <h1>Source code for MRCpy.phi.random_relu_phi</h1><div class="highlight"><pre>
 <span class="sd">    where w is a vector(dimension d) of random weights uniformly distributed</span>
 <span class="sd">    over a sphere of unit radius and</span>
 <span class="sd">    :math:`\gamma` is the scaling parameter similar</span>
-<span class="sd">    to the one in random fourier features.</span>
+<span class="sd">    to the one in random Fourier features.</span>
 
-<span class="sd">    Relu function is defined as -</span>
+<span class="sd">    ReLU function is defined as -</span>
 
 <span class="sd">    .. math::           f(x) = \max(0, x)</span>
 
@@ -304,7 +304,7 @@ <h1>Source code for MRCpy.phi.random_relu_phi</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="RandomReLUPhi.transform"><a class="viewcode-back" href="../../../generated/MRCpy.phi.RandomReLUPhi.html#MRCpy.phi.RandomReLUPhi.transform">[docs]</a>    <span class="k">def</span> <span class="nf">transform</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="sd">&#39;&#39;&#39;</span>
-<span class="sd">        Compute the ReLu Random Features from the given instances.</span>
+<span class="sd">        Compute the ReLU random features (:math:`z(x)`).</span>
 
 <span class="sd">        Parameters</span>
 <span class="sd">        ----------</span>
@@ -335,7 +335,7 @@ <h1>Source code for MRCpy.phi.random_relu_phi</h1><div class="highlight"><pre>
 
         <span class="sd">&#39;&#39;&#39;</span>
 
-<span class="sd">        Computes the scaling parameter for relu features</span>
+<span class="sd">        Computes the scaling parameter for ReLU features</span>
 <span class="sd">        using the heuristic -</span>
 
 <span class="sd">        .. math::   \sigma = median(\min(\| x_i-x_j \|^2, y_j = +1), y_i = -1)</span>
@@ -393,7 +393,7 @@ <h1>Source code for MRCpy.phi.random_relu_phi</h1><div class="highlight"><pre>
 
         <span class="sd">&#39;&#39;&#39;</span>
 
-<span class="sd">        Computes the scaling parameter for the relu features</span>
+<span class="sd">        Computes the scaling parameter for the ReLU features</span>
 <span class="sd">        using the heuristic given in the paper -</span>
 
 <span class="sd">                &quot;Compact Nonlinear Maps and Circulant Extensions&quot;</span>
@@ -446,7 +446,7 @@ <h1>Source code for MRCpy.phi.random_relu_phi</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>
-        &#169; Copyright 2021, Kartheek Reddy Bondugula, Santiago Mazuelas and Aritz Perez.
+        &#169; Copyright 2021, Kartheek Bondugula, Santiago Mazuelas and Aritz Perez.
 
     </p>
   </div>

_modules/MRCpy/phi/threshold_phi.html

@@ -350,7 +350,7 @@ <h1>Source code for MRCpy.phi.threshold_phi</h1><div class="highlight"><pre>
 
   <div role="contentinfo">
     <p>
-        &#169; Copyright 2021, Kartheek Reddy Bondugula, Santiago Mazuelas and Aritz Perez.
+        &#169; Copyright 2021, Kartheek Bondugula, Santiago Mazuelas and Aritz Perez.
 
     </p>
   </div>

_modules/index.html

@@ -178,7 +178,7 @@ <h1>All modules for which code is available</h1>
 
   <div role="contentinfo">
     <p>
-        &#169; Copyright 2021, Kartheek Reddy Bondugula, Santiago Mazuelas and Aritz Perez.
+        &#169; Copyright 2021, Kartheek Bondugula, Santiago Mazuelas and Aritz Perez.
 
     </p>
   </div>

api.html

@@ -245,7 +245,7 @@ <h2>Minimax Risk Classifiers<a class="headerlink" href="#minimax-risk-classifier
 
   <div role="contentinfo">
     <p>
-        &#169; Copyright 2021, Kartheek Reddy Bondugula, Santiago Mazuelas and Aritz Perez.
+        &#169; Copyright 2021, Kartheek Bondugula, Santiago Mazuelas and Aritz Perez.
 
     </p>
   </div>

auto_examples/customPhi.html

@@ -345,7 +345,7 @@
 
   <div role="contentinfo">
     <p>
-        &#169; Copyright 2021, Kartheek Reddy Bondugula, Santiago Mazuelas and Aritz Perez.
+        &#169; Copyright 2021, Kartheek Bondugula, Santiago Mazuelas and Aritz Perez.
 
     </p>
   </div>

auto_examples/example1.html

@@ -284,7 +284,7 @@
 
   <div role="contentinfo">
     <p>
-        &#169; Copyright 2021, Kartheek Reddy Bondugula, Santiago Mazuelas and Aritz Perez.
+        &#169; Copyright 2021, Kartheek Bondugula, Santiago Mazuelas and Aritz Perez.
 
     </p>
   </div>

auto_examples/example2.html

@@ -278,7 +278,7 @@
 
   <div role="contentinfo">
     <p>
-        &#169; Copyright 2021, Kartheek Reddy Bondugula, Santiago Mazuelas and Aritz Perez.
+        &#169; Copyright 2021, Kartheek Bondugula, Santiago Mazuelas and Aritz Perez.
 
     </p>
   </div>

auto_examples/example3.html

@@ -213,7 +213,7 @@
 
   <div role="contentinfo">
     <p>
-        &#169; Copyright 2021, Kartheek Reddy Bondugula, Santiago Mazuelas and Aritz Perez.
+        &#169; Copyright 2021, Kartheek Bondugula, Santiago Mazuelas and Aritz Perez.
 
     </p>
   </div>

auto_examples/example4.html

@@ -218,7 +218,7 @@
 
   <div role="contentinfo">
     <p>
-        &#169; Copyright 2021, Kartheek Reddy Bondugula, Santiago Mazuelas and Aritz Perez.
+        &#169; Copyright 2021, Kartheek Bondugula, Santiago Mazuelas and Aritz Perez.
 
     </p>
   </div>

auto_examples/example_for_paper.html

@@ -212,7 +212,7 @@
 
   <div role="contentinfo">
     <p>
-        &#169; Copyright 2021, Kartheek Reddy Bondugula, Santiago Mazuelas and Aritz Perez.
+        &#169; Copyright 2021, Kartheek Bondugula, Santiago Mazuelas and Aritz Perez.
 
     </p>
   </div>

auto_examples/index.html

@@ -214,7 +214,7 @@
 
   <div role="contentinfo">
     <p>
-        &#169; Copyright 2021, Kartheek Reddy Bondugula, Santiago Mazuelas and Aritz Perez.
+        &#169; Copyright 2021, Kartheek Bondugula, Santiago Mazuelas and Aritz Perez.
 
     </p>
   </div>

generated/MRCpy.BaseMRC.BaseMRC.html

@@ -177,7 +177,7 @@ <h1><a class="reference internal" href="MRCpy.BaseMRC.html#MRCpy.BaseMRC" title=
 
   <div role="contentinfo">
     <p>
-        &#169; Copyright 2021, Kartheek Reddy Bondugula, Santiago Mazuelas and Aritz Perez.
+        &#169; Copyright 2021, Kartheek Bondugula, Santiago Mazuelas and Aritz Perez.
 
     </p>
   </div>