Skip to content

Latest commit

 

History

History
164 lines (118 loc) · 5.73 KB

Readme.md

File metadata and controls

164 lines (118 loc) · 5.73 KB
Raw

About this project

Project Name: Server4recog Verion: 0.8 Git Repo.: https://github.com/AtsushiHashimoto/serv4recog

What is serv4recog?

  1. A web service which provides pattern recognition interface through http GET/POST requests.
  2. JSON format input/output
  3. Group based sample management. This enable to treat several recognition tasks at the same server process.
  4. String format class ID.

Official Support OS

OSX 10.9

Download

% git clone https://github.com/AtsushiHashimoto/serv4recog.git

Requirements

mongodb: 2.6.4 http://docs.mongodb.org/manual/tutorial/install-mongodb-on-os-x/

python: 2.7.8 http://docs.python-guide.org/en/latest/starting/install/osx/

python packages: execute following commands at the cloned directory.

% pip install -r packages_requirements.txt

Settings

rename 'myapp.conf.example' to 'myapp.conf' and edit the contents for your environment.

%cp myapp.conf.example myapp.conf

give write permission to ./classifiers directory (and files if exists).

%chmod 777 classifiers
%chmod 666 classifiers/*
  • You can change the directory in myapp.conf setting.

Execute

At the serv4recog directory on a terminal, start up mongod.

% mongod --dbpath ./db

Then, start up the server on another terminal

% python app.py

Test

execute the test script.

% python script/serv4recog_tester.py

If you got recognition result without error, all the instlation processes completed. Congratulation!!

Tutorial

Protocol

Add sample

HTTP GET:

http://localhost:8080/ml/my_db/my_feature/add?json_data=${SAMPLE}

HTTP POST:

http://localhost:8080/ml/my_db/my_feature/add

  • json_data: parameters dumped as a json-format string.

  • ml : fixed path name (you can not change).

  • my_db : name of database. You can use different name for each of your application.

  • my_feature : name of feature_type. You can use any string for each type of feature vector. (e.g. rgb_histogram, hu_moment, SIFT, et al.)

  • CAUTION: In your custome applications, '{' and ':' in URL string should be url-encoded!! Please check specification of the HTTP library used in your application.

  • _ex) http://localhost:8080/ml/my_db/my_feature/add?json_data={"feature":[0.1,0.9],"ground_truth":"class001"}

${SAMPLE}

sample has following parameters.

  • feature: float array that contains feature vector
  • ex) "feature":[0.1,0.9,0.3,0.7,0.5,0.5]
  • id: sample ID
  • ex) "id":"sample00001"
  • ground_truth: teacher signal for this sample. (optional, but required as training sample.)
  • ex) "ground_truth": "class001"
  • likelihood: recognition results (only in output)
  • ex) "likelihood:{"svc::${SELECTOR}":{"class001":0.9, "class002":0.1}}
  • group: group tag that is used in ${SELECTOR}
  • ex) "group":["group01","test_samples"]

${SELECTOR}

Selector limits samples involved in the calculation.

  • id: limit samples by its ID.
  • ex) {"$or":[{"id":"sample00001"},{"id":"sample00002"}]}
  • ground_truth: limit samples by its class
  • ex) {"$or":[{"ground_truth":"class001"},{"ground_truth":"class002"}]}
  • group: limit samples by its group
  • ex) {"group":{"$all":["group01"]}}"

The format follows to pymongo. For more detail, please see online documentation http://docs.mongodb.org/manual/reference/operator/query/

Train

http://localhost:8080/ml/my_db/my_feature/svc/train?json_data={"overwrite":${BOOL}, ${CLASSIFIER-PARAMS}}

${CLASSIFIER-PARAMS}

${CLASSIFIER-PARAMS} has following parameters.

  • selector: limits training samples. (optional)
  • ex) "selector":${SELECTOR}
  • option: argument used in classifier training. (optional)
  • ex) "option":${OPTION}
  • serv4recog imprimented options
  • pca: apply principle component analysis and compress feature vectors to N dimentions.
  • sparse: convert feature vector to sparse vector (scipy.sparse.csr_matrix).
  • classifier depending options
  • http://scikit-learn.org/stable/modules/generated/sklearn.svm.SVC.html
  • class_remap: Class remapping by regular expression (for use with hierarchical ground truth labels.)
  • ex) "class_remap":{"001":".*001","002":".*002"}
  • name: Name of trained classifier data. This is used to identify the classifier at prediction. If name is set, "selector", "option", and "class_remap" can be abbreviated. (optional)
  • ex) "name":"classifier20150622"

${BOOL}

true or false

${OPTION}

A hash identifying argment name and its value for training. For SVC, refer scikit-learn SVC page http://scikit-learn.org/stable/modules/generated/sklearn.svm.SVC.html

Predict

http://localhost:8080/ml/my_db/my_feature/svc/predict?json_data={${SAMPLE}, ${CLASSIFIER-PARAMS}}

Evaluate

http://localhost:8080/ml/my_db/my_feature/svc/evaluate?json_data=${CLASSIFIER-PARAMS}

Get Samples

HTTP GET: http://localhost:8080/ml/my_db/my_feature/get_samples?json_data=${Selector}

  • return sample IDs

Get Sample Detail

HTTP GET: http://localhost:8080/ml/my_db/my_feature/get_sample_id?json_data={"id":"sample_id"}

Clear Samples

http://localhost:8080/ml/my_db/my_feature/clear_samples?json_data={"selector":${SELECTOR}}

Clear Classifier

http://localhost:8080/ml/my_db/my_feature/classifier/evaluate?json_data=$CLASSIFIER-PARAMS

Group

http://localhost:8080/ml/my_db/my_feature/group?json_data={"selector":${SELECTOR}, "group":["selected_samples01"]}

Contribution

We welocome new contributers. At first, please branch the project, edit it, and send us the editted branch!