deepdetect_ruby 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d44f54c4ecf5c15c542c4bad2fb445ab51282200
+  data.tar.gz: 9f142b98c9dd4eeff44427d9df21b54ef018b479
+SHA512:
+  metadata.gz: 4b15d6e806686c1db88e4a4e17faf3945f5d1997374dbd8003c84592462501cc85f60d466346b52a8a5d7e4ee98625d744357c70cfb29bc9ddcdf30e550bf4cc
+  data.tar.gz: 23b1701a4dfc40331fa3a60e21f60df60d1e52f51ccbb952636ba1eb258f1722f7398e9cda97492277ddeb71cea1c25a990d60d2a5954111271ea6f534abaf1f

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at ntamvl@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in deepdetect_ruby.gemspec
+gemspec
+
+gem 'rack'
+gem 'awesome_print'
+gem 'httparty'
+# gem 'rest-client'
+# gem 'curb'

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    deepdetect_ruby (1.0.pre.beta)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.7.0)
+    httparty (0.14.0)
+      multi_xml (>= 0.5.2)
+    multi_xml (0.5.5)
+    rack (2.0.1)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 1.11)
+  deepdetect_ruby!
+  httparty
+  rack
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.13.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Tam Nguyen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tam Nguyen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,245 @@
+# DeepDetect for Ruby
+DeepDetect is a Deep Learning API and server written in C++11. It makes the state-of-the-art Deep Learning easy to work with and can easily be integrated into existing applications.
+
+## DeepDetect supports the following features:
+### General
++ High level & generic API for machine learning & deep learning
++ JSON communication format
++ Remote Python client library
++ Embedded server with support for asynchronous training calls
++ High performance, benefits from multicores and GPU
++ Flexible input / output connectors
++ Flexible template output format to simplify connection with external applications
++ Removal of database dependency and sync, as everything is organized on the filesystem
+
+### Machine Learning / Deep Learning
++ Support for state-of-the-art Deep Learning via Caffe library
++ Templates for the most useful neural architectures (e.g. Googlenet, Alexnet, NiN, mlp, convnet, logistic regression)
++ Range of built-in model assessment measures (e.g. F1, multiclass log loss, …)
++ Support for multiple Machine Learning services, training and prediction calls in parallel
++ Optimization for CPUs and GPUs
++ Supervised learning, regression and prediction over images and other numerical and textual data
+
+### Data
++ Built-in input connectors to ease the setup of a machine learning pipeline
++ Easy management for large datasets of images
++ Easy management and preprocessing for CSV data files
++ Connector to handle large collections of images with on-the-fly data augmentation (e.g. rotations, mirroring)
++ Connector to handle CSV files with preprocessing capabilities
++ Connector to handle text files
++ Output connectors for various external applications being able to be set up through templates via the API, without code (e.g. for Elasticsearch, XML, SQL, …)
+
+# Architecture Diagram
+![DeepDetect Ruby App Diagram](https://c4.staticflickr.com/6/5479/30255507155_10d1fdc799_b.jpg)
+
+## Requirements
+- Ubuntu 14.04 LTS
+- Ruby 2.2.1 or above
+- Rails 4.2.5 or above
+- DeepDetect
+- DeepDetect Dependencies:
+    - C++, gcc >= 4.8 or clang with support for C++11 (there are issues with Clang + Boost)
+    - eigen for all matrix operations
+    - glog for logging events and debug
+    - gflags for command line parsing
+    - OpenCV >= 2.4
+    - cppnetlib
+    - Boost
+    - curl
+    - curlpp
+    - utfcpp
+    - gtest for unit testing (optional)
+- Caffe Dependencies:
+    - CUDA 7 or 6.5 is required for GPU mode.
+    - BLAS via ATLAS, MKL, or OpenBLAS.
+    - protobuf
+    - IO libraries hdf5, leveldb, snappy, lmdb
+
+## Installation
+Welcome to your new gem! In this directory, you'll find the files you need in order to package your Ruby library into a gem.
+
+Put your Ruby code in the file `lib/deepdetect_ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+**Add this line to your application's Gemfile:**
+
+```ruby
+gem 'deepdetect_ruby', git: "git@github.com:pixai/deepdetect-ruby.git"
+```
+And then execute:
+```
+$ bundle
+```
+Or install it yourself as:
+```
+$ gem install deepdetect_ruby
+```
+
+## Build DeepDetect
+- On Ubuntu Linux, do:
+```
+sudo apt-get install build-essential libgoogle-glog-dev libgflags-dev libeigen3-dev libopencv-dev libcppnetlib-dev libboost-dev libboost-iostreams-dev libcurlpp-dev libcurl4-openssl-dev protobuf-compiler libopenblas-dev libhdf5-dev libprotobuf-dev libleveldb-dev libsnappy-dev liblmdb-dev libutfcpp-dev cmake
+```
+- Build from source code:
+```
+cd
+git clone git@github.com:beniz/deepdetect.git && cd deepdetect
+mkdir build && cd build
+cmake ..
+make
+```
+
+## Usage
+Configure on Rails at `config/application.rb`
+
+*for single server*
+```ruby
+DeepdetectRuby.configure do |config|
+    config.host = "http://api.pixai.com"
+    config.model_path = "/home/tamnguyen/models"
+end
+```
+
+*for multiple servers*
+```ruby
+DeepdetectRuby.configure do |config|
+    config.model_path = "/home/tamnguyen/models"
+    config.is_scaling = true
+    config.servers = "http://staging.feels.com:8080, http://127.0.0.1:8080"
+end
+```
+
+**Example config at `config/application.rb`**
+```ruby
+# begin load DeepDetect config
+config_file_path = "#{Rails.root}/config/deepdetect.json"
+model_hash = JSON.parse(File.read(config_file_path))
+model_path = model_hash["model_path"]
+DeepdetectRuby.configure do |config|
+    # config.host = "http://54.229.220.160:8080"
+    config.model_path = "#{model_path}"
+    config.debug = false
+    config.is_scaling = true
+    config.servers = "http://staging.feels.com:8080, http://127.0.0.1:8080"
+end
+# end load DeepDetect config
+```
+*with `deepdetect.json` at `config/deepdetect.json`*
+```ruby
+{
+  "model_path": "/home/ubuntu/projects/deepdetect/models"
+}
+```
+## Create a deepdetect service
+Example: Test creating a service
+```ruby
+options = {
+            "name": "tress",
+            "mllib": "caffe",
+            "description": "trees classification",
+            "type": "supervised",
+            "connector": "image",
+            "height": 224,
+            "width": 224,
+            "nclasses": 304,
+            "repository": "/home/tamnguyen/models/trees"
+            }
+
+DeepdetectRuby::Service.create(options)
+```
+*with default options*
+```ruby
+options = {
+           :name => "[name of service]",
+          :mllib => "caffe",
+    :description => "",
+           :type => "supervised",
+      :connector => "image",
+          :width => 224,
+         :height => 224,
+       :nclasses => 2,
+     :model_path => "[path to models on server]"
+}
+```
+
+## Launch a training job
+```ruby
+DeepdetectRuby::Train.launch(options = {}, is_custom_data = false)
+```
+
+## Get information on a training job
+```ruby
+DeepdetectRuby::Train.get_status(options = {})
+```
+*with default options*
+```ruby
+options = {
+        :job => 1,
+    :timeout => 20,
+    :service => "[name of service]"
+}
+```
+
+## Delete a training job
+```ruby
+DeepdetectRuby::Train.delete(options = {})
+```
+*with default options*
+```ruby
+options = {
+        :job => 1,
+    :service => "[name of service]"
+}
+```
+
+## Prediction
+```ruby
+DeepdetectRuby::Predict.predict(options)
+```
+*with default options*
+```ruby
+options = {
+         :best => 2,
+          :gpu => true,
+      :service => "[name of service]",
+    :image_url => "[image url]",
+     :template => "[output template]"
+}
+```
+
+## Fine tune model
+```ruby
+DeepdetectRuby::Service.finetune(options)
+```
+*with options*
+```ruby
+options = {
+               :name => "[string - service name]",
+            :weights => "[filename of caffe model]",
+         :repository => "[repo path]",
+                :gpu => true,
+         :iterations => 10000,
+      :test_interval => 500,
+           :nclasses => 2,
+      :measure_index => 1,
+         :batch_size => 32,
+    :test_batch_size => 32
+}
+```
+
+## Suggestion for Diagram of neural network models
+
+In order to receive results with high accuracy, when applied to Pixai, this diagram of neural network models should be used as suggested below:
+![Chain of Models Diagram](https://c2.staticflickr.com/6/5492/29641623713_c43b64d5e3_b.jpg)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow experimentation.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contribution
+DeepDetect Ruby gem is designed and implemented by Tam Nguyen [tam@feels.com](tam@feels.com) or [ntamvl@gmail.com](ntamvl@gmail.com)
+Bug reports and pull requests are welcome on GitHub at https://github.com/pixai/deepdetect_ruby.
+
+## License
+The gem is available as a private repository under the terms of the Feels License

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "deepdetect_ruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/deepdetect_ruby.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'deepdetect_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "deepdetect_ruby"
+  spec.version       = DeepdetectRuby::VERSION
+  spec.authors       = ["Tam Nguyen"]
+  spec.email         = ["ntamvl@gmail.com"]
+
+  spec.summary       = "DeepdetectRuby, a library for Ruby apps"
+  spec.description   = "DeepdetectRuby, a library for Ruby apps"
+  spec.homepage      = "https://github.com/ntamvl/deepdetect-ruby"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "httparty"
+end