Update documentation

docs/_sources/index.rst.txt

@@ -17,7 +17,8 @@ Adelie documentation
 `Issue Tracker <https://github.com/JamesYang007/adelie/issues>`_ 
 
 
-Adelie is a fast and flexible Python package for solving group lasso and elastic net problems. 
+Adelie is a fast and flexible Python package for solving 
+lasso, elastic net, group lasso, and group elastic net problems. 
 It offers a general purpose group elastic net solver, 
 a wide range of matrix classes that can exploit special structure to allow large-scale inputs,
 and an assortment of generalized linear model (GLM) classes for fitting various types of data.

docs/api_reference/generated/adelie.diagnostic.DiagnosticCov.html

@@ -585,7 +585,7 @@
 <h1>adelie.diagnostic.DiagnosticCov<a class="headerlink" href="#adelie-diagnostic-diagnosticcov" title="Link to this heading">#</a></h1>
 <dl class="py class">
 <dt class="sig sig-object py" id="adelie.diagnostic.DiagnosticCov">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">adelie.diagnostic.</span></span><span class="sig-name descname"><span class="pre">DiagnosticCov</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/JamesYang007/adelie/blob/main/adelie/diagnostic.py#L1091-L1210"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#adelie.diagnostic.DiagnosticCov" title="Link to this definition">#</a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">adelie.diagnostic.</span></span><span class="sig-name descname"><span class="pre">DiagnosticCov</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/JamesYang007/adelie/blob/main/adelie/diagnostic.py#L1092-L1211"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#adelie.diagnostic.DiagnosticCov" title="Link to this definition">#</a></dt>
 <dd><p>Diagnostic class for covariance states.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -620,12 +620,12 @@ <h1>adelie.diagnostic.DiagnosticCov<a class="headerlink" href="#adelie-diagnosti
 </table>
 <dl class="py method">
 <dt class="sig sig-object py" id="adelie.diagnostic.DiagnosticCov.__init__">
-<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/JamesYang007/adelie/blob/main/adelie/diagnostic.py#L1099-L1135"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#adelie.diagnostic.DiagnosticCov.__init__" title="Link to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/JamesYang007/adelie/blob/main/adelie/diagnostic.py#L1100-L1136"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#adelie.diagnostic.DiagnosticCov.__init__" title="Link to this definition">#</a></dt>
 <dd></dd></dl>
 
 <dl class="py method">
 <dt class="sig sig-object py" id="adelie.diagnostic.DiagnosticCov.plot_benchmark">
-<span class="sig-name descname"><span class="pre">plot_benchmark</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/JamesYang007/adelie/blob/main/adelie/diagnostic.py#L1180-L1197"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#adelie.diagnostic.DiagnosticCov.plot_benchmark" title="Link to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">plot_benchmark</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/JamesYang007/adelie/blob/main/adelie/diagnostic.py#L1181-L1198"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#adelie.diagnostic.DiagnosticCov.plot_benchmark" title="Link to this definition">#</a></dt>
 <dd><p>Plots benchmark times.</p>
 <div class="admonition seealso">
 <p class="admonition-title">See also</p>
@@ -637,7 +637,7 @@ <h1>adelie.diagnostic.DiagnosticCov<a class="headerlink" href="#adelie-diagnosti
 
 <dl class="py method">
 <dt class="sig sig-object py" id="adelie.diagnostic.DiagnosticCov.plot_coefficients">
-<span class="sig-name descname"><span class="pre">plot_coefficients</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/JamesYang007/adelie/blob/main/adelie/diagnostic.py#L1137-L1150"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#adelie.diagnostic.DiagnosticCov.plot_coefficients" title="Link to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">plot_coefficients</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/JamesYang007/adelie/blob/main/adelie/diagnostic.py#L1138-L1151"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#adelie.diagnostic.DiagnosticCov.plot_coefficients" title="Link to this definition">#</a></dt>
 <dd><p>Plots the coefficient profile.</p>
 <div class="admonition seealso">
 <p class="admonition-title">See also</p>
@@ -649,7 +649,7 @@ <h1>adelie.diagnostic.DiagnosticCov<a class="headerlink" href="#adelie-diagnosti
 
 <dl class="py method">
 <dt class="sig sig-object py" id="adelie.diagnostic.DiagnosticCov.plot_devs">
-<span class="sig-name descname"><span class="pre">plot_devs</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/JamesYang007/adelie/blob/main/adelie/diagnostic.py#L1152-L1162"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#adelie.diagnostic.DiagnosticCov.plot_devs" title="Link to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">plot_devs</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/JamesYang007/adelie/blob/main/adelie/diagnostic.py#L1153-L1163"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#adelie.diagnostic.DiagnosticCov.plot_devs" title="Link to this definition">#</a></dt>
 <dd><p>Plots the deviance profile.</p>
 <div class="admonition seealso">
 <p class="admonition-title">See also</p>
@@ -661,7 +661,7 @@ <h1>adelie.diagnostic.DiagnosticCov<a class="headerlink" href="#adelie-diagnosti
 
 <dl class="py method">
 <dt class="sig sig-object py" id="adelie.diagnostic.DiagnosticCov.plot_kkt">
-<span class="sig-name descname"><span class="pre">plot_kkt</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/JamesYang007/adelie/blob/main/adelie/diagnostic.py#L1199-L1210"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#adelie.diagnostic.DiagnosticCov.plot_kkt" title="Link to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">plot_kkt</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/JamesYang007/adelie/blob/main/adelie/diagnostic.py#L1200-L1211"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#adelie.diagnostic.DiagnosticCov.plot_kkt" title="Link to this definition">#</a></dt>
 <dd><p>Plots KKT failures.</p>
 <div class="admonition seealso">
 <p class="admonition-title">See also</p>
@@ -673,7 +673,7 @@ <h1>adelie.diagnostic.DiagnosticCov<a class="headerlink" href="#adelie-diagnosti
 
 <dl class="py method">
 <dt class="sig sig-object py" id="adelie.diagnostic.DiagnosticCov.plot_set_sizes">
-<span class="sig-name descname"><span class="pre">plot_set_sizes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/JamesYang007/adelie/blob/main/adelie/diagnostic.py#L1164-L1178"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#adelie.diagnostic.DiagnosticCov.plot_set_sizes" title="Link to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">plot_set_sizes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/JamesYang007/adelie/blob/main/adelie/diagnostic.py#L1165-L1179"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#adelie.diagnostic.DiagnosticCov.plot_set_sizes" title="Link to this definition">#</a></dt>
 <dd><p>Plots the set sizes.</p>
 <div class="admonition seealso">
 <p class="admonition-title">See also</p>