NAME
AI::MaxEntropy::Model - Perl extension for using Maximum Entropy Models
SYNOPSIS
# THIS SYNOPSIS IS JUST A SUB SET OF THAT IN AI::MaxEntropy
use AI::MaxEntropy::Model;
# learn a model by AI::MaxEntropy
require AI::MaxEntropy;
my $me = AI::MaxEntropy->new;
$me->see(['round', 'smooth', 'red'] => 'apple' => 2);
$me->see(['long', 'smooth', 'yellow'] => 'banana' => 3);
$me->see(['round', 'rough'] => 'orange' => 2);
my $model = $me->learn;
# make prediction on unseen data
# ask what a red round thing is most likely to be
my $y = $model->predict(['round', 'red']);
# the answer apple is expected
# print out scores of all possible labels
for ($model->all_labels) {
my $s = $model->score(['round', 'red'] => $_);
print "$_: $s\n";
}
# save the model to file
$model->save('model_file');
# load the model from file
$model->load('model_file');DESCRIPTION
This module manipulates models learnt by AI::MaxEntropy. For details about Maximum Entropy learner, please refer to AI::MaxEntropy.
FUNCTIONS
new
Create a new model object from a model file.
my $model = AI::MaxEntropy::Model->new('model_file');predict
Given a set of active features (x), figure out which label (y) is most likely to come with.
...
$y = $model->predict(['round', 'red']);score
Given a set of active features (x) and a label (y), figure out how likely x => y occurs. The greater the score is, the more likely x => y holds.
...
$s = $model->score(['round', 'red'] => 'apple');save
Dumps the model to a file.
...
$model->save('model_file');load
Loads the model from a file.
...
$model->load('model_file');all_features
Returns a list of all features.
all_labels
Returns a list of all labels.
SEE ALSO
AUTHOR
Laye Suen, <laye@cpan.org>
COPYRIGHT AND LICENSE
The MIT License
Copyright (C) 2008, Laye Suen
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.