/ 
Jubatus-0.0.0_01
River stage zero No dependents
/ Jubatus::Anomaly::Client

NAME

Jubatus::Anomaly::Client - Perl extension for interfacing with anomaly values detection server 'jubaanomaly'

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 $juba_client_type = "anomaly";
# you can select from (recommender|regression|classifier|stat|graph|anomaly|nearestneighbor)

my $anom_client = Jubatus->get_client($host_name_or_ip_address, $port_number_of_juba_process, $juba_client_type);
# got Jubatus::Anomaly::Client object

# In the following example, get maximum value from sample array using Jubatus::Anomaly::Client object

my $is_clear = $anom_client->clear($cluster_name);

for (1..10) {
    my $datum = Jubatus::Anomaly::Datum->new([], [['val', 1.0]]);
    my $add_result = $anom_client->add($cluster_name, $datum);
}
my $val = 5.0;
my @result = ();

for (1..10) {
    my $datum = Jubatus::Anomaly::Datum->new([], [['val', $val]]);
    my $add_result = $anom_client->add($cluster_name, $datum);
    push @result, $add_result->[1];
    $val = 1.000001 + $val;
}

# The values in the @answer may be following values.
#my @answer = (
#    "inf",
#    1,
#    0.899999976158142,
#    "inf",
#    1,
#    0.899999976158142,
#    0.933333337306976,
#    0.9375,
#    0.950000047683716,
#    0.954545438289642,
#);

DESCRIPTION

This module provide a interface of recommendation server 'jubaanomaly' by TCP-based MessagePack RPC protocol using AnyEvent::MPRPC::Client

METHODS

Jubatus::Anomaly::Client provide many methods.

Constructors

This constructors can die when invalid parameters are given.

Jubatus::Anomaly::Client->new($host, $port);

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

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

The above code is equivalent to:

use Jubatus;
my $host = 'localhost';
my $port = '13714';
my $juba_client_type = 'anomaly';
my $anom_client = Jubatus->get_client($host, $port, $juba_client_type);

See Jubatus for more detail.

Functions

get_client()

Returns the reference to the Jubatus::Anomaly::Client object which has a "client" field. This field is a reference of AnyEvent::MPRPC::Client object to call a raw MessagePack-RPC client instance which is used by Jubatus client libraries. The functions of Jubatus::Anomaly::Client are wrapper of AnyEvent::MPRPC::Client.

Input:

- None

Output:

- Jubatus::Anomaly::Client object - Return a Jubatus::Anomaly::Client object
  Which is used ad MessagePack-RPC client instance of jubaanomaly server.

get_config($cluster_name)

Returns a server configuration from a server which is belonging to the cluster which execute the $cluster_name tasks.

Input:

- $cluster_name - String value to uniquely identify a task in the ZooKeeper
  cluster

Output:

- JSON file formated string - Returns a server configuration from a server.
  This configuration is same as the configuration file which was assigned
  when you start the jubaanomaly server.

get_status($cluster_name)

Returns server status from all servers which are belonging to the cluster which execute the $cluster_name tasks. Each server is represented by a pair of a host name and a port number.

Input:

- $cluster_name - String value to uniquely identify a task in the ZooKeeper
  cluster

save($cluster_name, $save_file_name)

Stores the learning model as $save_file_name to the local disk of all servers which are belonging to the cluster which execute the $cluster_name tasks.

Input:

- $cluster_name - String value to uniquely identify a task in the ZooKeeper
  cluster

- $save_file_name - File name to save

Output:

- binary(1 or 0) - Return integer value 1 if this function saves files
  successfully at all servers

load($cluster_name, $load_file_name)

Restores the saved model using $load_file_name at the local disk of all servers which are belonging to the cluster which execute the $cluster_name tasks.

Input:

- $cluster_name - String value to uniquely identify a task in the ZooKeeper
  cluster

- $save_file_name - File name to restore

Output:

- binary(1 or 0) - Return integer value 1 if this function restore saved
  model successfully at all servers

clear($cluster_name)

Completely clears the learning model on the memory of all servers which are belonging to the cluster which execute the $cluster_name tasks.

Input:

- $cluster_name - String value to uniquely identify a task in the ZooKeeper
  cluster

Output:

- binary(1 or 0) - Return integer value 1 if this function clears the
  saved model successfully at all servers

Output:

- Hash reference which have a hash reference value - Returns a server
  status from all servers which are belonging to the cluster which execute
  the $cluster_name tasks. Each server is represented by a pair of host name
  and a port number. This pair is used for a key of the return hash
  reference. The value of the return hash reference is hash reference. The
  keys of this hash reference are the server status name and each values are
  the server status informations.

SEE ALSO

http://jubat.us/ https://github.com/jubatus

AnyEvent::MPRPC AnyEvent::MPRPC::Client http://msgpack.org/ http://wiki.msgpack.org/display/MSGPACK/RPC+specification

https://github.com/overlast/p5-Jubatus

LICENSE

Copyright (C) 2013 by Toshinori Sato (@overlast).

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The licence of Jubatus is LGPL 2.1.

Jubatus: Online machine learning framework for distributed environment
Copyright (C) 2011,2012 Preferred Infrastructure and Nippon Telegraph and Telephone Corporation.

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License version 2.1 as published by the Free Software Foundation.

However Jubatus.pm and Jubatus::*.pm is the pure Perl modules. Therefor the licence of Jubatus.pm and Jubatus::*.pm is the Perl's licence.

AUTHOR

Toshinori Sato (@overlast) <overlasting@gmail.com>