README.md 6.6 KB
Newer Older
Administrator's avatar
Administrator committed
1 2
# ReaderBench

3 4
ReaderBench is a fully functional automated software framework, designed to provide support to learners and tutors for comprehension assessment and prediction in various educational scenarios. The system makes use of text-mining techniques based on advanced natural language processing and machine learning algorithms to deliver summative and formative assessments using multiple data sets (e.g., textual materials, behavior tracks, self-explanations).

Administrator's avatar
Administrator committed
5
## Aim
6

7 8
ReaderBench targets both tutors and students by providing an integrated learning model approach including individual and collaborative learning methods, cohesion-based discourse analysis, dialogical discourse model, textual complexity evaluation, reading strategies identification, and participation and collaboration assessment. By using natural language processing techniques, the main purpose of this framework is to bind traditional learning methods with new trends and technologies to support computer supported collaborative learning (CSCL). ReaderBench, by design, is not meant to replace the tutor, but to scaffold both tutors and learners towards continuous assessment, self-assessment, collaborative evaluation of individuals' contributions, as well as the analysis of reading materials to match readers to an appropriate level of text difficulty.

Administrator's avatar
Administrator committed
9 10
## Build

Dorinela Dascalu's avatar
Dorinela Dascalu committed
11
* Version: 4.0.0
Administrator's avatar
Administrator committed
12 13 14
* Demo available online at: http://www.readerbench.com/
* Repo owner: mihai.dascalu@cs.pub.ro

15
```sh
Dorinela Dascalu's avatar
Dorinela Dascalu committed
16 17 18 19 20 21 22
mvn clean install
```

* Build without tests' running

```sh
mvn clean install -DskipTests
23 24 25 26
```

## Prerequisites

Administrator's avatar
Administrator committed
27 28
* Maven and JAVA_HOME environment variable

Dorinela Dascalu's avatar
Dorinela Dascalu committed
29 30
## Project structure (technical aspects)

Dorinela Dascalu's avatar
Dorinela Dascalu committed
31
ReaderBench is a Maven project with 7 modules:
Dorinela Dascalu's avatar
Dorinela Dascalu committed
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55

* Datasource Provider Module
* Core Services Module
* Textual complexity Module
* Comprehension Model Module
* Reading Strategies Module
* Processing Service Module
* Parallel Processing Service Module

### Dependencies between modules

* Each module uses Datasource Provide Module and Core Services Module.
* Processing Service Module uses Reading Strategies Module and Textual complexity Module
* Parallel Processing Service Module uses Processing Service Module

## Versioning

Change the version number and propagate it in all modules with the following command:

```sh
mvn versions:set -DnewVersion=x.y.z
```


Dorinela Dascalu's avatar
Dorinela Dascalu committed
56
## Versioning
Dorinela Dascalu's avatar
Dorinela Dascalu committed
57 58 59 60 61 62 63 64

Change the version number and propagate it in all modules with the following command:

```sh
mvn versions:set -DnewVersion=x.y.z
```


65 66
## Deploy

Dorinela Dascalu's avatar
Dorinela Dascalu committed
67 68
### **Allowed only for admins. If you need a new version on artifactory, please send an email to _readerbench@lists.cs.pub.ro_**

69 70

Deploy on ReaderBench Artifactory: http://artifactory.readerbench.com:8081/artifactory/webapp/
Dorinela Dascalu's avatar
Dorinela Dascalu committed
71

72
```sh
Dorinela Dascalu's avatar
Dorinela Dascalu committed
73
mvn clean install deploy
74 75
```

Dorinela Dascalu's avatar
Dorinela Dascalu committed
76 77 78 79 80
The command above will deploy all modules if it is launched from the folder parent. If you want to deploy only a specific module, launch the command from the folder module.

## Dependencies:

### Datasource Provider Module
Dorinela Dascalu's avatar
Dorinela Dascalu committed
81

Dorinela Dascalu's avatar
Dorinela Dascalu committed
82
* Maven
83
```sh
Dorinela Dascalu's avatar
Dorinela Dascalu committed
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
<dependency>
    <groupId>com.readerbench</groupId>
    <artifactId>datasource-provider</artifactId>
    <version>4.0.0</version>
</dependency>
```

* Ivy
```sh
<dependency org="com.readerbench" name="datasource-provider" rev="4.0.0">
    <artifact name="datasource-provider" ext="jar"/>
</dependency>
```

* Gradle
```sh
compile(group: 'com.readerbench', name: 'datasource-provider', version: '4.0.0')
```

* Sbt
```sh
libraryDependencies += "com.readerbench" % "datasource-provider" % "4.0.0"
```

### Core Services Module

* Maven
```sh
<dependency>
    <groupId>com.readerbench</groupId>
    <artifactId>core-services</artifactId>
    <version>4.0.0</version>
</dependency>
```

* Ivy
```sh
<dependency org="com.readerbench" name="core-services" rev="4.0.0">
    <artifact name="core-services" ext="jar"/>
</dependency>
```

* Gradle
```sh
compile(group: 'com.readerbench', name: 'core-services', version: '4.0.0')
```

* Sbt
```sh
libraryDependencies += "com.readerbench" % "core-services" % "4.0.0"
```

### Textual Complexity Module

* Maven
```sh
<dependency>
    <groupId>com.readerbench</groupId>
    <artifactId>textual-complexity</artifactId>
    <version>4.0.0</version>
</dependency>
```

* Ivy
```sh
<dependency org="com.readerbench" name="textual-complexity" rev="4.0.0">
    <artifact name="textual-complexity" ext="jar"/>
</dependency>
```

* Gradle
```sh
compile(group: 'com.readerbench', name: 'textual-complexity', version: '4.0.0')
```

* Sbt
```sh
libraryDependencies += "com.readerbench" % "textual-complexity" % "4.0.0"
```

### Comprehension Model Module

* Maven
```sh
<dependency>
    <groupId>com.readerbench</groupId>
    <artifactId>comprehension-model</artifactId>
    <version>4.0.0</version>
</dependency>
```

* Ivy
```sh
<dependency org="com.readerbench" name="comprehension-model" rev="4.0.0">
    <artifact name="comprehension-model" ext="jar"/>
</dependency>
```

* Gradle
```sh
compile(group: 'com.readerbench', name: 'comprehension-model', version: '4.0.0')
```

* Sbt
```sh
libraryDependencies += "com.readerbench" % "comprehension-model" % "4.0.0"
```

### Reading Strategies Module

* Maven
```sh
<dependency>
    <groupId>com.readerbench</groupId>
    <artifactId>reading-strategies</artifactId>
    <version>4.0.0</version>
</dependency>
```

* Ivy
```sh
<dependency org="com.readerbench" name="reading-strategies" rev="4.0.0">
    <artifact name="reading-strategies" ext="jar"/>
</dependency>
```

* Gradle
```sh
compile(group: 'com.readerbench', name: 'reading-strategies', version: '4.0.0')
```

* Sbt
```sh
libraryDependencies += "com.readerbench" % "reading-strategies" % "4.0.0"
```

### Processing Service Module

* Maven
```sh
<dependency>
    <groupId>com.readerbench</groupId>
    <artifactId>processing-service</artifactId>
    <version>4.0.0</version>
</dependency>
```

* Ivy
```sh
<dependency org="com.readerbench" name="processing-service" rev="4.0.0">
    <artifact name="processing-service" ext="jar"/>
</dependency>
```

* Gradle
```sh
compile(group: 'com.readerbench', name: 'processing-service', version: '4.0.0')
```

* Sbt
```sh
libraryDependencies += "com.readerbench" % "processing-service" % "4.0.0"
```

### Parallel Processing Service Module

* Maven
```sh
<dependency>
    <groupId>com.readerbench</groupId>
    <artifactId>parallel-processing-service</artifactId>
    <version>4.0.0</version>
</dependency>
```

* Ivy
```sh
<dependency org="com.readerbench" name="parallel-processing-service" rev="4.0.0">
    <artifact name="parallel-processing-service" ext="jar"/>
</dependency>
```

* Gradle
```sh
compile(group: 'com.readerbench', name: 'parallel-processing-service', version: '4.0.0')
```

* Sbt
```sh
libraryDependencies += "com.readerbench" % "parallel-processing-service" % "4.0.0"
274 275
```