{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### 线性规划与Word Mover's Distance"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "WMD在文本分析领域算作是一个比较经典的算法,它可以用来计算两个文本之间的相似度。 比如问答系统中,可以判断一个用户的query跟哪一个知识库里的问题最相近。而且,计算两个文本之间的相似度这个问题是NLP的核心,这也是为什么文本相似度计算这么重要的原因。 \n",
    "\n",
    "背景: 在文本相似度匹配问题上如果使用tf-idf等模型,那这时候假如两个文本中没有出现共同的单词,则计算出来的相似度为0,但我们知道实际上很多时候单词可能不一样,但表示的内容确是类似的。 比如 ”People like this car“, \"Those guys enjoy driving that\", 虽然没有任何一样的单词,意思确是类似的。 这是WMD算法提出来的初衷。\n",
    "\n",
    "WMD作为文本相似度计算的一种方法,最早由Matt J. Kusner, Yu Sun, Nicholas I. Kolkin, Kilian Q. Weinberger等人提出。但实际上它的想法极其简单,可以认为是Transportation Problem用在了词向量上, 其核心是线性规划。 对于Transportation问题在课上已经讲过,仍不清楚的朋友可以回顾一下课程的内容。 \n",
    "\n",
    "在Section B里我们需要做两件事情: 1.  实现WMD算法来计算两个字符串之间的距离。  2. WMD的拓展方案"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "#### 1. WMD算法的实现\n",
    "具体算法的实现是基于线性规划问题,细节请参考WMD的论文。 核心思想是把第一个句子转换成第二个句子过程中需要花费的最小cost。 \n",
    "\n",
    "<img src=\"picture1.png\" alt=\"drawing\" width=\"600\"/>\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "线性规划问题即可以写成如下形式:\n",
    "\n",
    "<img src=\"picture2.png\" alt=\"drawing\" width=\"500\"/>\n",
    "\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "这里的参数是$T_{ij}$, 需要通过LP Solver去解决。$c(i,j)$指的是两个单词之间的距离, $c_{i,j}=||x_i-x_j||_2$。 参考: $||x||_2=\\sqrt{x_1^2+...+x_d^2}$\n",
    "\n",
    "为了实现WMD算法,首先需要词向量。 在这里,我们就不自己去训练了,直接使用已经训练好的词向量。 \n",
    "请下载训练好的Glove向量:https://nlp.stanford.edu/projects/glove/,   下载其中的 glove.6B.zip, 并使用d=100维的向量。 由于文件较大,需要一些时间来下载。 \n",
    "\n",
    "请注意:提交作业时不要上传此文件, 但文件路径请使用我们给定的路径,不要改变。 "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {
    "scrolled": true
   },
   "outputs": [],
   "source": [
    "import numpy as np"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [],
   "source": [
    "#构建word embedding \n",
    "def load_embedding():\n",
    "    w2v = {}\n",
    "    glovefile = open(\"glove.6B.100d.txt\",\"r\",encoding=\"utf-8\") \n",
    "    for i, each_line in enumerate(glovefile):\n",
    "        each_wc = each_line.strip().split(' ')\n",
    "        w2v[each_wc[0]] = np.array([float(i) for i in each_wc[1:]])\n",
    "    return w2v"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {},
   "outputs": [],
   "source": [
    "# 计算两个向量的欧式距离\n",
    "def word_distance(emb1, emb2):\n",
    "    temp = [emb1[i]-emb2[i] for i in range(len(emb1))]\n",
    "    distance = np.linalg.norm(temp)\n",
    "    return distance"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "metadata": {},
   "outputs": [],
   "source": [
    "#记录词频\n",
    "def word_count(segment):\n",
    "    word_fre = {}\n",
    "    for word in segment:\n",
    "        word_fre[word] = 1.0 + word_fre.get(word,0)\n",
    "    return word_fre"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "metadata": {
    "scrolled": true
   },
   "outputs": [],
   "source": [
    "# TODO: 编写WMD函数来计算两个句子之间的相似度\n",
    "from cvxopt import matrix,solvers\n",
    "\n",
    "def WMD (sent1, sent2):\n",
    "    \"\"\"\n",
    "    这是主要的函数模块。参数sent1是第一个句子, 参数sent2是第二个句子,可以认为没有经过分词。\n",
    "    在英文里,用空格作为分词符号。\n",
    "    \n",
    "    在实现WMD算法的时候,需要用到LP Solver用来解决Transportation proboem. 请使用http://cvxopt.org/examples/tutorial/lp.html\n",
    "    也可以参考blog: https://scaron.info/blog/linear-programming-in-python-with-cvxopt.html\n",
    "    \n",
    "    需要做的事情为:\n",
    "    \n",
    "    1. 对句子做分词: 调用 .split() 函数即可\n",
    "    2. 获取每个单词的词向量。这需要读取文件之后构建embedding matrix. \n",
    "    3. 构建lp问题,并用solver解决\n",
    "    \n",
    "    可以自行定义其他的函数,但务必不要改写WMD函数名。测试时保证WMD函数能够正确运行。\n",
    "    \"\"\"    \n",
    "    #分词\n",
    "    seg1 = sent1.strip().split()    \n",
    "    seg2 = sent2.strip().split()   \n",
    "    \n",
    "    # 统计词频\n",
    "    word_fre1 = word_count(seg1)\n",
    "    word_fre2 = word_count(seg2)\n",
    "    \n",
    "    # 将分词转为词向量\n",
    "    emb1 = [w2v[word] for word in word_fre1.keys()]\n",
    "    emb2 = [w2v[word] for word in word_fre2.keys()]\n",
    "    \n",
    "    #计算句子长度\n",
    "    len1 = len(emb1)\n",
    "    len2 = len(emb2)\n",
    "    \n",
    "    # 获得两个句子之间的词汇距离ci,j,存储在二维数组中\n",
    "    c_ij = []\n",
    "    for i in range(len1):\n",
    "        for j in range(len2):\n",
    "            c_ij.append(word_distance(emb1[i], emb2[j]))\n",
    "    \n",
    "    # 建立A矩阵\n",
    "    a = []\n",
    "    #   句子1对应到句子2部分\n",
    "    a0 = [0.0]*len2\n",
    "    a1 = [1.0]*len2\n",
    "    a = []\n",
    "    for i in np.eye(len1):\n",
    "        a_temp = []\n",
    "        for j in i:\n",
    "            if j == 1:\n",
    "                a_temp.extend(a1)\n",
    "            if j == 0:\n",
    "                a_temp.extend(a0)\n",
    "        a.append(a_temp)\n",
    "    #   句子2对应到句子1\n",
    "    for i in range(len2):\n",
    "        a_temp = [0.0]*len2\n",
    "        a_temp[i] = 1.0\n",
    "        a.append(a_temp*len1)\n",
    "        \n",
    "    # 获得出入量之和 \n",
    "    b = [i / len(seg1) for i in list(word_fre1.values())] + \\\n",
    "        [i / len(seg2) for i in list(word_fre2.values())]\n",
    "    \n",
    "    # 线性规划问题\n",
    "    A_matrix = matrix(a).trans()\n",
    "    b_matrix = matrix(b)\n",
    "    c_matrix = matrix(c_ij)\n",
    "    num_of_T = len(c_ij)\n",
    "    G = matrix(-np.eye(num_of_T))\n",
    "    h = matrix(np.zeros(num_of_T))\n",
    "    \n",
    "    sol = solvers.lp(c_matrix, G, h, A=A_matrix, b=b_matrix, solver='glpk')\n",
    "    \n",
    "    return sol['primal objective']  #wmd_dist\n",
    "    "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "读取成功\n"
     ]
    }
   ],
   "source": [
    "#加载词向量\n",
    "w2v = load_embedding()\n",
    "print('读取成功')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "metadata": {
    "scrolled": true
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "4.271249445939769"
      ]
     },
     "execution_count": 7,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "sent1 = \"people like this car\"\n",
    "sent2 = \"those guys enjoy driving that\"\n",
    "WMD (sent1, sent2)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 8,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "5.208708323787745\n",
      "5.868833973452187\n"
     ]
    }
   ],
   "source": [
    "## TODO: 自己写至少4个Test cases来测试一下。 比如 print (WMD(\"people like this car\", \"those guys enjoy driving that\"))\n",
    "##       \n",
    "sent1 = \"boy like eat apple\"\n",
    "sent2 = \"he want some fruit\"\n",
    "sent3 = \"a dog dive into water\"\n",
    "print(WMD(sent1, sent2))\n",
    "print(WMD(sent1, sent3))"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 9,
   "metadata": {
    "scrolled": true
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "4.271249445939769\n",
      "5.558712147227374\n"
     ]
    }
   ],
   "source": [
    "sent1 = \"people like this car\"\n",
    "sent2 = \"those guys enjoy driving that\"\n",
    "sent3 = \"i am studying the course of math\"\n",
    "print(WMD(sent1, sent2))\n",
    "print(WMD(sent1, sent3))"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "#### 2. WMD算法的拓展\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "##### 2.1 从欧式距离到Mahalanobis距离\n",
    "WMD算法本身不需要任何的标注好的数据,所以它属于无监督学习。 而且在上述的WMD算法里使用的是欧式距离,$c(i,j)=||x_i-x_j||_2$, 那这种距离有什么缺点呢? 其中一个缺点是欧式距离的计算把一个空间里的每一个维度都看成了同样的权重,也就是每一个维度的重要性都是一致的,而且不同维度之间的相关性也没有考虑进来。如果想把这些信息考虑进来,我们则可以使用一个改进版的距离计算叫做Mahalanobis Distance, 距离计算变成 $c(i,j)=(x_i-x_j)^{\\top}M(x_i-x_j)$。\n",
    "\n",
    "这如何去理解呢? Mahalanobis distance可以理解成: 首先我们对原始空间里的样本做了一层线性的转换, 然后在转换后的空间里计算欧式距离。 我们把这个过程写一下: 原始空间里的点为 $x_i$, 然后我们定义一个转换矩阵 $L$, 这时候就可以得到 $||Lx_i - Lx_j||_2^2=||L(x_i-x_j)||_2^2=(L(x_i-x_j))^{\\top}L(x_i-x_j)=(x_i-x_j)^{\\top}L^{\\top}L(x_i-x_j)=(x_i-x_j)^{\\top}M(x_i-x_j)$, 相当于把$L^{\\top}L$看做是矩阵$M$。这时候很容易看出来矩阵$M$是PSD(positive semidefinite). \n",
    "\n",
    "假设我们定义了这种距离,这里的M如何选择呢? 当然,这是需要学出来的! 那为了学出M, 必须要有标注好的训练数据,也就需要监督学习场景!  "
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "##### 2.2 从无监督学习到监督学习\n",
    "\n",
    "假如拥有数据集$D={(s_1, y_1),...,(s_n, y_n)}$, 这里每一个$s_i$代表的是一个句子, $y_i$代表的是对应每一个句子的标签(label)。 我们希望使用这个数据来学出M的值。那如何学习呢? 在这个问题上能使用的方法其实比较多,但在这里, 我们采用一个margin-based方法,这一点在SVM里面其实接触过。\n",
    "\n",
    "具体一点,假如我们手里有三个句子,$s_u, s_v, s_w$, 其中$s_u$和$s_v$是属于同一个类别,$s_w$是属于另一个类别,那这时候从KNN的角度来讲,我们希望$s_u, s_v$的距离要小于 $s_u, s_w$之间的距离。 用数学来表示: $d(s_u, s_v) < d(s_u, s_w)$, $~~d(.,.)$表示两个文本之间的距离。 其实我们希望它们之间的距离越大越好,也就是所谓的完全区间越宽越好。 但实际上,这个距离太大也没有什么意义,所以我们就干脆指定一个参数 $\\eta$来表示margin, 也就是只要它俩之间的距离大于这个margin就可以。如果小于margin就给他们一些惩罚(penalty),这一点跟SVM极其相似(slack variable)。所以从这个角度SVM也叫做margin-based classifier. \n",
    "\n",
    "把上述的表示成数学的话: $d(s_u, s_v) + \\eta < d(s_u, s_k)$, 但如果这个式子不成立的话就可以认为产生了penalty。 所以这部分就可以表示成大家熟悉的hinge loss:    $max (0,  d(s_u, s_v) + \\eta - d(s_u, s_k))$。 另外,我们同时也希望如果两个样本属于同一个类别, 那它俩的距离也比较相近。所以目标函数可以分为两个部分: 1. 同类型的样本距离尽量要近   2. 不同类型的样本距离尽量远一些。 \n",
    "\n",
    "当我们把所有的样本以及他们之间的大小关系考虑进来之后就可以得到最终的目标函数。 \n",
    "\n",
    "\\begin{equation}\n",
    "L = \\lambda \\sum_{u=1}^{n}\\sum_{v\\in pos(u)}d(s_u, s_v) + (1-\\lambda)\\sum_{u=1}^{n}\\sum_{v\\in pos(u)}^{}\\sum_{w\\in neg(u)}^{} max (0,  d(s_u, s_v) + \\eta - d(s_u, s_w))\n",
    "\\end{equation}\n",
    "\n",
    "这里几个notation:  pos(u)代表的是跟样本u属于同一个类别的样本, neg(u)指的是跟样本u属于不同类别的样本。 注意:类别的个数可以大于2, 就是多分类问题。 你也可以参考: http://jmlr.org/papers/volume10/weinberger09a/weinberger09a.pdf"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "在这个式子里,第一部分代表的是让同一类型的样本的距离变小, 第二部分代表的是不同类型的样本之间要扩大距离。 \n",
    "\n",
    "- #### Q1: 这里$\\lambda$起到什么作用?"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "// TODO:  你的答案....\n",
    "\n",
    "调整惩罚力度。如果$\\lambda$比较大,我们就比较注重于减小同类型样本间的距离,即原WMD问题;如果$\\lambda$ 比较小,则$1-\\lambda$比较大,我们对于不同类型样本间距离的惩罚就比较大。\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "- #### Q2: 在目标函数里有$\\eta$值,这个值怎么理解? 如果去设定这个值呢?\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "// TODO: 你的答案 ....\n",
    " \n",
    "假设以一个样本为中心,半径r内的都和其为一类,半径R以上就是另一类,则 $\\eta = R-r$。这个值可以通过数据集本身的性质设定,通过run不同数值看模型哪个效果比较好。\n",
    "    \n",
    "    \n",
    "    "
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "这里的$d_{u,v}$指的是$s_u$和$s_v$之间的距离, 而且这个距离被定义为:\n",
    "\n",
    "\\begin{equation} d_{u, v}=min_{T\\geq 0}\\sum_{i,j}^{}T_{ij}c(i,j)^u~~~~  s.t. \\sum_{j=1}^{}T_{ij}=d_i^u, ~~\\sum_{i=1}^{}T_{ij}=d_j'^v\\end{equation}\n",
    "\n",
    "这里  $c(i,j)=(x_i-x_j)^{\\top}M(x_i-x_j)$。 所以是不是可以察觉到这个问题目标函数里既包含了参数$M$也包含了线性规划问题。\n",
    "\n",
    "- #### Q3: 请试着去理解上述所有的过程,并回答: 优化问题如何解决呢? 请给出解题的思路 (文字适当配合推导过程)。 "
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "// TODO 你的答案.... "
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "对于上述问题,其实我们也可以采用不一样的损失函数来求解M。 一个常用的损失函数叫作 “kNN-LOO error”, 相当于把KNN的准确率转换成了smooth differential loss function. 感兴趣的朋友可以参考: https://papers.nips.cc/paper/6139-supervised-word-movers-distance.pdf\n",
    "\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "以上是优化部分的一个简短的作业,通过这些练习会对优化理论有更清晰的认知。  Good luck for everyone! "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.7.6"
  },
  "toc": {
   "base_numbering": 1,
   "nav_menu": {},
   "number_sections": true,
   "sideBar": true,
   "skip_h1_title": false,
   "title_cell": "Table of Contents",
   "title_sidebar": "Contents",
   "toc_cell": false,
   "toc_position": {},
   "toc_section_display": true,
   "toc_window_display": false
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}