Description
The Ruby SDK provides a convenient wrapper for the PredictionIO API. It allows you to quickly record your users' behavior and retrieve personalized predictions for them.
PredictionIO Ruby SDK alternatives and similar gems
Based on the "Machine Learning" category.
Alternatively, view PredictionIO Ruby SDK alternatives based on common mentions on social networks and blogs.
-
Ruby Linear Regression
Linear regression implemented in Ruby. -
Ruby Datumbox Wrapper
Simple Ruby Datumbox Wrapper -
Edits
Edit distance algorithms inc. Jaro, Damerau-Levenshtein, and Optimal Alignment
Access the most powerful time series database as a service
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest.
Do you think we are missing an alternative of PredictionIO Ruby SDK or a related project?
README
<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->
Apache PredictionIO Ruby SDK
The Ruby SDK provides a convenient wrapper for PredictionIO Event Server API and Engine API. It allows you to quickly record your users' behavior and retrieve personalized predictions for them.
Documentation
Full Ruby SDK documentation can be found here.
Please see the PredictionIO App Integration Overview to understand how the SDK can be used to integrate PredictionIO Event Server and Engine with your application.
Installation
Ruby 2+ required!
The module is published to RubyGems and can be installed directly by:
gem install predictionio
Or using Bundler with:
gem 'predictionio', '0.12.1'
Sending Events to Event Server
Please refer to Event Server documentation for event format and how the data can be collected from your app.
Instantiate Event Client and connect to PredictionIO Event Server
require 'predictionio'
# Define environment variables.
ENV['PIO_THREADS'] = '50' # For async requests.
ENV['PIO_EVENT_SERVER_URL'] = 'http://localhost:7070'
ENV['PIO_ACCESS_KEY'] = 'YOUR_ACCESS_KEY' # Find your access key with: `$ pio app list`.
# Create PredictionIO event client.
client = PredictionIO::EventClient.new(ENV['PIO_ACCESS_KEY'], ENV['PIO_EVENT_SERVER_URL'], Integer(ENV['PIO_THREADS']))
Create a $set
user event and send it to Event Server
client.create_event(
'$set',
'user',
user_id
)
Create a $set
item event and send it to Event Server
client.create_event(
'$set',
'item',
item_id,
{ 'properties' => { 'categories' => ['Category 1', 'Category 2'] } }
)
Create a $set
item event and send it to Event Server to specific channel
NOTE: channels are supported in PIO version >= 0.9.2 only. Channel must be created first.
client.create_event(
'$set',
'item',
item_id,
{ 'properties' => { 'categories' => ['Category 1', 'Category 2'], 'channel' => 'test-channel'} }
)
Create a user 'rate' item event and send it to Event Server
client.create_event(
'rate',
'user',
user_id, {
'targetEntityType' => 'item',
'targetEntityId' => item_id,
'properties' => { 'rating' => 10 }
}
)
Asynchronous request
To send an async request, simply use the acreate_event
method instead of
create_event
. Be aware that the asynchronous method does not throw errors.
It's best to use the synchronous method when first getting started.
Query PredictionIO Engine
Connect to the Engine:
# Define environmental variables.
ENV['PIO_ENGINE_URL'] = 'http://localhost:8000'
# Create PredictionIO engine client.
client = PredictionIO::EngineClient.new(ENV['PIO_ENGINE_URL'])
Send a prediction query to the engine and get the predicted result:
# Get 5 recommendations for items similar to 10, 20, 30.
response = client.send_query(items: [10, 20, 30], num: 5)
Mailing List
Please use the Apache mailing lists. Subscription instructions are here.
Issue Tracker
Use the Apache JIRA, and file any
issues under the Ruby SDK
component.
Contributing
Please follow these instructions.
License
*Note that all licence references and agreements mentioned in the PredictionIO Ruby SDK README section above
are relevant to that project's source code only.