/doc/tagger.tagger.Rater-class.html

http://github.com/apresta/tagger · HTML · 343 lines · 295 code · 27 blank · 21 comment · 0 complexity · 1c56af4820420d7c36c37efe1b62004b MD5 · raw file

  1. <?xml version="1.0" encoding="ascii"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  3. "DTD/xhtml1-transitional.dtd">
  4. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  5. <head>
  6. <title>tagger.tagger.Rater</title>
  7. <link rel="stylesheet" href="epydoc.css" type="text/css" />
  8. <script type="text/javascript" src="epydoc.js"></script>
  9. </head>
  10. <body bgcolor="white" text="black" link="blue" vlink="#204080"
  11. alink="#204080">
  12. <!-- ==================== NAVIGATION BAR ==================== -->
  13. <table class="navbar" border="0" width="100%" cellpadding="0"
  14. bgcolor="#a0c0ff" cellspacing="0">
  15. <tr valign="middle">
  16. <!-- Tree link -->
  17. <th>&nbsp;&nbsp;&nbsp;<a
  18. href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  19. <!-- Index link -->
  20. <th>&nbsp;&nbsp;&nbsp;<a
  21. href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  22. <!-- Help link -->
  23. <th>&nbsp;&nbsp;&nbsp;<a
  24. href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  25. <!-- Project homepage -->
  26. <th class="navbar" align="right" width="100%">
  27. <table border="0" cellpadding="0" cellspacing="0">
  28. <tr><th class="navbar" align="center"
  29. ><a class="navbar" target="_top" href="http://github.com/apresta/tagger">tagger</a></th>
  30. </tr></table></th>
  31. </tr>
  32. </table>
  33. <table width="100%" cellpadding="0" cellspacing="0">
  34. <tr valign="top">
  35. <td width="100%">
  36. <span class="breadcrumbs">
  37. Package&nbsp;tagger ::
  38. <a href="tagger.tagger-module.html">Module&nbsp;tagger</a> ::
  39. Class&nbsp;Rater
  40. </span>
  41. </td>
  42. <td>
  43. <table cellpadding="0" cellspacing="0">
  44. <!-- hide/show private -->
  45. <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  46. onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  47. <tr><td align="right"><span class="options"
  48. >[<a href="frames.html" target="_top">frames</a
  49. >]&nbsp;|&nbsp;<a href="tagger.tagger.Rater-class.html"
  50. target="_top">no&nbsp;frames</a>]</span></td></tr>
  51. </table>
  52. </td>
  53. </tr>
  54. </table>
  55. <!-- ==================== CLASS DESCRIPTION ==================== -->
  56. <h1 class="epydoc">Class Rater</h1><p class="nomargin-top"><span class="codelink"><a href="tagger.tagger-pysrc.html#Rater">source&nbsp;code</a></span></p>
  57. <center>
  58. <center> <map id="class_hierarchy_for_rater" name="class_hierarchy_for_rater">
  59. <area shape="rect" id="node1" href="tagger.extras.NaiveRater-class.html" title="extras.NaiveRater" alt="" coords="5,61,149,88"/>
  60. <area shape="rect" id="node2" href="tagger.tagger.Rater-class.html" title="Rater" alt="" coords="48,5,107,32"/>
  61. </map>
  62. <img src="class_hierarchy_for_rater.gif" alt='' usemap="#class_hierarchy_for_rater" ismap="ismap" class="graph-without-title" />
  63. </center>
  64. </center>
  65. <hr />
  66. <p>Class for estimating the relevance of tags</p>
  67. <p>(the default implementation uses TF (term frequency) multiplied by
  68. weight, but any other reasonable measure is fine; a quite rudimental
  69. heuristic tries to discard redundant tags)</p>
  70. <!-- ==================== INSTANCE METHODS ==================== -->
  71. <a name="section-InstanceMethods"></a>
  72. <table class="summary" border="1" cellpadding="3"
  73. cellspacing="0" width="100%" bgcolor="white">
  74. <tr bgcolor="#70b0f0" class="table-header">
  75. <td colspan="2" class="table-header">
  76. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  77. <tr valign="top">
  78. <td align="left"><span class="table-header">Instance Methods</span></td>
  79. <td align="right" valign="top"
  80. ><span class="options">[<a href="#section-InstanceMethods"
  81. class="privatelink" onclick="toggle_private();"
  82. >hide private</a>]</span></td>
  83. </tr>
  84. </table>
  85. </td>
  86. </tr>
  87. <tr>
  88. <td width="15%" align="right" valign="top" class="summary">
  89. <span class="summary-type">&nbsp;</span>
  90. </td><td class="summary">
  91. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  92. <tr>
  93. <td><span class="summary-sig"><a href="tagger.tagger.Rater-class.html#__call__" class="summary-sig-name">__call__</a>(<span class="summary-sig-arg">self</span>,
  94. <span class="summary-sig-arg">tags</span>)</span><br />
  95. Returns:
  96. a list of unique (multi)tags sorted by relevance</td>
  97. <td align="right" valign="top">
  98. <span class="codelink"><a href="tagger.tagger-pysrc.html#Rater.__call__">source&nbsp;code</a></span>
  99. </td>
  100. </tr>
  101. </table>
  102. </td>
  103. </tr>
  104. <tr>
  105. <td width="15%" align="right" valign="top" class="summary">
  106. <span class="summary-type">&nbsp;</span>
  107. </td><td class="summary">
  108. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  109. <tr>
  110. <td><span class="summary-sig"><a href="tagger.tagger.Rater-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
  111. <span class="summary-sig-arg">weights</span>,
  112. <span class="summary-sig-arg">multitag_size</span>=<span class="summary-sig-default">3</span>)</span><br />
  113. Returns:
  114. a new <a href="tagger.tagger.Rater-class.html" class="link">Rater</a>
  115. object</td>
  116. <td align="right" valign="top">
  117. <span class="codelink"><a href="tagger.tagger-pysrc.html#Rater.__init__">source&nbsp;code</a></span>
  118. </td>
  119. </tr>
  120. </table>
  121. </td>
  122. </tr>
  123. <tr>
  124. <td width="15%" align="right" valign="top" class="summary">
  125. <span class="summary-type">&nbsp;</span>
  126. </td><td class="summary">
  127. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  128. <tr>
  129. <td><span class="summary-sig"><a href="tagger.tagger.Rater-class.html#create_multitags" class="summary-sig-name">create_multitags</a>(<span class="summary-sig-arg">self</span>,
  130. <span class="summary-sig-arg">tags</span>)</span><br />
  131. Returns:
  132. a list of multitags</td>
  133. <td align="right" valign="top">
  134. <span class="codelink"><a href="tagger.tagger-pysrc.html#Rater.create_multitags">source&nbsp;code</a></span>
  135. </td>
  136. </tr>
  137. </table>
  138. </td>
  139. </tr>
  140. <tr>
  141. <td width="15%" align="right" valign="top" class="summary">
  142. <span class="summary-type">&nbsp;</span>
  143. </td><td class="summary">
  144. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  145. <tr>
  146. <td><span class="summary-sig"><a href="tagger.tagger.Rater-class.html#rate_tags" class="summary-sig-name">rate_tags</a>(<span class="summary-sig-arg">self</span>,
  147. <span class="summary-sig-arg">tags</span>)</span></td>
  148. <td align="right" valign="top">
  149. <span class="codelink"><a href="tagger.tagger-pysrc.html#Rater.rate_tags">source&nbsp;code</a></span>
  150. </td>
  151. </tr>
  152. </table>
  153. </td>
  154. </tr>
  155. </table>
  156. <!-- ==================== METHOD DETAILS ==================== -->
  157. <a name="section-MethodDetails"></a>
  158. <table class="details" border="1" cellpadding="3"
  159. cellspacing="0" width="100%" bgcolor="white">
  160. <tr bgcolor="#70b0f0" class="table-header">
  161. <td colspan="2" class="table-header">
  162. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  163. <tr valign="top">
  164. <td align="left"><span class="table-header">Method Details</span></td>
  165. <td align="right" valign="top"
  166. ><span class="options">[<a href="#section-MethodDetails"
  167. class="privatelink" onclick="toggle_private();"
  168. >hide private</a>]</span></td>
  169. </tr>
  170. </table>
  171. </td>
  172. </tr>
  173. </table>
  174. <a name="__call__"></a>
  175. <div>
  176. <table class="details" border="1" cellpadding="3"
  177. cellspacing="0" width="100%" bgcolor="white">
  178. <tr><td>
  179. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  180. <tr valign="top"><td>
  181. <h3 class="epydoc"><span class="sig"><span class="sig-name">__call__</span>(<span class="sig-arg">self</span>,
  182. <span class="sig-arg">tags</span>)</span>
  183. <br /><em class="fname">(Call operator)</em>
  184. </h3>
  185. </td><td align="right" valign="top"
  186. ><span class="codelink"><a href="tagger.tagger-pysrc.html#Rater.__call__">source&nbsp;code</a></span>&nbsp;
  187. </td>
  188. </tr></table>
  189. <dl class="fields">
  190. <dt>Parameters:</dt>
  191. <dd><ul class="nomargin-top">
  192. <li><strong class="pname"><code>tags</code></strong> - a list of (preferably stemmed) tags</li>
  193. </ul></dd>
  194. <dt>Returns:</dt>
  195. <dd>a list of unique (multi)tags sorted by relevance</dd>
  196. </dl>
  197. </td></tr></table>
  198. </div>
  199. <a name="__init__"></a>
  200. <div>
  201. <table class="details" border="1" cellpadding="3"
  202. cellspacing="0" width="100%" bgcolor="white">
  203. <tr><td>
  204. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  205. <tr valign="top"><td>
  206. <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
  207. <span class="sig-arg">weights</span>,
  208. <span class="sig-arg">multitag_size</span>=<span class="sig-default">3</span>)</span>
  209. <br /><em class="fname">(Constructor)</em>
  210. </h3>
  211. </td><td align="right" valign="top"
  212. ><span class="codelink"><a href="tagger.tagger-pysrc.html#Rater.__init__">source&nbsp;code</a></span>&nbsp;
  213. </td>
  214. </tr></table>
  215. <dl class="fields">
  216. <dt>Parameters:</dt>
  217. <dd><ul class="nomargin-top">
  218. <li><strong class="pname"><code>weights</code></strong> - a dictionary of weights normalized in the interval [0,1]</li>
  219. <li><strong class="pname"><code>multitag_size</code></strong> - maximum size of tags formed by multiple unit tags</li>
  220. </ul></dd>
  221. <dt>Returns:</dt>
  222. <dd>a new <a href="tagger.tagger.Rater-class.html"
  223. class="link">Rater</a> object</dd>
  224. </dl>
  225. </td></tr></table>
  226. </div>
  227. <a name="create_multitags"></a>
  228. <div>
  229. <table class="details" border="1" cellpadding="3"
  230. cellspacing="0" width="100%" bgcolor="white">
  231. <tr><td>
  232. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  233. <tr valign="top"><td>
  234. <h3 class="epydoc"><span class="sig"><span class="sig-name">create_multitags</span>(<span class="sig-arg">self</span>,
  235. <span class="sig-arg">tags</span>)</span>
  236. </h3>
  237. </td><td align="right" valign="top"
  238. ><span class="codelink"><a href="tagger.tagger-pysrc.html#Rater.create_multitags">source&nbsp;code</a></span>&nbsp;
  239. </td>
  240. </tr></table>
  241. <dl class="fields">
  242. <dt>Parameters:</dt>
  243. <dd><ul class="nomargin-top">
  244. <li><strong class="pname"><code>tags</code></strong> - a list of tags (respecting the order in the text)</li>
  245. </ul></dd>
  246. <dt>Returns:</dt>
  247. <dd>a list of multitags</dd>
  248. </dl>
  249. </td></tr></table>
  250. </div>
  251. <a name="rate_tags"></a>
  252. <div>
  253. <table class="details" border="1" cellpadding="3"
  254. cellspacing="0" width="100%" bgcolor="white">
  255. <tr><td>
  256. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  257. <tr valign="top"><td>
  258. <h3 class="epydoc"><span class="sig"><span class="sig-name">rate_tags</span>(<span class="sig-arg">self</span>,
  259. <span class="sig-arg">tags</span>)</span>
  260. </h3>
  261. </td><td align="right" valign="top"
  262. ><span class="codelink"><a href="tagger.tagger-pysrc.html#Rater.rate_tags">source&nbsp;code</a></span>&nbsp;
  263. </td>
  264. </tr></table>
  265. <dl class="fields">
  266. <dt>Parameters:</dt>
  267. <dd><ul class="nomargin-top">
  268. <li><strong class="pname"><code>tags</code></strong> - a list of tags to be assigned a rating</li>
  269. </ul></dd>
  270. </dl>
  271. </td></tr></table>
  272. </div>
  273. <br />
  274. <!-- ==================== NAVIGATION BAR ==================== -->
  275. <table class="navbar" border="0" width="100%" cellpadding="0"
  276. bgcolor="#a0c0ff" cellspacing="0">
  277. <tr valign="middle">
  278. <!-- Tree link -->
  279. <th>&nbsp;&nbsp;&nbsp;<a
  280. href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  281. <!-- Index link -->
  282. <th>&nbsp;&nbsp;&nbsp;<a
  283. href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  284. <!-- Help link -->
  285. <th>&nbsp;&nbsp;&nbsp;<a
  286. href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  287. <!-- Project homepage -->
  288. <th class="navbar" align="right" width="100%">
  289. <table border="0" cellpadding="0" cellspacing="0">
  290. <tr><th class="navbar" align="center"
  291. ><a class="navbar" target="_top" href="http://github.com/apresta/tagger">tagger</a></th>
  292. </tr></table></th>
  293. </tr>
  294. </table>
  295. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
  296. <tr>
  297. <td align="left" class="footer">
  298. Generated by Epydoc 3.0.1 on Wed Jun 8 01:57:46 2011
  299. </td>
  300. <td align="right" class="footer">
  301. <a target="mainFrame" href="http://epydoc.sourceforge.net"
  302. >http://epydoc.sourceforge.net</a>
  303. </td>
  304. </tr>
  305. </table>
  306. <script type="text/javascript">
  307. <!--
  308. // Private objects are initially displayed (because if
  309. // javascript is turned off then we want them to be
  310. // visible); but by default, we want to hide them. So hide
  311. // them unless we have a cookie that says to show them.
  312. checkCookie();
  313. // -->
  314. </script>
  315. </body>
  316. </html>