Readme updated

Author: animator

README.md

@@ -5,7 +5,9 @@ This is an scoring/inference add-on for [Orange3](http://orange.biolab.si). This
 load [PMML](http://dmg.org/pmml/v4-4/GeneralStructure.html) and [PFA](http://dmg.org/pfa/index.html) models 
 and score data.
 
-## Dependencies
+Dependencies
+------------
+
 To use PMML models make sure you have Java installed:
  - Java >= 1.8
  - pypmml (downloaded during installation)
@@ -18,12 +20,12 @@ Installation
 
 To install the add-on using pip, run
 ```
-    pip install orange3-scoring
+pip install orange3-scoring
 ```
 To register this add-on with Orange, but keep the code in the development directory (do not copy it to 
 Python's site-packages directory), run
 ```
-    pip install -e .
+pip install -e .
 ```
 
 Usage
@@ -32,8 +34,61 @@ Usage
 After the installation, the widget from this add-on is registered with Orange. To run Orange from the terminal,
 use
 ```
-    python -m Orange.canvas
+python -m Orange.canvas
 ```
-The new widget appears in the toolbox bar under the section Example.
+The new widget appears in the toolbox bar under the section `Scoring`.
+
+![01_intro](https://github.com/animator/orange3-scoring/blob/master/screens/01_intro.PNG)
+
+Drag and drop the `Load PMML/PFA Model` widget.
+
+![02_loadmodel](https://github.com/animator/orange3-scoring/blob/master/screens/02_loadmodel.PNG)
+
+Load your PMML model and inspect Input and Output field(s). Sample PMML File [here](https://github.com/animator/orange3-scoring/blob/master/orangecontrib/scoring/tests/sample_pmml.xml).
+
+![03_loadmodel_pmml](https://github.com/animator/orange3-scoring/blob/master/screens/03_loadmodel_pmml.PNG)
+
+Add input dataset using `File` widget (iris) and connect the two widgets to `Evaluate PMML/PFA Model` widget. You can inspect the fields in data and the model and view Processing INFO or Errors.
+
+![04_evaluate_load](https://github.com/animator/orange3-scoring/blob/master/screens/04_evaluate_load.PNG)
+
+Now hit `Score` button to score.
+
+![05_evaluate_score](https://github.com/animator/orange3-scoring/blob/master/screens/05_evaluate_score.PNG)
+
+Connect the output to `Data Table` widget to view the results. 3 new columns (cluster, cluster_name & distance) are added after scoring the data obtained for each input record. The actual class value present in the data is also converted to metadata of the result table.
+
+![06_view_result](https://github.com/animator/orange3-scoring/blob/master/screens/06_view_result.PNG)
+
+Now lets load a PFA Model. Sample PFA File [here](https://github.com/animator/orange3-scoring/blob/master/orangecontrib/scoring/tests/sample_iris.json).
+
+![07_loadmodel_pfa](https://github.com/animator/orange3-scoring/blob/master/screens/07_loadmodel_pfa.PNG)
+
+Score the data using new PFA Model.
+
+![08_evaluate_load](https://github.com/animator/orange3-scoring/blob/master/screens/08_evaluate_load.PNG)
+
+Now hit `Score` button to score.
+
+![09_evaluate_score](https://github.com/animator/orange3-scoring/blob/master/screens/09_evaluate_score.PNG)
+
+View the results. You can see the predicted class for iris as provided by the PFA Model.
+
+![10_view_result](https://github.com/animator/orange3-scoring/blob/master/screens/10_view_result.PNG)
+
+Another output signal is produced which contains the `Evaluation Results` which can be connected to `Confusion Matrix`, `ROC Analysis` and `Lift Curve` widgets. We can connect it to the `Confusion Matrix` widget to view the difference in predicted and actual results.
+
+![11_view_confusion](https://github.com/animator/orange3-scoring/blob/master/screens/11_view_confusion.PNG)
+
+
+Issues, Questions and Feature Requests
+--------------------------------------
+
+Please raise an issue/question/request [here](https://github.com/animator/orange3-scoring/issues).
+
+Development
+-----------
+
+Want to contribute? Great!
 
-![screenshot](https://github.com/animator/orange3-scoring/blob/master/screens/screenshot.png)
+Please raise an [issue](https://github.com/animator/orange3-scoring/issues) to discuss your ideas and send a [pull request](https://github.com/animator/orange3-scoring/pulls).