mirror of
https://github.com/Deepshift/DeepCreamPy.git
synced 2025-01-05 21:55:57 +00:00
split up README
This commit is contained in:
deeppomf
parent
23817f2176
commit
31ec2fd01d
30
INSTALLATION.md
Normal file
30
INSTALLATION.md
Normal file
@ -0,0 +1,30 @@
|
||||
## Installation
|
||||
|
||||
### Download Prebuilt Binaries
|
||||
You can download the latest release [here](https://github.com/deeppomf/DeepCreamPy/releases/latest) or find all previous releases [here](https://github.com/deeppomf/DeepCreamPy/releases).
|
||||
Binary only available for Windows 64-bit.
|
||||
|
||||
### Run Code Yourself
|
||||
If you want to run the code yourself, you can clone this repo and download the model from https://drive.google.com/open?id=1byrmn6wp0r27lSXcT9MC4j-RQ2R04P1Z. Unzip the file into the /models/ folder.
|
||||
|
||||
#### Dependencies (for running the code yourself)
|
||||
- Python 3.6.7
|
||||
- TensorFlow 1.10
|
||||
- Keras 2.2.4
|
||||
- Pillow
|
||||
- h5py
|
||||
|
||||
No GPU required! Tested on Ubuntu 16.04 and Windows. Tensorflow on Windows is compatible with Python 3 and not Python 2. Tensorflow is not compatible with Python 3.7.
|
||||
|
||||
Tensorflow, Keras, Pillow, and h5py can all be installed by running in the command line
|
||||
|
||||
```
|
||||
$ pip install -r requirements.txt
|
||||
```
|
||||
|
||||
If you experience this error:
|
||||
|
||||
```
|
||||
ModuleNotFoundError: No module named '_pywrap_tensorflow_internal'
|
||||
```
|
||||
See https://github.com/deeppomf/DeepCreamPy/issues/26#issuecomment-434043166 for alternative install instructions.
|
||||
98
README.md
98
README.md
@ -16,37 +16,6 @@ DeepCreamPy has a pre-built binary for Windows 64-bit. DeepCreamPy works on Wind
|
||||
- Support for mosaic decensors (still a WIP and not very usable)
|
||||
- User interface (not usable)
|
||||
|
||||
## Installation
|
||||
|
||||
### Download Prebuilt Binaries
|
||||
You can download the latest release [here](https://github.com/deeppomf/DeepCreamPy/releases/latest) or find all previous releases [here](https://github.com/deeppomf/DeepCreamPy/releases).
|
||||
Binary only available for Windows 64-bit.
|
||||
|
||||
### Run Code Yourself
|
||||
If you want to run the code yourself, you can clone this repo and download the model from https://drive.google.com/open?id=1byrmn6wp0r27lSXcT9MC4j-RQ2R04P1Z. Unzip the file into the /models/ folder.
|
||||
|
||||
#### Dependencies (for running the code yourself)
|
||||
- Python 3.6.7
|
||||
- TensorFlow 1.10
|
||||
- Keras 2.2.4
|
||||
- Pillow
|
||||
- h5py
|
||||
|
||||
No GPU required! Tested on Ubuntu 16.04 and Windows. Tensorflow on Windows is compatible with Python 3 and not Python 2. Tensorflow is not compatible with Python 3.7.
|
||||
|
||||
Tensorflow, Keras, Pillow, and h5py can all be installed by running in the command line
|
||||
|
||||
```
|
||||
$ pip install -r requirements.txt
|
||||
```
|
||||
|
||||
If you experience this error:
|
||||
|
||||
```
|
||||
ModuleNotFoundError: No module named '_pywrap_tensorflow_internal'
|
||||
```
|
||||
See https://github.com/deeppomf/DeepCreamPy/issues/26#issuecomment-434043166 for alternative install instructions.
|
||||
|
||||
## Limitations
|
||||
The decensorship is intended to work on color hentai images that have minor to moderate censorship of the penis or vagina. If a vagina or penis is completely censored out, decensoring will be ineffective.
|
||||
|
||||
@ -58,67 +27,16 @@ It does NOT work with:
|
||||
- Censorship of anus
|
||||
- Animated gifs/videos
|
||||
|
||||
## Usage
|
||||
### I. Decensoring bar censors
|
||||
## Table of Contents
|
||||
Setup:
|
||||
* [Installation](INSTALLATION.md)
|
||||
|
||||
For each image you want to decensor, using image editing software like Photoshop or GIMP to color the areas you want to decensor the green color (0,255,0), which is a very bright green color.
|
||||
Usage:
|
||||
* [Usage](USAGE.md)
|
||||
* [Troubleshooting for poor quality decensors](TROUBLESHOOTING.md).
|
||||
|
||||
*I strongly recommend you use the pencil tool and NOT the brush tool.*
|
||||
|
||||
*If you aren't using the pencil tool, BE SURE TO TURN OFF ANTI-ALIASING on the tool you are using.*
|
||||
|
||||
I personally use the wand selection tool with anti-aliasing turned off to select the censored regions. I then expand the selections slightly, pick the color (0,255,0), and use the paint bucket tool on the selected regions.
|
||||
|
||||
To expand selections in Photoshop, do Selection > Modify > Expand or Contract.
|
||||
To expand selections in GIMP, do Select > Grow.
|
||||
|
||||
Save these images in the PNG format to the "decensor_input" folder.
|
||||
|
||||
#### A. Using the binary
|
||||
|
||||
Decensor the images by double-clicking on the decensor file.
|
||||
|
||||
#### B. Running from scratch
|
||||
|
||||
Decensor the images by running
|
||||
|
||||
```
|
||||
$ python decensor.py
|
||||
```
|
||||
|
||||
Decensored images will be saved to the "decensor_output" folder. Decensoring takes a few minutes per image.
|
||||
|
||||
### II. Decensoring mosaic censors
|
||||
|
||||
As with decensoring bar censors, perform the same steps of coloring the censored regions green and putting the colored image into the "decensor_input" folder.
|
||||
|
||||
In addition, move the original, uncolored images into the "decensor_input_original" folder. Ensure each original image has the same names as their corresponding colored version in the "decensor_input" folder.
|
||||
|
||||
For example, if the original image is called "mermaid.jpg," then you want to put this image in the "decensor_input_original" folder and, after you colored the censored regions, name the colored image "mermaid.png" and move it to the "decensor_input" folder.
|
||||
|
||||
#### A. Using the binary
|
||||
|
||||
Decensor the images by double-clicking on the decensor_mosaic file.
|
||||
|
||||
#### B. Running from scratch
|
||||
|
||||
Decensor the images by running
|
||||
|
||||
```
|
||||
$ python decensor.py --is_mosaic=True
|
||||
```
|
||||
|
||||
Decensored images will be saved to the "decensor_output" folder. Decensoring takes a few minutes per image.
|
||||
|
||||
### III. Decensoring with the user interface
|
||||
|
||||
To be implemented.
|
||||
|
||||
## Troubleshooting
|
||||
Are decensors not looking good? See [TROUBLESHOOTING.md](TROUBLESHOOTING.md).
|
||||
|
||||
## FAQ
|
||||
See [FAQ.md](FAQ.md).
|
||||
Miscellaneous:
|
||||
* [FAQ](FAQ.md)
|
||||
|
||||
## To do
|
||||
- Finish the user interface (sometime in November)
|
||||
|
||||
@ -1,5 +1,9 @@
|
||||
# Troubleshooting
|
||||
## Troubleshooting
|
||||
|
||||
### Poor Mosaic Decensorings/Mosaic Decensoring Does Nothing
|
||||
The mosaic decensoring is a WIP feature. Poor results should be expected.
|
||||
|
||||
### Strange Color Decensors
|
||||
If your decensor output looks like this, then the censored regions were not colored correctly.
|
||||
|
||||
|
||||
|
||||
55
USAGE.md
Normal file
55
USAGE.md
Normal file
@ -0,0 +1,55 @@
|
||||
## Usage
|
||||
### I. Decensoring bar censors
|
||||
|
||||
For each image you want to decensor, using image editing software like Photoshop or GIMP to color the areas you want to decensor the green color (0,255,0), which is a very bright green color.
|
||||
|
||||
*I strongly recommend you use the pencil tool and NOT the brush tool.*
|
||||
|
||||
*If you aren't using the pencil tool, BE SURE TO TURN OFF ANTI-ALIASING on the tool you are using.*
|
||||
|
||||
I personally use the wand selection tool with anti-aliasing turned off to select the censored regions. I then expand the selections slightly, pick the color (0,255,0), and use the paint bucket tool on the selected regions.
|
||||
|
||||
To expand selections in Photoshop, do Selection > Modify > Expand or Contract.
|
||||
To expand selections in GIMP, do Select > Grow.
|
||||
|
||||
Save these images in the PNG format to the "decensor_input" folder.
|
||||
|
||||
#### A. Using the binary
|
||||
|
||||
Decensor the images by double-clicking on the decensor file.
|
||||
|
||||
#### B. Running from scratch
|
||||
|
||||
Decensor the images by running
|
||||
|
||||
```
|
||||
$ python decensor.py
|
||||
```
|
||||
|
||||
Decensored images will be saved to the "decensor_output" folder. Decensoring takes a few minutes per image.
|
||||
|
||||
### II. Decensoring mosaic censors
|
||||
|
||||
As with decensoring bar censors, perform the same steps of coloring the censored regions green and putting the colored image into the "decensor_input" folder.
|
||||
|
||||
In addition, move the original, uncolored images into the "decensor_input_original" folder. Ensure each original image has the same names as their corresponding colored version in the "decensor_input" folder.
|
||||
|
||||
For example, if the original image is called "mermaid.jpg," then you want to put this image in the "decensor_input_original" folder and, after you colored the censored regions, name the colored image "mermaid.png" and move it to the "decensor_input" folder.
|
||||
|
||||
#### A. Using the binary
|
||||
|
||||
Decensor the images by double-clicking on the decensor_mosaic file.
|
||||
|
||||
#### B. Running from scratch
|
||||
|
||||
Decensor the images by running
|
||||
|
||||
```
|
||||
$ python decensor.py --is_mosaic=True
|
||||
```
|
||||
|
||||
Decensored images will be saved to the "decensor_output" folder. Decensoring takes a few minutes per image.
|
||||
|
||||
### III. Decensoring with the user interface
|
||||
|
||||
To be implemented.
|
||||
Loading…
Reference in New Issue
Block a user