Skip to content

Commit

Permalink
Update docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
risenW committed Nov 30, 2019
1 parent 3766efb commit 5cc4684
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
4 changes: 3 additions & 1 deletion datasist/visualizations.py
Expand Up @@ -556,7 +556,7 @@ def plot_confusion_matrix(y_true, y_pred, classes,

def plot_auc(labels, predictions):
'''
Compute the false positive rate, true positive rate and threshold along with the AUC
Computes and plot the false positive rate, true positive rate and threshold along with the AUC
Parameters:
--------------------
Expand Down Expand Up @@ -592,6 +592,7 @@ def plot_auc(labels, predictions):

def plot_scatter_shape(data = None, cols = None, shape_col = '', col_y = '', alpha = 0.2):
'''
Makes a scatter plot of data using shape_col as seperation.
Parameter:
data: Dataframe
Expand Down Expand Up @@ -633,6 +634,7 @@ def plot_scatter_shape(data = None, cols = None, shape_col = '', col_y = '', alp

def autoviz(data):
'''
Automatically visualize a data set. If dataset is large, autoViz uses a statistically valid sample for plotting.
Parameter:
--------------------
data: Dataframe
Expand Down
5 changes: 5 additions & 0 deletions docs/visualizations.html
Expand Up @@ -619,6 +619,7 @@ <h1 class="title">Module <code>datasist.visualizations</code></h1>

def plot_scatter_shape(data = None, cols = None, shape_col = &#39;&#39;, col_y = &#39;&#39;, alpha = 0.2):
&#39;&#39;&#39;
Makes a scatter plot of data using shape_col as seperation.
Parameter:

data: Dataframe
Expand Down Expand Up @@ -660,6 +661,7 @@ <h1 class="title">Module <code>datasist.visualizations</code></h1>

def autoviz(data):
&#39;&#39;&#39;
Automatically visualize a data set. If dataset is large, autoViz uses a statistically valid sample for plotting.
Parameter:
--------------------
data: Dataframe
Expand Down Expand Up @@ -697,6 +699,9 @@ <h2 class="section-title" id="header-functions">Functions</h2>
<span>def <span class="ident">autoviz</span></span>(<span>data)</span>
</code></dt>
<dd>
<section class="desc">
<p> Automatically visualize a data set. If dataset is large, autoViz uses a statistically valid sample for plotting.
</p>
<section class="desc"><h2 id="parameter">Parameter:</h2>
<pre><code>data: Dataframe
The data to plot
Expand Down

0 comments on commit 5cc4684

Please sign in to comment.