v4.4.0 - final

README.md

@@ -115,9 +115,6 @@ or via `conda`:
 
     $ conda install -c conda-forge atom-ml
 
-| NOTE: Since atom was already taken, download the package under the name `atom-ml`! |
-| --- |
-
 <br><br>
 
 

atom/api.py

@@ -29,7 +29,7 @@ def ATOMModel(
     fullname: str = None,
     needs_scaling: bool = False,
 ):
-    """Convert an estimator to a model that can be ingested by ATOM.
+    """Convert an estimator to a model that can be ingested by atom.
 
     This function adds the relevant attributes to the estimator so
     that they can be used when initializing the CustomModel class.

docs/API/ATOM/atomloader/index.html

@@ -572,7 +572,7 @@ <h1 id="atomloader">ATOMLoader</h1>
 <hr />
 <p><a name="atom"></a></p>
 <pre><em>function</em> <strong style="color:#008AB8">ATOMLoader</strong>(filename, data=None, transform_data=True, verbose=None)
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/api.py#L64">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/api.py#L65">[source]</a></div></pre>
 <p>Load a class instance from a pickle file. If the file is a trainer that
 was saved using <code>save_data=False</code>, you can load new data into it. For
 atom pickles, you can also apply all data transformations in the 

docs/API/ATOM/atommodel/index.html

@@ -581,8 +581,8 @@
 <h1 id="atommodel">ATOMModel</h1>
 <hr />
 <pre><em>function</em> <strong style="color:#008AB8">ATOMModel</strong>(estimator, acronym=None, fullname=None, needs_scaling=False)
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/api.py#L25">[source]</a></div></pre>
-<p>Convert an estimator to a model that can be ingested by ATOM.</p>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/api.py#L26">[source]</a></div></pre>
+<p>Convert an estimator to a model that can be ingested by atom.</p>
 <table width="100%">
 <tr>
 <td width="15%" style="vertical-align:top; background:#F5F5F5;"><strong>Parameters:</strong></td>

docs/API/data_cleaning/balancer/index.html

@@ -590,7 +590,7 @@ <h1 id="balancer">Balancer</h1>
 <hr />
 <p><a name="atom"></a></p>
 <pre><em>class</em> atom.data_cleaning.<strong style="color:#008AB8">Balancer</strong>(strategy="ADASYN", n_jobs=1, verbose=0, logger=None, random_state=None, **kwargs)
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L1071">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L1121">[source]</a></div></pre>
 <p>Balance the number of samples per class in the target column. Use only for classification tasks.
 This class can be accessed from atom through the
 <a href="../../ATOM/atomclassifier/#balance">balance</a> method. Read more in
@@ -727,7 +727,7 @@ <h2 id="methods">Methods</h2>
 <p><br /></p>
 <p><a name="log"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">log</strong>(msg, level=0)
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L315">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L318">[source]</a></div></pre>
 <p>Write a message to the logger and print it to stdout.</p>
 <table>
 <tr>
@@ -746,7 +746,7 @@ <h2 id="methods">Methods</h2>
 <p><br /></p>
 <p><a name="save"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">save</strong>(filename=None)
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L336">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L339">[source]</a></div></pre>
 <p>Save the instance to a pickle file.</p>
 <table>
 <tr>
@@ -784,7 +784,7 @@ <h2 id="methods">Methods</h2>
 <p><br /></p>
 <p><a name="transform"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">transform</strong>(X, y) 
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L1146">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L1196">[source]</a></div></pre>
 <p>Oversample or undersample the data.</p>
 <table>
 <tr>

docs/API/data_cleaning/cleaner/index.html

@@ -591,7 +591,7 @@ <h1 id="cleaner">Cleaner</h1>
 <pre><em>class</em> atom.data_cleaning.<strong style="color:#008AB8">Cleaner</strong>(prohibited_types=None, maximum_cardinality=True, minimum_cardinality=True,
                                  strip_categorical=True, drop_duplicates=False, missing_target=True,
                                  encode_target=True, verbose=0, logger=None)
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L182">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L229">[source]</a></div></pre>
 <p>Performs standard data cleaning steps on a dataset. Use the parameters to choose
 which transformations to perform. The available steps are:</p>
 <ul>
@@ -783,7 +783,7 @@ <h2 id="methods">Methods</h2>
 <p><br /></p>
 <p><a name="log"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">log</strong>(msg, level=0)
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L315">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L318">[source]</a></div></pre>
 <p>Write a message to the logger and print it to stdout.</p>
 <table>
 <tr>
@@ -802,7 +802,7 @@ <h2 id="methods">Methods</h2>
 <p><br /></p>
 <p><a name="save"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">save</strong>(filename=None)
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L336">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L339">[source]</a></div></pre>
 <p>Save the instance to a pickle file.</p>
 <table>
 <tr>
@@ -843,7 +843,7 @@ <h2 id="methods">Methods</h2>
 <p><br /></p>
 <p><a name="transform"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">transform</strong>(X, y=None) 
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L278">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L325">[source]</a></div></pre>
 <p>Apply the data cleaning steps on the data.</p>
 <table width="100%">
 <tr>

docs/API/data_cleaning/encoder/index.html

@@ -586,7 +586,7 @@ <h1 id="encoder">Encoder</h1>
 <hr />
 <pre><em>class</em> atom.data_cleaning.<strong style="color:#008AB8">Encoder</strong>(strategy="LeaveOneOut", max_onehot=10,
                                  frac_to_other=None, verbose=0, logger=None, **kwargs)
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L659">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L709">[source]</a></div></pre>
 <p>Perform encoding of categorical features. The encoding type depends on
 the number of classes in the column:</p>
 <ul>
@@ -698,7 +698,7 @@ <h2 id="methods">Methods</h2>
 <p><br></p>
 <p><a name="fit"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">fit</strong>(X, y) 
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L731">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L781">[source]</a></div></pre>
 <p>Fit to data.</p>
 <table>
 <tr>
@@ -783,7 +783,7 @@ <h2 id="methods">Methods</h2>
 <p><br /></p>
 <p><a name="log"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">log</strong>(msg, level=0)
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L315">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L318">[source]</a></div></pre>
 <p>Write a message to the logger and print it to stdout.</p>
 <table>
 <tr>
@@ -802,7 +802,7 @@ <h2 id="methods">Methods</h2>
 <p><br /></p>
 <p><a name="save"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">save</strong>(filename=None)
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L336">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L339">[source]</a></div></pre>
 <p>Save the instance to a pickle file.</p>
 <table>
 <tr>
@@ -840,7 +840,7 @@ <h2 id="methods">Methods</h2>
 <p><br /></p>
 <p><a name="transform"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">transform</strong>(X, y=None) 
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L816">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L866">[source]</a></div></pre>
 <p>Encode the data.</p>
 <table>
 <tr>

docs/API/data_cleaning/imputer/index.html

@@ -590,7 +590,7 @@ <h1 id="imputer">Imputer</h1>
 <hr />
 <pre><em>class</em> atom.data_cleaning.<strong style="color:#008AB8">Imputer</strong>(strat_num="drop", strat_cat="drop", min_frac_rows=None,
                                  min_frac_cols=None, verbose=0, logger=None)
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L384">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L431">[source]</a></div></pre>
 <p>Impute or remove missing values according to the selected strategy.
 Also removes rows and columns with too many missing values. Use
 the <code>missing</code> attribute to customize what are considered "missing
@@ -720,7 +720,7 @@ <h2 id="methods">Methods</h2>
 <p><br></p>
 <p><a name="fit"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">fit</strong>(X, y=None) 
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L463">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L510">[source]</a></div></pre>
 <p>Fit to data.</p>
 <table width="100%">
 <tr>
@@ -809,7 +809,7 @@ <h2 id="methods">Methods</h2>
 <p><br /></p>
 <p><a name="log"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">log</strong>(msg, level=0)
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L315">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L318">[source]</a></div></pre>
 <p>Write a message to the logger and print it to stdout.</p>
 <table>
 <tr>
@@ -828,7 +828,7 @@ <h2 id="methods">Methods</h2>
 <p><br /></p>
 <p><a name="save"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">save</strong>(filename=None)
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L336">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L339">[source]</a></div></pre>
 <p>Save the instance to a pickle file.</p>
 <table>
 <tr>
@@ -866,7 +866,7 @@ <h2 id="methods">Methods</h2>
 <p><br /></p>
 <p><a name="transform"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">transform</strong>(X, y=None) 
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L540">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L588">[source]</a></div></pre>
 <p>Impute the data. Note that leaving y=None can lead to inconsistencies in
  data length between X and y if rows are dropped during the transformation.</p>
 <table width="100%">

docs/API/data_cleaning/pruner/index.html

@@ -590,7 +590,7 @@ <h1 id="pruner">Pruner</h1>
 <hr />
 <pre><em>class</em> atom.data_cleaning.<strong style="color:#008AB8">Pruner</strong>(strategy="z-score", method="drop", max_sigma=3,
                                 include_target=False, verbose=0, logger=None, **kwargs)
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L870">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L920">[source]</a></div></pre>
 <p>Replace or remove outliers. The definition of outlier depends
 on the selected strategy and can greatly differ from one
 another. Ignores categorical columns. This class can be accessed
@@ -736,7 +736,7 @@ <h2 id="methods">Methods</h2>
 <p><br /></p>
 <p><a name="log"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">log</strong>(msg, level=0)
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L315">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L318">[source]</a></div></pre>
 <p>Write a message to the logger and print it to stdout.</p>
 <table>
 <tr>
@@ -755,7 +755,7 @@ <h2 id="methods">Methods</h2>
 <p><br /></p>
 <p><a name="save"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">save</strong>(filename=None)
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L336">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L339">[source]</a></div></pre>
 <p>Save the instance to a pickle file.</p>
 <table>
 <tr>
@@ -793,7 +793,7 @@ <h2 id="methods">Methods</h2>
 <p><br /></p>
 <p><a name="transform"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">transform</strong>(X, y=None) 
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L949">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L999">[source]</a></div></pre>
 <p>Apply the outlier strategy on the data.</p>
 <table>
 <tr>

docs/API/data_cleaning/scaler/index.html

@@ -589,7 +589,7 @@
 <h1 id="scaler">Scaler</h1>
 <hr />
 <pre><em>class</em> atom.data_cleaning.<strong style="color:#008AB8">Scaler</strong>(strategy="standard", verbose=0, logger=None)
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L71">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L118">[source]</a></div></pre>
 <p>This class applies one of sklearn's scalers. It also returns a dataframe
 when provided, and it ignores non-numerical columns (instead of raising
 an exception). This class can be accessed from atom through the
@@ -692,7 +692,7 @@ <h2 id="methods">Methods</h2>
 <p><br></p>
 <p><a name="fit"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">fit</strong>(X, y=None) 
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L120">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L167">[source]</a></div></pre>
 <p>Compute the mean and std to be used for later scaling.</p>
 <table width="100%">
 <tr>
@@ -769,7 +769,7 @@ <h2 id="methods">Methods</h2>
 <p><br /></p>
 <p><a name="log"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">log</strong>(msg, level=0)
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L315">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L318">[source]</a></div></pre>
 <p>Write a message to the logger and print it to stdout.</p>
 <table>
 <tr>
@@ -788,7 +788,7 @@ <h2 id="methods">Methods</h2>
 <p><br /></p>
 <p><a name="save"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">save</strong>(filename=None)
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#333">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#339">[source]</a></div></pre>
 <p>Save the instance to a pickle file.</p>
 <table>
 <tr>
@@ -826,7 +826,7 @@ <h2 id="methods">Methods</h2>
 <p><br /></p>
 <p><a name="transform"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">transform</strong>(X, y=None) 
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L151">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/data_cleaning.py#L198">[source]</a></div></pre>
 <p>Perform standardization by centering and scaling.</p>
 <table width="100%">
 <tr>

docs/API/feature_engineering/feature_generator/index.html

@@ -838,7 +838,7 @@ <h2 id="methods">Methods</h2>
 <p><br /></p>
 <p><a name="log"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">log</strong>(msg, level=0)
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L315">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L318">[source]</a></div></pre>
 <p>Write a message to the logger and print it to stdout.</p>
 <table>
 <tr>
@@ -857,7 +857,7 @@ <h2 id="methods">Methods</h2>
 <p><br /></p>
 <p><a name="save"></a></p>
 <pre><em>method</em> <strong style="color:#008AB8">save</strong>(filename=None)
-<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L336">[source]</a></div></pre>
+<div align="right"><a href="https://github.com/tvdboom/ATOM/blob/master/atom/basetransformer.py#L339">[source]</a></div></pre>
 <p>Save the instance to a pickle file.</p>
 <table>
 <tr>