Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dgeorgiev21 committed Apr 7, 2024
1 parent 64ef9fc commit 2bcfd98
Show file tree
Hide file tree
Showing 110 changed files with 406 additions and 375 deletions.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file not shown.
Binary file modified docs/build/doctrees/preprocessing.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/synth.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 8dc05dbcadf16d0c72d16703e32690b0
config: 4120cd5746195a2fc1af6c77d5dfc838
tags: 645f666f9bcd5a90fca523b33c5a78b7
4 changes: 2 additions & 2 deletions docs/build/html/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -192,8 +192,8 @@
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ASPLS.html">ramanspy.preprocessing.baseline.ASPLS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Poly.html">ramanspy.preprocessing.baseline.Poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ModPoly.html">ramanspy.preprocessing.baseline.ModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Poly.html">ramanspy.preprocessing.baseline.Poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ModPoly.html">ramanspy.preprocessing.baseline.ModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.PenalisedPoly.html">ramanspy.preprocessing.baseline.PenalisedPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.IModPoly.html">ramanspy.preprocessing.baseline.IModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Goldindec.html">ramanspy.preprocessing.baseline.Goldindec</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.IRSQR.html">ramanspy.preprocessing.baseline.IRSQR</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.CornerCutting.html">ramanspy.preprocessing.baseline.CornerCutting</a></li>
Expand Down
253 changes: 104 additions & 149 deletions docs/build/html/_modules/ramanspy/preprocessing/baseline.html

Large diffs are not rendered by default.

70 changes: 65 additions & 5 deletions docs/build/html/_modules/ramanspy/synth/synth.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/build/html/_sources/preprocessing.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ Polynomial fitting:

baseline.Poly
baseline.ModPoly
baseline.Poly
baseline.ModPoly
baseline.PenalisedPoly
baseline.IModPoly


Other:
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/_templates/autosummary/class.html
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,8 @@
<li class="toctree-l2"><a class="reference internal" href="../../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ASPLS.html">ramanspy.preprocessing.baseline.ASPLS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Poly.html">ramanspy.preprocessing.baseline.Poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ModPoly.html">ramanspy.preprocessing.baseline.ModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Poly.html">ramanspy.preprocessing.baseline.Poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ModPoly.html">ramanspy.preprocessing.baseline.ModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.PenalisedPoly.html">ramanspy.preprocessing.baseline.PenalisedPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.IModPoly.html">ramanspy.preprocessing.baseline.IModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Goldindec.html">ramanspy.preprocessing.baseline.Goldindec</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.IRSQR.html">ramanspy.preprocessing.baseline.IRSQR</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.CornerCutting.html">ramanspy.preprocessing.baseline.CornerCutting</a></li>
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/analysis.html
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,8 @@
<li class="toctree-l2"><a class="reference internal" href="generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ASPLS.html">ramanspy.preprocessing.baseline.ASPLS</a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Poly.html">ramanspy.preprocessing.baseline.Poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ModPoly.html">ramanspy.preprocessing.baseline.ModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Poly.html">ramanspy.preprocessing.baseline.Poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ModPoly.html">ramanspy.preprocessing.baseline.ModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.PenalisedPoly.html">ramanspy.preprocessing.baseline.PenalisedPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.IModPoly.html">ramanspy.preprocessing.baseline.IModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Goldindec.html">ramanspy.preprocessing.baseline.Goldindec</a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.IRSQR.html">ramanspy.preprocessing.baseline.IRSQR</a></li>
<li class="toctree-l2"><a class="reference internal" href="generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.CornerCutting.html">ramanspy.preprocessing.baseline.CornerCutting</a></li>
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/auto_examples/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,8 @@
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ASPLS.html">ramanspy.preprocessing.baseline.ASPLS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Poly.html">ramanspy.preprocessing.baseline.Poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ModPoly.html">ramanspy.preprocessing.baseline.ModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Poly.html">ramanspy.preprocessing.baseline.Poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ModPoly.html">ramanspy.preprocessing.baseline.ModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.PenalisedPoly.html">ramanspy.preprocessing.baseline.PenalisedPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.IModPoly.html">ramanspy.preprocessing.baseline.IModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Goldindec.html">ramanspy.preprocessing.baseline.Goldindec</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.IRSQR.html">ramanspy.preprocessing.baseline.IRSQR</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.CornerCutting.html">ramanspy.preprocessing.baseline.CornerCutting</a></li>
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/auto_examples/plot_i_package_overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,8 @@
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ASPLS.html">ramanspy.preprocessing.baseline.ASPLS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Poly.html">ramanspy.preprocessing.baseline.Poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ModPoly.html">ramanspy.preprocessing.baseline.ModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Poly.html">ramanspy.preprocessing.baseline.Poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ModPoly.html">ramanspy.preprocessing.baseline.ModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.PenalisedPoly.html">ramanspy.preprocessing.baseline.PenalisedPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.IModPoly.html">ramanspy.preprocessing.baseline.IModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Goldindec.html">ramanspy.preprocessing.baseline.Goldindec</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.IRSQR.html">ramanspy.preprocessing.baseline.IRSQR</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.CornerCutting.html">ramanspy.preprocessing.baseline.CornerCutting</a></li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,8 @@
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ASPLS.html">ramanspy.preprocessing.baseline.ASPLS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Poly.html">ramanspy.preprocessing.baseline.Poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ModPoly.html">ramanspy.preprocessing.baseline.ModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Poly.html">ramanspy.preprocessing.baseline.Poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ModPoly.html">ramanspy.preprocessing.baseline.ModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.PenalisedPoly.html">ramanspy.preprocessing.baseline.PenalisedPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.IModPoly.html">ramanspy.preprocessing.baseline.IModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Goldindec.html">ramanspy.preprocessing.baseline.Goldindec</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.IRSQR.html">ramanspy.preprocessing.baseline.IRSQR</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.CornerCutting.html">ramanspy.preprocessing.baseline.CornerCutting</a></li>
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/auto_examples/plot_ii_dl_denoising.html
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,8 @@
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ASPLS.html">ramanspy.preprocessing.baseline.ASPLS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Poly.html">ramanspy.preprocessing.baseline.Poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ModPoly.html">ramanspy.preprocessing.baseline.ModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Poly.html">ramanspy.preprocessing.baseline.Poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ModPoly.html">ramanspy.preprocessing.baseline.ModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.PenalisedPoly.html">ramanspy.preprocessing.baseline.PenalisedPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.IModPoly.html">ramanspy.preprocessing.baseline.IModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Goldindec.html">ramanspy.preprocessing.baseline.Goldindec</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.IRSQR.html">ramanspy.preprocessing.baseline.IRSQR</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.CornerCutting.html">ramanspy.preprocessing.baseline.CornerCutting</a></li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,8 @@
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ASPLS.html">ramanspy.preprocessing.baseline.ASPLS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Poly.html">ramanspy.preprocessing.baseline.Poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ModPoly.html">ramanspy.preprocessing.baseline.ModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Poly.html">ramanspy.preprocessing.baseline.Poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ModPoly.html">ramanspy.preprocessing.baseline.ModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.PenalisedPoly.html">ramanspy.preprocessing.baseline.PenalisedPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.IModPoly.html">ramanspy.preprocessing.baseline.IModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Goldindec.html">ramanspy.preprocessing.baseline.Goldindec</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.IRSQR.html">ramanspy.preprocessing.baseline.IRSQR</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.CornerCutting.html">ramanspy.preprocessing.baseline.CornerCutting</a></li>
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/auto_examples/sg_execution_times.html
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,8 @@
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ASPLS.html">ramanspy.preprocessing.baseline.ASPLS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Poly.html">ramanspy.preprocessing.baseline.Poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ModPoly.html">ramanspy.preprocessing.baseline.ModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Poly.html">ramanspy.preprocessing.baseline.Poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ModPoly.html">ramanspy.preprocessing.baseline.ModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.PenalisedPoly.html">ramanspy.preprocessing.baseline.PenalisedPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.IModPoly.html">ramanspy.preprocessing.baseline.IModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Goldindec.html">ramanspy.preprocessing.baseline.Goldindec</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.IRSQR.html">ramanspy.preprocessing.baseline.IRSQR</a></li>
<li class="toctree-l2"><a class="reference internal" href="../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.CornerCutting.html">ramanspy.preprocessing.baseline.CornerCutting</a></li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,8 @@
<li class="toctree-l2"><a class="reference internal" href="../../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ASPLS.html">ramanspy.preprocessing.baseline.ASPLS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Poly.html">ramanspy.preprocessing.baseline.Poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ModPoly.html">ramanspy.preprocessing.baseline.ModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Poly.html">ramanspy.preprocessing.baseline.Poly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.ModPoly.html">ramanspy.preprocessing.baseline.ModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.PenalisedPoly.html">ramanspy.preprocessing.baseline.PenalisedPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.IModPoly.html">ramanspy.preprocessing.baseline.IModPoly</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.Goldindec.html">ramanspy.preprocessing.baseline.Goldindec</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.IRSQR.html">ramanspy.preprocessing.baseline.IRSQR</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../generated/prepprocessing/baseline/ramanspy.preprocessing.baseline.CornerCutting.html">ramanspy.preprocessing.baseline.CornerCutting</a></li>
Expand Down
Loading

0 comments on commit 2bcfd98

Please sign in to comment.