本文按照调用顺序抽丝剥茧地分析了CRF++的代码，详细注释了主要函数，并指出了代码与理论公式的对应关系。内容包括拟牛顿法的目标函数、梯度、L2正则化、L-BFGS优化、概率图构建、前向后向算法、维特比算法等。

背景知识请参考《条件随机场》。

训练

先从训练开始说起吧

1. /**
2.  * 命令行式训练
3.  * @param argc 命令个数
4.  * @param argv 命令数组
5.  * @return 0表示正常执行,其他表示错误
6.  */
7. int crfpp_learn(int argc, char **argv)

该函数解析命令行之后调用：

1. /**
2.  * 训练CRF模型
3.  * @param param 参数
4.  * @return
5.  */
6. int crfpp_learn(const Param &param)

该函数会调用：

1.   /**
2.    * 训练
3.    * @param templfile 模板文件
4.    * @param trainfile 训练文件
5.    * @param modelfile 模型文件
6.    * @param textmodelfile 是否输出文本形式的模型文件
7.    * @param maxitr 最大迭代次数
8.    * @param freq 特征最低频次
9.    * @param eta 收敛阈值
10.    * @param C cost-factor
11.    * @param thread_num 线程数
12.    * @param shrinking_size
13.    * @param algorithm 训练算法
14.    * @return
15.    */
16. bool learn(const char *templfile,
17.            const char *trainfile,
18.            const char *modelfile,
19.            bool textmodelfile,
20.            size_t maxitr,
21.            size_t freq,
22.            double eta,
23.            double C,
24.            unsigned short thread_num,
25.            unsigned short shrinking_size,
26.            int algorithm);

该函数先读取特征模板和训练文件

1. /**
2.  * 打开配置文件和训练文件
3.  * @param template_filename
4.  * @param train_filename
5.  * @return
6.  */
7. bool open(const char *template_filename, const char *train_filename);

这个open方法并没有构建训练实例，而是简单地解析特征模板和统计标注集：

1. /**
2.  * 读取特征模板文件
3.  * @param filename
4.  * @return
5.  */
6. bool openTemplate(const char *filename);
7.  
8. /**
9.  * 读取训练文件中的标注集
10.  * @param filename
11.  * @return
12.  */
13. bool openTagSet(const char *filename);

回到learn方法中来，做完了这些诸如IO和参数解析之后，learn方法会根据算法参数的不同而调用不同的训练算法。取最常用的说明如下：

1. /**
2.  * CRF训练
3.  * @param x 句子列表
4.  * @param feature_index 特征编号表
5.  * @param alpha 特征函数的代价
6.  * @param maxitr 最大迭代次数
7.  * @param C cost factor
8.  * @param eta 收敛阈值
9.  * @param shrinking_size 未使用
10.  * @param thread_num 线程数
11.  * @param orthant 是否使用L1范数
12.  * @return 是否成功
13.  */
14. bool runCRF(const std::vector<TaggerImpl *> &x, EncoderFeatureIndex *feature_index, double *alpha, size_t maxitr,
15.             float C, double eta, unsigned short shrinking_size, unsigned short thread_num, bool orthant)

计算梯度

创建多个CRFEncoderThread，平均地将句子分给每个线程。每个线程的工作其实只是计算梯度：

1. /**
2.  * 计算梯度
3.  * @param expected 梯度向量
4.  * @return 损失函数的值
5.  */
6. double TaggerImpl::gradient(double *expected)

梯度计算时，先构建网格：

1. void TaggerImpl::buildLattice()

由于CRF是概率图模型，所以有一些图的特有概念，如顶点和边：

1. /**
2.  * 图模型中的节点
3.  */
4. struct Node
5. /**
6.  * 边
7.  */
8. struct Path

buildLattice方法调用rebuildFeatures对每个时刻的每个状态分别构造边和顶点：

1. for (size_t cur = 0; cur < tagger->size(); ++cur)
2. {
3.     const int *f = (*feature_cache)[fid++];
4.     for (size_t i = 0; i < y_.size(); ++i)
5.     {
6.         Node *n = allocator->newNode(thread_id);
7.         n->clear();
8.         n->x = cur;
9.         n->y = i;
10.         n->fvector = f;
11.         tagger->set_node(n, cur, i);
12.     }
13. }
14.  
15. for (size_t cur = 1; cur < tagger->size(); ++cur)
16. {
17.     const int *f = (*feature_cache)[fid++];
18.     for (size_t j = 0; j < y_.size(); ++j)
19.     {
20.         for (size_t i = 0; i < y_.size(); ++i)
21.         {
22.             Path *p = allocator->newPath(thread_id);
23.             p->clear();
24.             p->add(tagger->node(cur - 1, j), tagger->node(cur, i));
25.             p->fvector = f;
26.         }
27.     }
28. }

这也就是大家经常看到的类似如下的图：

然后计算每个节点和每条边的代价（也就是特征函数乘以相应的权值，简称代价）：

1. /**
2.  * 计算状态特征函数的代价
3.  * @param node 顶点
4.  */
5.     void FeatureIndex::calcCost(Node *n) const
6.     {
7.         n->cost = 0.0;
8.  
9. #define ADD_COST(T, A)                                                  \
10.   do { T c = 0;                                                               \
11.     for (const int *f = n->fvector; *f != -1; ++f) { c += (A)[*f + n->y];  }  \
12.     n->cost =cost_factor_ *(T)c; } while (0)
13.  
14.         if (alpha_float_)
15.         {
16.             ADD_COST(float, alpha_float_);
17.         }
18.         else
19.         {
20.             ADD_COST(double, alpha_);
21.         }
22. #undef ADD_COST
23.     }
24. /**
25.  * 计算转移特征函数的代价
26.  * @param path 边
27.  */
28.     void FeatureIndex::calcCost(Path *p) const
29.     {
30.         p->cost = 0.0;
31.  
32. #define ADD_COST(T, A)                                          \
33.   { T c = 0.0;                                                  \
34.     for (const int *f = p->fvector; *f != -1; ++f) {            \
35.       c += (A)[*f + p->lnode->y * y_.size() + p->rnode->y];     \
36.     }                                                           \
37.     p->cost =cost_factor_*(T)c; }
38.  
39.         if (alpha_float_)
40.         {
41.             ADD_COST(float, alpha_float_);
42.         }
43.         else
44.         {
45.             ADD_COST(double, alpha_);
46.         }
47.     }

其中fvector是当前命中特征函数的起始id集合，对于每个起始id，都有连续标签个数种y值；n->y是当前时刻的标签，由于每个特征函数都必须同时接受x和y才能决定输出1或0，所以要把两者加起来才能确定最终特征函数的id。用此id就能在alpha向量中取到最终的权值，将权值累加起来，乘以一个倍率（也就是所谓的代价参数cost_factor），得到最终的代价cost。

对于边来说，也是类似的，只不过对每个起始id，都有连续标签个数平方种y值组合。

这部分对应

前向后向算法

网格建完了，就可以在这个图上面跑前向后向算法了:

1. /**
2.  * 前向后向算法
3.  */
4. void forwardbackward();

该方法依次计算前后向概率：

1. for (int i = 0; i < static_cast<int>(x_.size()); ++i)
2. {
3.     for (size_t j = 0; j < ysize_; ++j)
4.     {
5.         node_[i][j]->calcAlpha();
6.     }
7. }
8. for (int i = static_cast<int>(x_.size() - 1); i >= 0; --i)
9. {
10.     for (size_t j = 0; j < ysize_; ++j)
11.     {
12.         node_[i][j]->calcBeta();
13.     }
14. }

计算前向概率的具体实现是：

1. void Node::calcAlpha()
2. {
3.     alpha = 0.0;
4.     for (const_Path_iterator it = lpath.begin(); it != lpath.end(); ++it)
5.     {
6.         alpha = logsumexp(alpha, (*it)->cost + (*it)->lnode->alpha, (it == lpath.begin()));
7.     }
8.     alpha += cost;
9. }

其中cost是我们刚刚计算的当前节点的M_i(x)，而alpha则是当前节点的前向概率。lpath是入边，如代码和图片所示，一个顶点可能有多个入边。

对应：

后向概率同理略过。

前后向概率都有了之后，计算规范化因子：

1. Z_ = 0.0;
2. for (size_t j = 0; j < ysize_; ++j)
3. {
4.     Z_ = logsumexp(Z_, node_[0][j]->beta, j == 0);
5. }

对应着

关于函数logsumexp的意义，请参考《计算指数函数的和的对数》。

于是完成整个前后向概率的计算。

期望值的计算

节点期望值

所谓的节点期望值指的是节点对应的状态特征函数关于条件分布的数学期望。

1. for (size_t i = 0; i < x_.size(); ++i)
2. {
3.     for (size_t j = 0; j < ysize_; ++j)
4.     {
5.         node_[i][j]->calcExpectation(expected, Z_, ysize_);
6.     }
7. }

calcExpectation具体实现是：

1. /**
2.  * 计算节点期望
3.  * @param expected 输出期望
4.  * @param Z 规范化因子
5.  * @param size 标签个数
6.  */
7. void Node::calcExpectation(double *expected, double Z, size_t size) const
8. {
9.     const double c = std::exp(alpha + beta - cost - Z);
10.     for (const int *f = fvector; *f != -1; ++f)
11.     {
12.         expected[*f + y] += c;
13.     }
14.     for (const_Path_iterator it = lpath.begin(); it != lpath.end(); ++it)
15.     {
16.         (*it)->calcExpectation(expected, Z, size);
17.     }
18. }

第一个for对应下式的求和

概率求和意味着得到期望。

第二个for对应边的期望值。

边的期望值

所谓边的期望指的是边对应的转移特征函数关于条件分布的数学期望。

1. /**
2.  * 计算边的期望
3.  * @param expected 输出期望
4.  * @param Z 规范化因子
5.  * @param size 标签个数
6.  */
7. void Path::calcExpectation(double *expected, double Z, size_t size) const
8. {
9.     const double c = std::exp(lnode->alpha + cost + rnode->beta - Z);
10.     for (const int *f = fvector; *f != -1; ++f)
11.     {
12.         expected[*f + lnode->y * size + rnode->y] += c;
13.     }
14. }

对应下式的求和

这样就得到了条件分布的数学期望：

梯度计算

1. for (size_t i = 0; i < x_.size(); ++i)
2. {
3.     for (const int *f = node_[i][answer_[i]]->fvector; *f != -1; ++f)
4.     {
5.         --expected[*f + answer_[i]];
6.     }
7.     s += node_[i][answer_[i]]->cost;  // UNIGRAM cost
8.     const std::vector<Path *> &lpath = node_[i][answer_[i]]->lpath;
9.     for (const_Path_iterator it = lpath.begin(); it != lpath.end(); ++it)
10.     {
11.         if ((*it)->lnode->y == answer_[(*it)->lnode->x])
12.         {
13.             for (const int *f = (*it)->fvector; *f != -1; ++f)
14.             {
15.                 --expected[*f + (*it)->lnode->y * ysize_ + (*it)->rnode->y];
16.             }
17.             s += (*it)->cost;  // BIGRAM COST
18.             break;
19.         }
20.     }
21. }

–expected表示模型期望（条件分布）减去观测期望，得到目标函数的梯度：

有人可能要问了，expected的确存的是条件分布的期望，但观测期望还没计算呢，把条件分布的期望减一是干什么？

这是因为对观测数据（训练数据）来讲，它一定是对的，也就是在y!=answer_[i]的时候概率为0，在y=answer_[i]的时候概率为1，乘以特征函数的输出1，就等于1，这就是观测期望。

维特比算法

紧接着gradient函数还顺便调了一下TaggerImpl::viterbi：

1. void TaggerImpl::viterbi()
2. {
3.     for (size_t i = 0; i < x_.size(); ++i)
4.     {
5.         for (size_t j = 0; j < ysize_; ++j)
6.         {
7.             double bestc = -1e37;
8.             Node *best = 0;
9.             const std::vector<Path *> &lpath = node_[i][j]->lpath;
10.             for (const_Path_iterator it = lpath.begin(); it != lpath.end(); ++it)
11.             {
12.                 double cost = (*it)->lnode->bestCost + (*it)->cost + node_[i][j]->cost;
13.                 if (cost > bestc)
14.                 {
15.                     bestc = cost;
16.                     best = (*it)->lnode;
17.                 }
18.             }
19.             node_[i][j]->prev = best;
20.             node_[i][j]->bestCost = best ? bestc : node_[i][j]->cost;
21.         }
22.     }
23.  
24.     double bestc = -1e37;
25.     Node *best = 0;
26.     size_t s = x_.size() - 1;
27.     for (size_t j = 0; j < ysize_; ++j)
28.     {
29.         if (bestc < node_[s][j]->bestCost)
30.         {
31.             best = node_[s][j];
32.             bestc = node_[s][j]->bestCost;
33.         }
34.     }
35.  
36.     for (Node *n = best; n; n = n->prev)
37.     {
38.         result_[n->x] = n->y;
39.     }
40.  
41.     cost_ = -node_[x_.size() - 1][result_[x_.size() - 1]]->bestCost;
42. }

其中prev构成一个前驱数组，在动态规划结束后通过prev回溯最优路径的标签y，存放于result数组中。

跑viterbi算法的目的是为了评估当前模型的准确度，以辅助决定是否终止训练。

正则化

为了防止过拟合，CRF++采用了L1或L2正则化：

1. if (orthant)
2. {   // L1
3.     for (size_t k = 0; k < feature_index->size(); ++k)
4.     {
5.         thread[0].obj += std::abs(alpha[k] / C);
6.         if (alpha[k] != 0.0)
7.         {
8.             ++num_nonzero;
9.         }
10.     }
11. }
12. else
13. {
14.     num_nonzero = feature_index->size();
15.     for (size_t k = 0; k < feature_index->size(); ++k)
16.     {
17.         thread[0].obj += (alpha[k] * alpha[k] / (2.0 * C));
18.         thread[0].expected[k] += alpha[k] / C;
19.     }
20. }

以L2正则为例，L2正则在目标函数上加了一个正则项：

+

其中，是一个常数，在CRF++中其平方被称作cost-factor，控制着惩罚因子的强度。可见要最小化目标函数，正则化项也必须尽量小才行。模型参数的平方和小，其复杂度就低，于是就不容易过拟合。关于L1、L2正则化推荐看Andrew Ng的ML公开课。

目标函数加了一项之后，梯度顺理成章地也应加上的导数：

+

这也就是代码中为什么要自加这两项的原因了：

1.         thread[0].obj += (alpha[k] * alpha[k] / (2.0 * C));
2.         thread[0].expected[k] += alpha[k] / C;

L-BFGS优化

梯度和损失函数有了，之后就是通用的凸函数LBFGS优化了。CRF++直接将这些参数送入一个LBFGS模块中：

1. if (lbfgs.optimize(feature_index->size(), &alpha[0], thread[0].obj, &thread[0].expected[0], orthant, C) <=
2.     0)
3. {
4.     return false;
5. }

据说这个模块是用一个叫f2c的工具从FORTRAN代码转成的C代码，可读性并不好，也就不再深入了。

1. //   lbfgs.c was ported from the FORTRAN code of lbfgs.m to C
2. //   using f2c converter
3. //
4. //   http://www.ece.northwestern.edu/~nocedal/lbfgs.html

有兴趣的话看看《数值优化：理解L-BFGS算法》即可。

预测

预测就简单多了，主要对应下列方法：

1. bool TaggerImpl::parse()
2. {
3.     CHECK_FALSE(feature_index_->buildFeatures(this)) << feature_index_->what();
4.  
5.     if (x_.empty())
6.     {
7.         return true;
8.     }
9.     buildLattice();
10.     if (nbest_ || vlevel_ >= 1)
11.     {
12.         forwardbackward();
13.     }
14.     viterbi();
15.     if (nbest_)
16.     {
17.         initNbest();
18.     }
19.  
20.     return true;
21. }

主要的方法也就是建立网格和维特比这两个，由于前面训练的时候已经分析过，这里就不再赘述了。

Reference

crf-tutorial.pdf

条件随机场理论综述.pdf

http://mi.eng.cam.ac.uk/~cz277/doc/Slides-CRFASR-CSLT.pdf

http://blog.sina.com.cn/s/blog_a6962c6401016gob.html