Merge pull request 'Add README.md' (#5) from readme into main

Reviewed-on: #5

README.md

@@ -0,0 +1,40 @@
+# wko_anime-face-similarity
+Projekt przygotowany na zajęcia z widzenia komputerowego.
+
+Rozpoznaje twarz na zdjęciu wejściowym i dokonując transferu stylu do anime, porównuje zdjęcie ze zbiorem postaci
+z anime i wskazuje podobieństwa według wybranych metryk.
+
+## Instalacja
+1. Pobranie submodułów:
+    ```shell
+    $ git submodule update --init
+    ```
+2. Instalacja zależności:
+   * Windows/Linux
+     ```shell
+     $ pip install -r requirements.txt     
+     ```
+   * MacOS
+     ```shell
+     $ pip install -r requirements-osx.txt
+     ```
+3. Konfiguracja DCT-Netu (anime style transfer)
+    ```shell
+    $ cd DCT-Net && python download.py
+    ```
+4. Pobranie datasetu twarzy postaci z anime (MyAnimeList)
+    ```shell
+    $ python scrape_data.py
+    ```
+
+## Uruchomienie
+Na tę chwilę zdjęcie poddawane porównaniu to `UAM-Andre.jpg`
+```shell
+$ python main.py
+```
+
+### Walidacja
+Do walidacji metryk na postawie testowego datasetu z cosplayerami (`test_set`) uruchamiamy
+```shell
+$ python --validate_only 1
+```

requirements-osx.txt

@@ -0,0 +1,11 @@
+tensorflow-macos==2.11.0
+easydict==1.10
+numpy==1.23.1
+modelscope==1.1.3
+requests==2.28.2
+beautifulsoup4==4.11.1
+lxml==4.9.2
+opencv-python==4.7.0.68
+torch==1.13.1
+matplotlib==3.6.3
+scikit-image==0.19.3