AI::CRM114 - Wrapper for the statistical data classifier CRM114

AI-CRM114 documentation Contained in the AI-CRM114 distribution.

Index

Code Index:

NAME

Top

AI::CRM114 - Wrapper for the statistical data classifier CRM114

SYNOPSIS

Top

  use AI::CRM114;
  my $crm = AI::CRM114->new(cmd => '/path/to/crm');

  # Learn new text
  $crm->learn(['osb'], 'spam.css', 'MAKE MONEY FAST');

  # Classify some text
  my $class = $crm->classify(['osb'], ['a.css', 'b.css'], $text);

DESCRIPTION

Top

The CRM114 Discriminator, is a collection of tools to classify data, e.g. for use in spam filters. This module is a simple wrapper around the command line executable. Feedback is very welcome, the interface is unstable. Use with caution.

METHODS

Top

AI::CRM114->new(%options)

Creates a new instance of this class. The following options are available:

cmd => '/path/to/crm'

Specifies the path to the crm executable.

$crm->learn(\@flags, $file, $text)

Learn that the text belongs to the file using the specified flags. Permissable flags are specified in the QUICKREF.txt file that comes with CRM114. Examples include winnow, microgroom, and osbf.

classify(\@flags, \@files, $text)

Attempt to correlate the text to one of the files using the specified flags. Permissable flags are specified in the QUICKREF.txt file that comes with CRM114. Examples include unique, fscm, and svm.

In scalar context, returns the path of the best matching file. In list context, returns a list containing the path of the best file, and the probability and pR values as reported in (:stats:).

SEE ALSO

Top

  * http://crm114.sourceforge.net/
  * http://crm114.sourceforge.net/docs/QUICKREF.txt

AUTHOR / COPYRIGHT / LICENSE

Top

  Copyright (c) 2009 Bjoern Hoehrmann <bjoern@hoehrmann.de>.
  This module is licensed under the same terms as Perl itself.
AI-CRM114 documentation Contained in the AI-CRM114 distribution. 
package AI::CRM114;

use 5.008000;
use strict;
use warnings;
use IPC::Run qw /run/;

our @ISA = qw();

our $VERSION = '0.01';

sub new {
  my $class = shift;
  my $self = { cmd => 'crm', @_ };
  bless $self, $class;
  return $self;
}

sub classify {
  my ($self, $flags, $files, $text) = @_;

  my $code = qq#-{
        isolate (:stats:);
        classify <@$flags> ( @$files ) (:stats:);
        output /:*:stats:/
    }#;

  my $o = "";
  my $h = run [$self->{cmd}, $code], \$text, \$o;

  my ($file, $prob, $pr) = $o =~
    /Best match to file \S+ \((.*?)\) +prob: *([0-9.]+) +pR: *([0-9.-]+)/;

  wantarray ? ($file, $prob, $pr) : $file;
}

sub learn {
  my ($self, $flags, $file, $text) = @_;

  my $code = qq#-{ learn <@$flags> ( $file ) }#;

  my $o = "";
  my $h = run [$self->{cmd}, $code], \$text, \$o;
}

1;

__END__