image2coloringbook / README.md
shawnljw
add usage instructions
73dce95
|
raw
history blame
916 Bytes
# image2coloringbook
![image2coloringbook](assets/image2coloringbook.png)
A simple tool that converts an image into a coloring book. It runs on a custom implementation of the k-means clustering algorithm by default but comes with the option to use scikit-learn's implementation.
This [Colab notebook](https://colab.research.google.com/drive/1S91AsP2XHUKuxtUBEaFlboWd8ScAndcz?usp=sharing) explains how the coloring books are generated.
## Usage
Once you downloaded or cloned this repo, open the directory in your terminal.
If you have conda installed:
```shell
conda env create -f environment.yml
conda activate image2coloringbook
```
Otherwise create a virtual environment and install with pip
```shell
python -m venv image2coloringbook
image2coloringbook\Scripts\activate.bat
pip install -r requirements.txt
```
Once all requirements are installed, you can run the web ui with
```shell
gradio app.py
```