Skip to content

Commit b80dd69

Browse files
authored
Update README.md
1 parent 6ad9825 commit b80dd69

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,36 @@
22

33
[![CircleCI](https://circleci.com/gh/FeatureLabs/autonormalize.svg?style=shield&circle-token=b890443ca669d7e88d62ad2fd712f92951550c4a)](https://circleci.com/gh/FeatureLabs/autonormalize)
44

5-
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.
5+
AutoNormalize is a Python library for automated datatable normalization. It allows you to build an `EntitySet` from a single denormalized table and generate features for machine learning using [Featuretools](https://github.com/Featuretools/featuretools).
66

77
![](gif.gif)
88

9-
### Install
9+
## Getting Started
10+
* [Install](#install)
11+
* [Demos](#demos)
12+
* [API Reference](#api-reference)
13+
14+
15+
## Install
1016
```shell
1117
pip install featuretools[autonormalize]
1218
```
13-
### Uninstall
19+
#### Uninstall
1420
```shell
1521
pip uninstall autonormalize
1622
```
17-
<br />
1823

19-
### API Reference
24+
## Demos
2025

21-
#### `auto_entityset`
26+
* [Machine Learning Demo with Featuretools](https://github.com/FeatureLabs/autonormalize/blob/master/autonormalize/demos/AutoNormalize%20%2B%20FeatureTools%20Demo.ipynb)
27+
* [Kaggle Liquor Sales Dataset Demo](https://github.com/FeatureLabs/autonormalize/blob/master/autonormalize/demos/Kaggle%20Liquor%20Sales%20Dataset%20Demo.ipynb)
28+
* [Demo with Editing Dependencies](https://github.com/Featuretools/featuretools/pull/699)
29+
* [Kaggle Food Production Dataset Demo](https://github.com/FeatureLabs/autonormalize/blob/master/autonormalize/demos/Kaggle%20Food%20%20Dataset%20Demo.ipynb)
30+
31+
32+
## API Reference
33+
34+
### `auto_entityset`
2235
```shell
2336
auto_entityset(df, accuracy=0.98, index=None, name=None, time_index=None)
2437
```
@@ -40,9 +53,7 @@ Creates a normalized entityset from a dataframe.
4053

4154
* `entityset` (ft.EntitySet) : created entity set
4255

43-
<br />
44-
45-
#### `find_dependencies`
56+
### `find_dependencies`
4657

4758
```shell
4859
find_dependencies(df, accuracy=0.98, index=None)
@@ -53,9 +64,7 @@ Finds dependencies within dataframe with the DFD search algorithm.
5364

5465
* `dependencies` (Dependencies) : the dependencies found in the data within the contraints provided
5566

56-
<br />
57-
58-
#### `normalize_dataframe`
67+
### `normalize_dataframe`
5968

6069
```shell
6170
normalize_dataframe(df, dependencies)
@@ -71,7 +80,7 @@ Normalizes dataframe based on the dependencies given. Keys for the newly created
7180

7281
<br />
7382

74-
#### `make_entityset`
83+
### `make_entityset`
7584

7685
```shell
7786
make_entityset(df, dependencies, name=None, time_index=None)
@@ -84,7 +93,7 @@ Creates a normalized EntitySet from dataframe based on the dependencies given. K
8493

8594
<br />
8695

87-
#### `normalize_entity`
96+
### `normalize_entity`
8897

8998
```shell
9099
normalize_entity(es, accuracy=0.98)
@@ -101,15 +110,6 @@ Returns a new normalized `EntitySet` from an `EntitySet` with a single entity.
101110

102111
<br />
103112

104-
### Demos
105-
106-
* [Machine Learning Demo with Featuretools](https://github.com/FeatureLabs/autonormalize/blob/master/autonormalize/demos/AutoNormalize%20%2B%20FeatureTools%20Demo.ipynb)
107-
* [Kaggle Liquor Sales Dataset Demo](https://github.com/FeatureLabs/autonormalize/blob/master/autonormalize/demos/Kaggle%20Liquor%20Sales%20Dataset%20Demo.ipynb)
108-
* [Demo with Editing Dependencies](https://github.com/Featuretools/featuretools/pull/699)
109-
* [Kaggle Food Production Dataset Demo](https://github.com/FeatureLabs/autonormalize/blob/master/autonormalize/demos/Kaggle%20Food%20%20Dataset%20Demo.ipynb)
110-
111-
<br />
112-
113113
## Feature Labs
114114
<a href="https://www.featurelabs.com/">
115115
<img src="http://www.featurelabs.com/wp-content/uploads/2017/12/logo.png" alt="Featuretools" />

0 commit comments

Comments
 (0)