summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorxAlpharax <42233094+xAlpharax@users.noreply.github.com>2023-02-27 22:44:09 +0200
committerxAlpharax <42233094+xAlpharax@users.noreply.github.com>2023-02-27 22:44:09 +0200
commitbd19b46d7544ff94be0e8eaccb4e1bd18d44b996 (patch)
tree4ca021df24e00b9b8c4a219fa4dc8fea3f8d989a /README.md
parent6fe8a3228e3170600b68d9b19e3b8f07e51222fe (diff)
Multi-threaded renderer implemented successfully. Better error handling. Minor changes in multiple areas
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/README.md b/README.md
index 3a2e442..7d85cf0 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,23 @@
# neural-art
Neural Style Transfer done from the CLI using a VGG backbone and presented as an MP4.
-Weights can be downloaded from [here](https://m1.afileditch.ch/ajjMsHrRhnikrrCiUXgY.pth). The downloaded file should be placed in `./weights/` and will be ignored when pushing as per `./.gitignore`
+Weights can be downloaded from [here](https://m1.afileditch.ch/ajjMsHrRhnikrrCiUXgY.pth). The downloaded file should be placed in `./weights/` and will be ignored when pushing as seen in `./.gitignore`
### Why use this in 2023 ?
-Because style transfer hasn't changed drastically in terms of actual results in the past years. I personally find a certain beauty in inputing an image with a desired style rather than a well curated prompt with a dozen of switches. Consider using this repo as a quick *just works* solution that can run on both CPU and GPU.
+Because style transfer hasn't changed drastically in terms of actual results in the past years. I personally find a certain beauty in inputing a style and content image rather than a well curated prompt with a dozen of switches. Consider this repo as a quick *just works* solution that can run on both CPU and GPU effectively.
## Usage
-The script sits comfortably in `./stylize.sh` so just run it from the project directory:
+The script sits comfortably in `./stylize.sh` so just run it in the project directory:
```bash
./stylize.sh path/to/style_image path/to/content_image
```
+
+### Requirements
+
+All requirements are specified in `./requirements.txt` as per python etiquette:
+
+```bash
+pip install -r requirements.txt
+```