Skip to content

Commit 3844da7

Browse files
committed
Update README.md
1 parent 2421769 commit 3844da7

File tree

1 file changed

+21
-18
lines changed

1 file changed

+21
-18
lines changed

README.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,39 @@
1-
Orange3 Example Add-on
1+
Orange3 Scoring
22
======================
33

4-
This is an example add-on for [Orange3](http://orange.biolab.si). Add-on can extend Orange either
5-
in scripting or GUI part, or in both. We here focus on the GUI part and implement a simple (empty) widget,
6-
register it with Orange and add a new workflow with this widget to example tutorials.
4+
This is an scoring/inference add-on for [Orange3](http://orange.biolab.si). This add-on adds widgets to
5+
load [PMML](http://dmg.org/pmml/v4-4/GeneralStructure.html) and [PFA](http://dmg.org/pfa/index.html) models
6+
and score data.
77

8-
Installation
9-
------------
8+
## Dependencies
9+
To use PMML models make sure you have Java installed:
10+
- Java >= 1.8
11+
- pypmml (downloaded during installation)
1012

11-
To install the add-on, run
13+
To use PFA models:
14+
- titus2 (downloaded during installation)
1215

13-
pip install .
16+
Installation
17+
------------
1418

19+
To install the add-on using pip, run
20+
```
21+
pip install orange3-scoring
22+
```
1523
To register this add-on with Orange, but keep the code in the development directory (do not copy it to
1624
Python's site-packages directory), run
17-
25+
```
1826
pip install -e .
19-
20-
Documentation / widget help can be built by running
21-
22-
make html htmlhelp
23-
24-
from the doc directory.
27+
```
2528

2629
Usage
2730
-----
2831

2932
After the installation, the widget from this add-on is registered with Orange. To run Orange from the terminal,
3033
use
31-
34+
```
3235
python -m Orange.canvas
33-
36+
```
3437
The new widget appears in the toolbox bar under the section Example.
3538

36-
![screenshot](https://github.com/biolab/orange3-example-addon/blob/master/screenshot.png)
39+
![screenshot](https://github.com/animator/orange3-scoring/blob/master/screens/screenshot.png)

0 commit comments

Comments
 (0)