Wise.io for Ruby

Usage

The following outlines the basic usage of the wise.io ruby library.

Assumptions and limitations.

At the moment, only predictions on already existent models in already existent projects are supported. The library has been tested in Ruby 1.8.7p358 as well as in Ruby 2.0.0p0.

Basic usage

Connecting to a wise.io project can be done in two ways. The Wise::project method suffices, as illustrated by the following example:

Wise.project 'robin/quasars', :user => 'robin', :password => '...' do |p|
  p.predict 'train', 'quasarsTest.csv'
end

Alternately, a project handle may be created using Wise::Project.new:

p = Wise::Project.new 'robin/quasars', :user => 'robin', :password => '...'
p.predict 'train', 'quasarsTest.csv'

Setting up a local wise.io profile

To avoid having to supply user name and password every time a project handle is created, the wise.rb binary supplied with the gem can be used to store credentials in a local wise.io profile. To do this, simply run wise.rb --setup as follows:

$ wise.rb --setup
User: robin
Password: 
OK, wrote wise.io profile.

If the supplied credentials are valid, connecting to a project and performing predictions on a model is as simple as:

Wise.project 'robin/quasars' do |p|
  p.predict 'train', :dataset => 'test'
end

License

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.