|
|
Assuming you have created virtual machine *vmname* with Ubuntu 12.04
|
|
|
|
|
|
### 1. Preparing Environment
|
|
|
You need to install git and other dependencies:
|
|
|
```
|
|
|
sudo apt-get install autoconf bison curl gawk sqlite3 libtool build-essential libssl-dev libyaml-dev libreadline6-dev zlib1g-dev libncurses5-dev libsqlite3-dev git-core
|
|
|
```
|
|
|
|
|
|
### 2. Ruby
|
|
|
You need to install ruby 2.1.0+. You can use any method, here are [some examples](required-ruby-installation)
|
|
|
|
|
|
### 3. AnnotameLE gem installation
|
|
|
Clone AnnotameLE repo
|
|
|
```
|
|
|
git clone https://github.com/alexlag/annotamele.git
|
|
|
```
|
|
|
|
|
|
Build and install gem (you might add sudo to install command, depending on ruby installation)
|
|
|
```
|
|
|
cd annotamele
|
|
|
gem build annotamele.gemspec
|
|
|
gem install annotamele-0.1.0.gem
|
|
|
```
|
|
|
Version of gem file may vary.
|
|
|
|
|
|
### 4. Configuration
|
|
|
To create AnnotameLE instance, use *annotamele -f path/to/config.json*
|
|
|
|
|
|
Configuration file with comments(not copy-ready, json files don't support comments):
|
|
|
```ruby
|
|
|
{
|
|
|
# Either 'gem' or 'sudo gem', depends on Ruby install
|
|
|
"gem_command":"gem",
|
|
|
# Either 'rake' or 'sudo rake', depends on Ruby install
|
|
|
"rake_command":"rake",
|
|
|
# Name of you application, currently for creating app directory
|
|
|
"app_name":"test",
|
|
|
# main AnnotameLE config
|
|
|
"annotamele": {
|
|
|
# Array of types for questions
|
|
|
"types": [
|
|
|
{
|
|
|
# Either singlelabel or multilabel currently
|
|
|
"name": "singlelabel",
|
|
|
# Parameters for type
|
|
|
"params": [
|
|
|
# Question to be asked
|
|
|
"Classification question?",
|
|
|
# Array of answer options as strings
|
|
|
["Answer 1", "Answer 2"]
|
|
|
]
|
|
|
}
|
|
|
],
|
|
|
# Absolute path to dataset file
|
|
|
"dataset":"/path/to/dataset.json"
|
|
|
},
|
|
|
# Pick either you provide email options or not. Currently emails are only used in password recovery for users
|
|
|
"email_settings":true,
|
|
|
# Common options
|
|
|
"email_config": {
|
|
|
"sender": "noreply@google.com",
|
|
|
"smtp": "smtp.google.com",
|
|
|
"domain":"google.com",
|
|
|
"port": 25,
|
|
|
"username": "",
|
|
|
"password": ""
|
|
|
},
|
|
|
# Production settings, also currently irrelevant
|
|
|
"production":true,
|
|
|
"production_settings":{
|
|
|
# url to be used as base, *.at.ispras.ru for our cloud
|
|
|
"url":"test.at.ispras.ru"
|
|
|
}
|
|
|
}
|
|
|
``` |
|
|
\ No newline at end of file |