Metadata-Version: 2.4
Name: classify_my_dataset
Version: 0.1.0
Summary: A graphic user interface program to work with labels and images in a classification dataset.
Author-email: Fernando Pujaico Rivera <fernando.pujaico.rivera@gmail.com>
Maintainer-email: Fernando Pujaico Rivera <fernando.pujaico.rivera@gmail.com>
License-Expression: GPL-3.0-only WITH Classpath-exception-2.0 OR BSD-3-Clause
Project-URL: Bug Reports, https://github.com/trucomanx-desktop/ClassifyMyDataset/issues
Project-URL: Funding, https://trucomanx.github.io/en/funding.html
Project-URL: Documentation, https://github.com/trucomanx-desktop/ClassifyMyDataset/tree/main/doc
Project-URL: Source, https://github.com/trucomanx-desktop/ClassifyMyDataset
Keywords: writing,translate
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PyQt5
Requires-Dist: pandas
Dynamic: license-file

# classify-my-dataset

A graphic user interface program to work with labels and images in a classification dataset.

![logo](https://raw.githubusercontent.com/trucomanx-desktop/ClassifyMyDataset/main/screenshot.png)

## 1. Installing

To install the package from [PyPI](https://pypi.org/project/classify_my_dataset/), follow the instructions below:


```bash
pip install --upgrade classify_my_dataset
```

Execute `which classify-my-dataset` to see where it was installed, probably in `/home/USERNAME/.local/bin/classify-my-dataset`.

### Using

To start, use the command below:

```bash
classify-my-dataset
```

Later:

* Use a `*.classify.json` file (ex:`somename.classify.json`) in the following [format](doc/CLASSIFY.JSON.md) to categorize "Happy" and "Sad":

```
[
    {
        "button_label":"Happy",
    },
    {
        "button_label":"Sad",
    }
]
```

* Use a `*.csv` file (ex: `dataset.csv`)  in the following format:
```
filepath, label
relative/path/to/image1.png,
relative/path/to/image2.png,Happy
relative/path/to/image3.png,
relative/path/to/image4.png,
```

## 2. More information

If you want more information go to [doc](https://github.com/trucomanx-desktop/ClassifyMyDataset/blob/main/doc) directory.

## 3. Buy me a coffee

If you find this tool useful and would like to support its development, you can buy me a coffee!  
Your donations help keep the project running and improve future updates.  

[☕ Buy me a coffee](https://ko-fi.com/trucomanx) 

## 4. License

This project is licensed under the GPL license. See the `LICENSE` file for more details.
