com.hankcs.hanlp.classification.classifiers

接口 IClassifier

所有已知实现类:

AbstractClassifier, NaiveBayesClassifier

public interface IClassifier

文本分类器接口

作者:

hankcs

方法概要

限定符和类型	方法和说明
double[]	categorize(Document document) 预测分类
String	classify(Document document) 预测最可能的分类
String	classify(String text) 预测最可能的分类
IClassifier	enableProbability(boolean enable) 是否归一化分值为概率
AbstractModel	getModel() 获取训练后的模型,可用于序列化保存或预测.
int	label(Document document) 预测最可能的分类
Map<String,Double>	predict(Document document) 预测分类
Map<String,Double>	predict(String text) 预测分类
void	train(IDataSet dataSet) 训练模型
void	train(Map<String,String[]> trainingDataSet) 训练模型
void	train(String folderPath) 用UTF-8编码的语料训练模型
void	train(String folderPath, String charsetName) 训练模型

方法详细资料

enableProbability

IClassifier enableProbability(boolean enable)

是否归一化分值为概率

参数:

enable -

返回:

predict

Map<String,Double> predict(String text)
                    throws IllegalArgumentException,
                           IllegalStateException

预测分类

参数:

text - 文本

返回:

所有分类对应的分值(或概率, 需要enableProbability)

抛出:

IllegalArgumentException - 参数错误

IllegalStateException - 未训练模型

predict

Map<String,Double> predict(Document document)
                    throws IllegalArgumentException,
                           IllegalStateException

预测分类

参数:

document -

返回:

抛出:

IllegalArgumentException

IllegalStateException

categorize

double[] categorize(Document document)
             throws IllegalArgumentException,
                    IllegalStateException

预测分类

参数:

document -

返回:

抛出:

IllegalArgumentException

IllegalStateException

label

int label(Document document)
   throws IllegalArgumentException,
          IllegalStateException

预测最可能的分类

参数:

document -

返回:

抛出:

IllegalArgumentException

IllegalStateException

classify

String classify(String text)
         throws IllegalArgumentException,
                IllegalStateException

预测最可能的分类

参数:

text - 文本

返回:

最可能的分类

抛出:

IllegalArgumentException

IllegalStateException

classify

String classify(Document document)
         throws IllegalArgumentException,
                IllegalStateException

预测最可能的分类

参数:

document - 一个结构化的文档(注意!这是一个底层数据结构,请谨慎操作)

返回:

最可能的分类

抛出:

IllegalArgumentException

IllegalStateException

train

void train(Map<String,String[]> trainingDataSet)
    throws IllegalArgumentException

训练模型

参数:

trainingDataSet - 训练数据集,用Map储存.键是分类名,值是一个数组,数组中每个元素都是一篇文档的内容.

抛出:

IllegalArgumentException

train

void train(String folderPath,
           String charsetName)
    throws IOException

训练模型

参数:

folderPath - 分类语料的根目录.目录必须满足如下结构:
根目录
├── 分类A
│ └── 1.txt
│ └── 2.txt
│ └── 3.txt
├── 分类B
│ └── 1.txt
│ └── ...
└── ...
文件不一定需要用数字命名,也不需要以txt作为后缀名,但一定需要是文本文件.

charsetName - 文件编码

抛出:

IOException - 任何可能的IO异常

train

void train(String folderPath)
    throws IOException

用UTF-8编码的语料训练模型

参数:

folderPath - 用UTF-8编码的分类语料的根目录.目录必须满足如下结构:
根目录
├── 分类A
│ └── 1.txt
│ └── 2.txt
│ └── 3.txt
├── 分类B
│ └── 1.txt
│ └── ...
└── ...
文件不一定需要用数字命名,也不需要以txt作为后缀名,但一定需要是文本文件.

抛出:

IOException - 任何可能的IO异常

train

void train(IDataSet dataSet)
    throws IllegalArgumentException

训练模型

参数:

dataSet - 训练数据集

抛出:

IllegalArgumentException - 当数据集为空时,将抛出此异常

getModel

AbstractModel getModel()

获取训练后的模型,可用于序列化保存或预测.

返回:

模型,null表示未训练