mirror/DeepCreamPy
1
0
Fork 0
mirror of https://github.com/Deepshift/DeepCreamPy.git synced 2025-01-05 21:55:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
deeppomf 2018-11-02 05:29:09 -04:00
parent 31ec2fd01d
commit dd713d476f
4 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
INSTALLATION.md
View File

@ -1,13 +1,13 @@
## Installation
# Installation
### Download Prebuilt Binaries
## 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
## 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)
### Dependencies (for running the code yourself)
- Python 3.6.7
- TensorFlow 1.10
- Keras 2.2.4

2
README.md
View File

@ -32,7 +32,7 @@ Setup:
* [Installation](INSTALLATION.md)
Usage:
* [Usage](USAGE.md)
* [Decensoring Tutorial](USAGE.md)
* [Troubleshooting for poor quality decensors](TROUBLESHOOTING.md).
Miscellaneous:

6
TROUBLESHOOTING.md
View File

@ -1,9 +1,9 @@
## Troubleshooting
# Troubleshooting
### Poor Mosaic Decensorings/Mosaic Decensoring Does Nothing
## Poor Mosaic Decensorings/Mosaic Decensoring Does Nothing
The mosaic decensoring is a WIP feature. Poor results should be expected.
### Strange Color Decensors
## Strange Color Decensors
If your decensor output looks like this, then the censored regions were not colored correctly.
![Bad decensor](/readme_images/mermaid_face_censored_bad_decensor.png)

16
USAGE.md
View File

@ -1,5 +1,5 @@
## Usage
### I. Decensoring bar censors
# 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.
@ -14,11 +14,11 @@ To expand selections in GIMP, do Select > Grow.
Save these images in the PNG format to the "decensor_input" folder.
#### A. Using the binary
### A. Using the binary
Decensor the images by double-clicking on the decensor file.
#### B. Running from scratch
### B. Running from scratch
Decensor the images by running
@ -28,7 +28,7 @@ $ python decensor.py
Decensored images will be saved to the "decensor_output" folder. Decensoring takes a few minutes per image.
### II. Decensoring mosaic censors
## 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.
@ -36,11 +36,11 @@ In addition, move the original, uncolored images into the "decensor_input_origin
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
### A. Using the binary
Decensor the images by double-clicking on the decensor_mosaic file.
#### B. Running from scratch
### B. Running from scratch
Decensor the images by running
@ -50,6 +50,6 @@ $ 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
## III. Decensoring with the user interface
To be implemented.