Metadata-Version: 2.1
Name: classypandas
Version: 0.1
Summary: Quickly annotate/label your data using jupyter widgets and pandas.
Home-page: https://github.com/TMMV/classypandas
Author: Tiago Vieira
Author-email: email@tiagovieira.pt
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Framework :: Jupyter
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: pandas (>=1.0.0)
Requires-Dist: jupyter (>=1.0.0)
Requires-Dist: ipywidgets (>=7.5.1)

<img src="img/icon.jpg" alt="Classy Pandas" width='50px' align='left'/>Classy Pandas
===
### Quickly annotate/label your data using jupyter widgets and pandas.

Sometimes you have a dataset that you need to label before training your classification models or whatever. If you are already using jupyter and pandas why not do that using some ipywidgets?

### Prerequisites

What things you need to install the software and how to install them

```
pip install pandas
pip install jupyter
pip install ipywidgets
```

If you are using jupyter lab you will also need to install ipywidgets extension:
https://ipywidgets.readthedocs.io/en/latest/user_install.html

### Installing

Once you have the above installed simply run:

```
pip install classypandas
```

### Examples

You can then run the examples in the demo folder in this repository to start labelling! Since the content is displayed as html you can define your column as an html string and have it presented in the screen anyway you want it.

Code:
```
import pandas as pd
from classypandas import core

df = pd.read_csv('demo.csv')
labels = ['text', 'image', 'other']
classy = core.Classy(df, 'html', 'label', labels)
classy.display()
```

Preview:

<img src="img/example1.gif" alt="Example 1"/>


You can then, at any time check your progress:

<img src="img/example2.jpg" alt="Example 1"/>


## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details



