---
license: cc0-1.0
language:
- en
tags:
- python
- dataset
- organization
pretty_name: Dataset Tools
---
# Dataset-Tools: A Simple Dataset Viewer for AI Art
[__How to use Dataset-Tools__](#how-to-use-dataset-tools)
[__Launching the Application__](#launching-the-application)
[__User Interface Overview__](#user-interface-overview)
[__Improve the Project__](CONTRIBUTING.md)
[__Help the Creators__](#help-the-creators)
| Badge | Description |
| :-------------------------------------- | :---------------------------------------- |
| [](https://github.com/Ktiseos-Nyx) | Our Github |
|  | Indicates the build status of the project. |
| [](https://github.com/Ktiseos-Nyx/Dataset-Tools/actions/workflows/pytest.yml) | PyTest results. |
|  | Creative Commons Zero v1.0 Universal (Public Domain Dedication) |
| [](https://discord.gg/5t2kYxt7An) | Discord Server |
| [](https://ko-fi.com/duskfallcrew) | Duskfallcrew Ko-FI |
| [](https://twitch.tv/duskfallcrew) | Watch on Twitch |
Dataset-Tools is a desktop application designed to help users browse and manage their image and text datasets, particularly those used with AI art generation tools like Stable Diffusion. Developed using PyQt6, it provides a simple and intuitive graphical interface for browsing images, viewing metadata, and examining associated text prompts. This project is inspired by tools within the AI art community (☮️[receyuki](https://github.com/receyuki/stable-diffusion-prompt-reader)🤍) and aims to empower users in improving their dataset curation workflow.
https://github.com/user-attachments/assets/f8b4187b-2603-4bae-aa4a-dc3f621b5696
## How to Use Dataset-Tools
### Requirements
To run the program, you will need the following software:
#### Python:
- [Python.org](https://www.python.org/downloads/) or [Try `uv`](https://github.com/astral-sh/uv?tab=readme-ov-file#installation)
#### Git:
- [Windows](https://gitforwindows.org/)
- [MacOS first option](https://git-scm.com/downloads/mac), [or second option](https://brew.sh/)
- [Linux](https://git-scm.com/downloads/linux)
### Launching the Application
#### 1. Open your ``terminal`` shell console of choice.🐣 (ie: ```powershell```,```cmd```,```zsh```,```bash```, etc.)
#### 2. ``git clone`` or download the Dataset-Tools repository from GitHub.
```sh
git clone https://github.com/Ktiseos-Nyx/Dataset-Tools.git
```
#### 3. Move into Dataset-Tools folder and `pip install`the required dependencies:
```sh
cd Dataset-Tools
pip install .
```
> [!NOTE]
> `uv` users
> ```sh
> cd Dataset-Tools
> uv pip install .
> ```
#### 4. Run the application with `dataset-tools` command:
```sh
dataset-tools
```
#### You're in!
### User Interface Overview
The application window has the following main components:
* **Current Folder:** Displays the path of the currently loaded folder.
* **Open Folder:** A button to select a folder containing images and text files.
* **Image List:** Displays a list of images and text files found in the selected folder.
* **Image Preview:** An area to display a selected image.
* **Metadata Box:** A text area to display the extracted metadata from the selected image (including Stable Diffusion prompt, settings, etc.).
### Managing Images and Text
* **Selecting Images:** Click on an image or text file in the list to display its preview, metadata, and associated text content.
* **Viewing Metadata:** Metadata associated with the selected image is displayed on the text area, such as steps, samplers, seeds, and more.
* **Viewing Text:** The content of any text file associated with the selected image is displayed on the text box.
## Key Features
* **Graphical User Interface (GUI):** Built with PyQt6 for a modern and cross-platform experience.
* **Image Previews:** Quickly view images in a dedicated preview area.
* **Metadata Extraction:** Extract and display relevant metadata from PNG image files, especially those generated from Stable Diffusion.
* **Text Viewing:** Display the content of text files.
* **Clear Layout:** A simple and intuitive layout, with list view on the left, and preview on the right.
## Future Developments
* **Filtering/Sorting:** Options to filter and sort files.
* **Thumbnail Generation:** Implement thumbnails for faster browsing.
* **Themes:** Introduce customizable themes for appearance.
* **Better User Experience:** Test on different operating systems and screen resolutions to optimize user experience.
* **Video Tutorials:** Create video tutorials to show users how to use the program.
* **Text Tutorials:** Create detailed tutorials in text and image to show the user how to use the program.
## Help the Creators
&color=rgb(65%2C69%2C191))
### --**__<{ Ktiseos Nyx }>__**--
is a creator collective consisting of
#### [Duskfall Portal Crew on GitHub](https://github.com/duskfallcrew)
The Duskfall Portal crew would like to thank -
* ChatGPT 3.5 & 4o: Powering innovative solutions and creative endeavors.
* Support of my peers, and the community at Large.
* [Canvas icons created by Freepik - Flaticon](https://www.flaticon.com/free-icons/canvas)
* Inspired by [receyuki/stable-diffusion-prompt-reader](https://github.com/receyuki/stable-diffusion-prompt-reader)
#### [EXDYSA on GitHub](https://github.com/exdysa)
...and more to come!