NAME

Jubatus - Perl extension for interfacing with Jubatus, a distributed processing framework and streaming machine learning library.

SYNOPSIS

    use Jubatus;

    my $cluster_name = "jubatus_perl_doc"; # even if it isn't in a distributed environment using ZooKeeper and Jubatus keepers.
    my $host_name_or_ip_address = "localhost"; # master node's
    my $port_number_of_juba_process = 13714; # meanless
    my $timeout_seconds_of_juba_process = 10; # 10 sec is default parameter

    my $juba_client_type = "stat"; # you can select from (recommender|regression|classifier|stat|graph|anomaly|nearestneighbor|clustering)
    my $graph_client = Jubatus->get_client($juba_client_type, $host_name_or_ip_address, $port_number_of_juba_process, $cluster_name, $timeout_seconds_of_juba_process); # got Jubatus::Stat::Client object

    # In the following example, get maximum value from sample array using Jubatus::Stat::Client object
    my @sample = (1.0, 2.0, 3.0, 4.0, 5.0);
    my $key = "sum";
    foreach my $val (@sample) {
        my $is_push = $stat_client->push($key, $val);
    }
    my $result = $stat_client->sum($key);

    # $result is 15.0

DESCRIPTION

This module provide a interface of Jubatus by TCP-based MessagePack RPC protocol using AnyEvent::MPRPC::Client Jubatus is a distributed processing framework and streaming machine learning library.

Jubatus provide you a couple of export functions that are shortcut of Jubatus::Recommender::Client and Jubatus::Regression::Client, Jubatus::Classifier::Client, Jubatus::Stat::Client, Jubatus::Graph::Client, Jubatus::Anomaly::Client, Jubatus:;NearestNeighbor::Client, Jubatus:;Clustering::Client,

One is get_client to get Client object by specifying client type. Another is get_recommender_client and get_regression_client, get_classifier_client, get_stst_client, get_graph_client, get_anomaly_client, get_nearestneighbor_client, get_clustering_client, to get a specific Client object explicitly.

FUNCTIONS

get_client $juba_client_type, $host, $port, $process_name, $timeout_sec

If you select 'stat', you can get Jubatus::Stat::Client object.

    my $juba_client_type = 'stat';
    my $host = 'localhost';
    my $port = '13714';
    my $cluster_name = "jubatus_perl_doc";
    my $timeout_seconds_of_juba_process = 10;
    my $stat_client = Jubatus->get_client($juba_client_type, $host, $port, $cluster_name, $timeout_seconds_of_juba_process);

This code will create Jubatus::Stat::Client object and return it. You should set $host and $port in agreement to running jubastat server application.

The above code is equivalent to:

    use Jubatus::Stat::Client;
    my $host = 'localhost';
    my $port = '13714';
    my $cluster_name = "jubatus_perl_doc";
    Jubatus::Stat::Client->new($host, $port, $cluster_name);

Because default value of $timeout_seconds_of_juba_process is 10.

If you are not distributed environment user, you can write as following.

    my $juba_client_type = 'stat';
    my $host = 'localhost';
    my $port = '13714';
    my $stat_client = Jubatus->get_client($juba_client_type, $host, $port);

Because default value of $cluster_name is ""(null string).

get_recommender_client $host, $port, ($cluster_name, $timeout_seconds,)

This code will create Jubatus::Recommener::Client object and return it. You should set $host and $port in agreement to running jubarecommender server application.

    my $host = 'localhost';
    my $port = '13714';
    my $stat_client = Jubatus->get_recommender_client($host, $port);

This code isn't write cluster name and timeout seconds parameter. But Jubatus.pm use default cluster name("") and default timeout parameter(10).

The above code is equivalent to:

    use Jubatus::Recommender::Client;
    my $host = 'localhost';
    my $port = '13714';
    Jubatus::Recommender::Client->new($host, $port);

If you are distributed environment user and you want to set the parameter of timeout secondes of jubatus server, you can write same as following code.

    my $host = 'localhost';
    my $port = '13714';
    my $cluster_name = "jubatus_perl_doc";
    my $timeout_seconds = 10;
    my $stat_client = Jubatus->get_recommender_client($host, $port, $cluster_name, $timeout_seconds);

See Jubatus::Recommender::Client for more detail.