Merge branch 'master' of https://github.com/FeatureLabs/auto-norm

Author: allisonportis

README.md

@@ -2,7 +2,7 @@
 
 [![CircleCI](https://circleci.com/gh/FeatureLabs/autonormalize.svg?style=shield&circle-token=b890443ca669d7e88d62ad2fd712f92951550c4a)](https://circleci.com/gh/FeatureLabs/autonormalize)
 
-AutoNormalize is a Python library for automated datatable normalization, intended for use with [Feature Tools](https://github.com/Featuretools/featuretools). AutoNormalize allows you to build an `EntitySet` from a single denormalized table and generate features for machine learning.
+AutoNormalize is a Python library for automated datatable normalization, intended for use with [Featuretools](https://github.com/Featuretools/featuretools). AutoNormalize allows you to build an `EntitySet` from a single denormalized table and generate features for machine learning.
 
 Before AutoNormalize:
 
@@ -14,7 +14,7 @@ After AutoNormalize:
 <br />
 ### Install
 ```shell
-pip install autonormalize
+pip install featuretools[autonormalize]
 ```
 ### Uninstall
 ```shell
@@ -23,40 +23,46 @@ pip uninstall autonormalize
 <br />
 
 ### API Reference
+
+#### `auto_entityset`
 ```shell
 auto_entityset(df, accuracy=0.98, index=None, name=None, time_index=None)
 ```
 Creates a normalized entityset from a dataframe.
 
-Arguments:
+**Arguments:**
 
-`df` (pd.Dataframe) : the dataframe containing data
+* `df` (pd.Dataframe) : the dataframe containing data
 
-`accuracy` (0 < float <= 1.00; default = 0.98) : the accuracy threshold required in order to conclude a dependency (i.e. with accuracy = 0.98, 0.98 of the rows must hold true the dependency LHS --> RHS)
+* `accuracy` (0 < float <= 1.00; default = 0.98) : the accuracy threshold required in order to conclude a dependency (i.e. with accuracy = 0.98, 0.98 of the rows must hold true the dependency LHS --> RHS)
 
-`index` (str, optional) : name of column that is intended index of df
+* `index` (str, optional) : name of column that is intended index of df
 
-`name` (str, optional) : the name of created EntitySet
+* `name` (str, optional) : the name of created EntitySet
 
-`time_index` (str, optional) : name of time column in the dataframe.
+* `time_index` (str, optional) : name of time column in the dataframe.
 
-Returns:
+**Returns:**
 
-`entityset` (ft.EntitySet) : created entity set
+* `entityset` (ft.EntitySet) : created entity set
 
 <br />
 
+#### `find_dependencies`
+
 ```shell
 find_dependencies(df, accuracy=0.98, index=None)
 ```
 Finds dependencies within dataframe with the DFD search algorithm.
 
-Returns:
+**Returns:**
 
-`dependencies` (Dependencies) : the dependencies found in the data within the contraints provided
+*  `dependencies` (Dependencies) : the dependencies found in the data within the contraints provided
 
 <br />
 
+#### `normalize_dataframe`
+
 ```shell
 normalize_dataframe(df, dependencies)
 ```
@@ -65,20 +71,20 @@ Normalizes dataframe based on the dependencies given. Keys for the newly created
 2) has "id" in some form in the name of an attribute 
 3) has attribute furthest to left in the table
 
-Returns:x
-
-`new_dfs` (list[pd.DataFrame]) : list of new dataframes
+**Returns:**
+* `new_dfs` (list[pd.DataFrame]) : list of new dataframes
 
 <br />
 
+#### `make_entityset`
+
 ```shell
 make_entityset(df, dependencies, name=None, time_index=None):
 ```
 Creates a normalized EntitySet from dataframe based on the dependencies given. Keys are chosen in the same fashion as for `normalize_dataframe`and a new index will be created if any key has more than a single attribute.
 
-Returns:
-
-`entityset` (ft.EntitySet) : created EntitySet
+**Returns:**
+* `entityset` (ft.EntitySet) : created EntitySet
 
 <br />
 

setup.py

@@ -10,7 +10,7 @@
     name='autonormalize',
     version='0.1.2',
     description='a library for automated table normalization',
-    url='http://featuretools.com',
+    url='https://github.com/FeatureLabs/autonormalize',
     license='BSD 3-clause',
     author='Feature Labs, Inc.',
     author_email='[email protected]',