Skip to content

Commit 7cabfdc

Browse files
maasenciohmaasencioh
authored
Add sphinx documentation (#10)
1 parent c62c299 commit 7cabfdc

File tree

15 files changed

+1537
-0
lines changed

15 files changed

+1537
-0
lines changed

‎docs/_autosummary/features.html

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
2+
<!DOCTYPE html>
3+
4+
<html xmlns="http://www.w3.org/1999/xhtml">
5+
<head>
6+
<meta charset="utf-8" />
7+
<title>features &#8212; silk_ml 0.1.1 documentation</title>
8+
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
9+
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
10+
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
11+
<script type="text/javascript" src="../_static/jquery.js"></script>
12+
<script type="text/javascript" src="../_static/underscore.js"></script>
13+
<script type="text/javascript" src="../_static/doctools.js"></script>
14+
<script type="text/javascript" src="../_static/language_data.js"></script>
15+
<link rel="index" title="Index" href="../genindex.html" />
16+
<link rel="search" title="Search" href="../search.html" />
17+
<link rel="next" title="imbalanced" href="imbalanced.html" />
18+
<link rel="prev" title="classification" href="classification.html" />
19+
20+
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
21+
22+
23+
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
24+
25+
</head><body>
26+
27+
28+
<div class="document">
29+
<div class="documentwrapper">
30+
<div class="bodywrapper">
31+
32+
33+
<div class="body" role="main">
34+
35+
<div class="section" id="module-silk_ml.features">
36+
<span id="features"></span><h1>features<a class="headerlink" href="#module-silk_ml.features" title="Permalink to this headline"></a></h1>
37+
<dl class="function">
38+
<dt id="silk_ml.features.split_classes">
39+
<code class="sig-prename descclassname">silk_ml.features.</code><code class="sig-name descname">split_classes</code><span class="sig-paren">(</span><em class="sig-param">X</em>, <em class="sig-param">Y</em>, <em class="sig-param">label</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/silk_ml/features.html#split_classes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#silk_ml.features.split_classes" title="Permalink to this definition"></a></dt>
40+
<dd><p>Returns the splited value of the dataset using the requested label</p>
41+
<dl class="field-list simple">
42+
<dt class="field-odd">Parameters</dt>
43+
<dd class="field-odd"><ul class="simple">
44+
<li><p><strong>X</strong> (<em>pd.DataFrame</em>) – Main dataset with the variables</p></li>
45+
<li><p><strong>Y</strong> (<em>pd.Series</em>) – Target variable</p></li>
46+
<li><p><strong>label</strong> (<a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Name of the variable to split</p></li>
47+
</ul>
48+
</dd>
49+
<dt class="field-even">Returns</dt>
50+
<dd class="field-even"><p>The <cite>positive</cite> and <cite>negative</cite> data splited</p>
51+
</dd>
52+
<dt class="field-odd">Return type</dt>
53+
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#tuple" title="(in Python v3.7)">tuple</a>(pd.Series, pd.Series)</p>
54+
</dd>
55+
</dl>
56+
</dd></dl>
57+
58+
<dl class="function">
59+
<dt id="silk_ml.features.features_metrics">
60+
<code class="sig-prename descclassname">silk_ml.features.</code><code class="sig-name descname">features_metrics</code><span class="sig-paren">(</span><em class="sig-param">X</em>, <em class="sig-param">Y</em>, <em class="sig-param">target_name</em>, <em class="sig-param">plot=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/silk_ml/features.html#features_metrics"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#silk_ml.features.features_metrics" title="Permalink to this definition"></a></dt>
61+
<dd><p>Determines the likelihood from each variable of splitting correctly the dataset</p>
62+
<dl class="field-list simple">
63+
<dt class="field-odd">Parameters</dt>
64+
<dd class="field-odd"><ul class="simple">
65+
<li><p><strong>X</strong> (<em>pd.DataFrame</em>) – Main dataset with the variables</p></li>
66+
<li><p><strong>Y</strong> (<em>pd.Series</em>) – Target variable</p></li>
67+
<li><p><strong>target_name</strong> (<a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3.7/library/constants.html#None" title="(in Python v3.7)"><em>None</em></a>) – Target name for reports</p></li>
68+
<li><p><strong>plot</strong> (<em>'all'</em><em> or </em><em>'categorical'</em><em> or </em><em>'numerical'</em><em> or </em><a class="reference external" href="https://docs.python.org/3.7/library/constants.html#None" title="(in Python v3.7)"><em>None</em></a>) – Plots the
69+
variables, showing the difference in the classes</p></li>
70+
</ul>
71+
</dd>
72+
<dt class="field-even">Returns</dt>
73+
<dd class="field-even"><p>Table of variables and their classification tests</p>
74+
</dd>
75+
<dt class="field-odd">Return type</dt>
76+
<dd class="field-odd"><p>pd.DataFrame</p>
77+
</dd>
78+
</dl>
79+
</dd></dl>
80+
81+
</div>
82+
83+
84+
</div>
85+
86+
</div>
87+
</div>
88+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
89+
<div class="sphinxsidebarwrapper">
90+
<h1 class="logo"><a href="../index.html">silk_ml</a></h1>
91+
92+
93+
94+
95+
96+
97+
<p>
98+
<iframe src="https://ghbtns.com/github-btn.html?user=resuelve&repo=silk-ml&type=star&v=2&count=true&size=large&v=2"
99+
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
100+
</p>
101+
102+
103+
104+
105+
106+
<h3>Navigation</h3>
107+
<ul class="current">
108+
<li class="toctree-l1"><a class="reference internal" href="classification.html">classification</a></li>
109+
<li class="toctree-l1 current"><a class="current reference internal" href="#">features</a></li>
110+
<li class="toctree-l1"><a class="reference internal" href="imbalanced.html">imbalanced</a></li>
111+
<li class="toctree-l1"><a class="reference internal" href="plots.html">plots</a></li>
112+
<li class="toctree-l1"><a class="reference internal" href="train.html">train</a></li>
113+
<li class="toctree-l1"><a class="reference internal" href="scores.html">scores</a></li>
114+
</ul>
115+
116+
117+
<div id="searchbox" style="display: none" role="search">
118+
<h3 id="searchlabel">Quick search</h3>
119+
<div class="searchformwrapper">
120+
<form class="search" action="../search.html" method="get">
121+
<input type="text" name="q" aria-labelledby="searchlabel" />
122+
<input type="submit" value="Go" />
123+
</form>
124+
</div>
125+
</div>
126+
<script type="text/javascript">$('#searchbox').show(0);</script>
127+
</div>
128+
</div>
129+
<div class="clearer"></div>
130+
</div>
131+
<div class="footer">
132+
&copy;2019, Resuelve.
133+
134+
|
135+
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.1.2</a>
136+
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
137+
138+
|
139+
<a href="../_sources/_autosummary/features.rst.txt"
140+
rel="nofollow">Page source</a>
141+
</div>
142+
143+
144+
145+
146+
</body>
147+
</html>

‎docs/_autosummary/imbalanced.html

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
2+
<!DOCTYPE html>
3+
4+
<html xmlns="http://www.w3.org/1999/xhtml">
5+
<head>
6+
<meta charset="utf-8" />
7+
<title>imbalanced &#8212; silk_ml 0.1.1 documentation</title>
8+
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
9+
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
10+
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
11+
<script type="text/javascript" src="../_static/jquery.js"></script>
12+
<script type="text/javascript" src="../_static/underscore.js"></script>
13+
<script type="text/javascript" src="../_static/doctools.js"></script>
14+
<script type="text/javascript" src="../_static/language_data.js"></script>
15+
<link rel="index" title="Index" href="../genindex.html" />
16+
<link rel="search" title="Search" href="../search.html" />
17+
<link rel="next" title="plots" href="plots.html" />
18+
<link rel="prev" title="features" href="features.html" />
19+
20+
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
21+
22+
23+
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
24+
25+
</head><body>
26+
27+
28+
<div class="document">
29+
<div class="documentwrapper">
30+
<div class="bodywrapper">
31+
32+
33+
<div class="body" role="main">
34+
35+
<div class="section" id="module-silk_ml.imbalanced">
36+
<span id="imbalanced"></span><h1>imbalanced<a class="headerlink" href="#module-silk_ml.imbalanced" title="Permalink to this headline"></a></h1>
37+
<dl class="function">
38+
<dt id="silk_ml.imbalanced.resample">
39+
<code class="sig-prename descclassname">silk_ml.imbalanced.</code><code class="sig-name descname">resample</code><span class="sig-paren">(</span><em class="sig-param">X</em>, <em class="sig-param">Y</em>, <em class="sig-param">rate=0.9</em>, <em class="sig-param">strategy='hybrid'</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/silk_ml/imbalanced.html#resample"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#silk_ml.imbalanced.resample" title="Permalink to this definition"></a></dt>
40+
<dd><p>Sampling based methods to balance dataset</p>
41+
<dl class="field-list simple">
42+
<dt class="field-odd">Parameters</dt>
43+
<dd class="field-odd"><ul class="simple">
44+
<li><p><strong>X</strong> (<em>pd.DataFrame</em>) – Main dataset with the variables</p></li>
45+
<li><p><strong>Y</strong> (<em>pd.Series</em>) – Target variable</p></li>
46+
<li><p><strong>rate</strong> (<a class="reference external" href="https://docs.python.org/3.7/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – Ratio of the number of samples in the minority class over
47+
the number of samples in the majority class after resampling</p></li>
48+
<li><p><strong>strategy</strong> (<em>'hybrid' | 'over_sampling' | 'under_sampling'</em>) – Strategy to
49+
balance the dataset</p></li>
50+
</ul>
51+
</dd>
52+
</dl>
53+
</dd></dl>
54+
55+
</div>
56+
57+
58+
</div>
59+
60+
</div>
61+
</div>
62+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
63+
<div class="sphinxsidebarwrapper">
64+
<h1 class="logo"><a href="../index.html">silk_ml</a></h1>
65+
66+
67+
68+
69+
70+
71+
<p>
72+
<iframe src="https://ghbtns.com/github-btn.html?user=resuelve&repo=silk-ml&type=star&v=2&count=true&size=large&v=2"
73+
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
74+
</p>
75+
76+
77+
78+
79+
80+
<h3>Navigation</h3>
81+
<ul class="current">
82+
<li class="toctree-l1"><a class="reference internal" href="classification.html">classification</a></li>
83+
<li class="toctree-l1"><a class="reference internal" href="features.html">features</a></li>
84+
<li class="toctree-l1 current"><a class="current reference internal" href="#">imbalanced</a></li>
85+
<li class="toctree-l1"><a class="reference internal" href="plots.html">plots</a></li>
86+
<li class="toctree-l1"><a class="reference internal" href="train.html">train</a></li>
87+
<li class="toctree-l1"><a class="reference internal" href="scores.html">scores</a></li>
88+
</ul>
89+
90+
91+
<div id="searchbox" style="display: none" role="search">
92+
<h3 id="searchlabel">Quick search</h3>
93+
<div class="searchformwrapper">
94+
<form class="search" action="../search.html" method="get">
95+
<input type="text" name="q" aria-labelledby="searchlabel" />
96+
<input type="submit" value="Go" />
97+
</form>
98+
</div>
99+
</div>
100+
<script type="text/javascript">$('#searchbox').show(0);</script>
101+
</div>
102+
</div>
103+
<div class="clearer"></div>
104+
</div>
105+
<div class="footer">
106+
&copy;2019, Resuelve.
107+
108+
|
109+
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.1.2</a>
110+
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
111+
112+
|
113+
<a href="../_sources/_autosummary/imbalanced.rst.txt"
114+
rel="nofollow">Page source</a>
115+
</div>
116+
117+
118+
119+
120+
</body>
121+
</html>

0 commit comments

Comments
 (0)