updated readme

README.md

@@ -1,27 +1,42 @@
 # albumentations-demo
 
-This service is created to demonstrate abilities of the Albumentations - a library for efficent image augmentations.
+This service is created to demonstrate abilities of the [Albumentations](https://github.com/albumentations-team/albumentations) - a library for efficient image augmentations.
 
+## Easy start
+You can play with this service right now [https://albumentations-demo.herokuapp.com/](https://albumentations-demo.herokuapp.com/)
+(It is deployed on free service with very limited computing power and can be quite unstable)
 
-## It is currently ALPHA VERSION!
-The service still has some known bugs and requires a lot of refactoring, don't be surprised if you see any error)
-But it already works!
+If you would like to run it locally follow the installation instruction.
 
-
-## How to use:
+## Installation
 ```
 git clone https://github.com/IliaLarchenko/albumentations-demo
 cd albumentations-demo
 pip install -r requirements.txt
-streamlit run src/main.py
+streamlit run src/app.py
+```
+
+In your terminal you will see the link to the running local service similar to : 
+```console
+  You can now view your Streamlit app in your browser.
+
+  Network URL: http://YOUR_LOCAL_IP:8501
+  External URL: http://YOUR_GLOBAL_IP:8501
 ```
+Just follow the local link to use the service.
 
-And then just follow the address you see in console. You should see something similar to this:
+## How to use
 
+The interface is very simple and intuitive:
+1. On the left you have a control sidebar. You can choose the image and the transformation.
+2. After that you will see the control elements for the every parameter this transformation has.
+3. Every time you change any parameter you will see the augmented version of the image on the right side of your screen.
+4. Below the images you can find a code for calling of the augmentation with selected parameters.
+5. You can also find there the original docstring for this transformation.
 ![screenshot](docs/readme.jpg?raw=true)
 
 
-## Online playground:
-You can also play with the current deployed version:
-[https://albumentations-demo.herokuapp.com/](https://albumentations-demo.herokuapp.com/)
-It is deployed on free service with very limited computing power and can be quite unstable.
+## Links
+* Albumentations library: [github.com/albumentations-team/albumentations](https://github.com/albumentations-team/albumentations)
+* Image Source: [pexels.com/royalty-free-images](https://pexels.com/royalty-free-images/)
+* Streamlit - framework powering this app [github.com/streamlit/streamlit](https://github.com/streamlit/streamlit)  

configs/augmentations.json

@@ -1109,5 +1109,54 @@
   "ToGray": [],
   "ToSepia": [],
   "Transpose": [],
-  "VerticalFlip": []
+  "VerticalFlip": [],
+
+
+  "OpticalDistortion": [
+    {
+      "defaults": [
+        -0.3,
+        0.3
+      ],
+      "limits_list": [
+        -2.0,
+        2.0
+      ],
+      "param_name": "distort_limit",
+      "type": "num_interval"
+    },    {
+      "defaults": [-0.05, 0.05],
+      "limits_list": [
+        -1.0,
+        1.0
+      ],
+      "param_name": "shift_limit",
+      "type": "num_interval"
+    },
+    {
+      "options_list": [
+        0,
+        1,
+        2,
+        3,
+        4
+      ],
+      "param_name": "interpolation",
+      "type": "radio"
+    },
+    {
+      "options_list": [
+        0,
+        1,
+        2,
+        3,
+        4
+      ],
+      "param_name": "border_mode",
+      "type": "radio"
+    },
+    {
+      "param_name": "value",
+      "type": "rgb"
+    }]
 }