/doc/tagger.tagger.Tagger-class.html

http://github.com/apresta/tagger · HTML · 253 lines · 213 code · 19 blank · 21 comment · 0 complexity · 01cd215539373cdd63226116e6858900 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.Tagger</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;Tagger
  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.Tagger-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 Tagger</h1><p class="nomargin-top"><span class="codelink"><a href="tagger.tagger-pysrc.html#Tagger">source&nbsp;code</a></span></p>
  57. <p>Master class for tagging text documents</p>
  58. <p>(this is a simple interface that should allow convenient
  59. experimentation by using different classes as building blocks)</p>
  60. <!-- ==================== INSTANCE METHODS ==================== -->
  61. <a name="section-InstanceMethods"></a>
  62. <table class="summary" border="1" cellpadding="3"
  63. cellspacing="0" width="100%" bgcolor="white">
  64. <tr bgcolor="#70b0f0" class="table-header">
  65. <td colspan="2" class="table-header">
  66. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  67. <tr valign="top">
  68. <td align="left"><span class="table-header">Instance Methods</span></td>
  69. <td align="right" valign="top"
  70. ><span class="options">[<a href="#section-InstanceMethods"
  71. class="privatelink" onclick="toggle_private();"
  72. >hide private</a>]</span></td>
  73. </tr>
  74. </table>
  75. </td>
  76. </tr>
  77. <tr>
  78. <td width="15%" align="right" valign="top" class="summary">
  79. <span class="summary-type">&nbsp;</span>
  80. </td><td class="summary">
  81. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  82. <tr>
  83. <td><span class="summary-sig"><a href="tagger.tagger.Tagger-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
  84. <span class="summary-sig-arg">reader</span>,
  85. <span class="summary-sig-arg">stemmer</span>,
  86. <span class="summary-sig-arg">rater</span>)</span><br />
  87. Returns:
  88. a new <a href="tagger.tagger.Tagger-class.html"
  89. class="link">Tagger</a> object</td>
  90. <td align="right" valign="top">
  91. <span class="codelink"><a href="tagger.tagger-pysrc.html#Tagger.__init__">source&nbsp;code</a></span>
  92. </td>
  93. </tr>
  94. </table>
  95. </td>
  96. </tr>
  97. <tr>
  98. <td width="15%" align="right" valign="top" class="summary">
  99. <span class="summary-type">&nbsp;</span>
  100. </td><td class="summary">
  101. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  102. <tr>
  103. <td><span class="summary-sig"><a href="tagger.tagger.Tagger-class.html#__call__" class="summary-sig-name">__call__</a>(<span class="summary-sig-arg">self</span>,
  104. <span class="summary-sig-arg">text</span>,
  105. <span class="summary-sig-arg">tags_number</span>=<span class="summary-sig-default">5</span>)</span></td>
  106. <td align="right" valign="top">
  107. <span class="codelink"><a href="tagger.tagger-pysrc.html#Tagger.__call__">source&nbsp;code</a></span>
  108. </td>
  109. </tr>
  110. </table>
  111. </td>
  112. </tr>
  113. </table>
  114. <!-- ==================== METHOD DETAILS ==================== -->
  115. <a name="section-MethodDetails"></a>
  116. <table class="details" border="1" cellpadding="3"
  117. cellspacing="0" width="100%" bgcolor="white">
  118. <tr bgcolor="#70b0f0" class="table-header">
  119. <td colspan="2" class="table-header">
  120. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  121. <tr valign="top">
  122. <td align="left"><span class="table-header">Method Details</span></td>
  123. <td align="right" valign="top"
  124. ><span class="options">[<a href="#section-MethodDetails"
  125. class="privatelink" onclick="toggle_private();"
  126. >hide private</a>]</span></td>
  127. </tr>
  128. </table>
  129. </td>
  130. </tr>
  131. </table>
  132. <a name="__init__"></a>
  133. <div>
  134. <table class="details" border="1" cellpadding="3"
  135. cellspacing="0" width="100%" bgcolor="white">
  136. <tr><td>
  137. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  138. <tr valign="top"><td>
  139. <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
  140. <span class="sig-arg">reader</span>,
  141. <span class="sig-arg">stemmer</span>,
  142. <span class="sig-arg">rater</span>)</span>
  143. <br /><em class="fname">(Constructor)</em>
  144. </h3>
  145. </td><td align="right" valign="top"
  146. ><span class="codelink"><a href="tagger.tagger-pysrc.html#Tagger.__init__">source&nbsp;code</a></span>&nbsp;
  147. </td>
  148. </tr></table>
  149. <dl class="fields">
  150. <dt>Parameters:</dt>
  151. <dd><ul class="nomargin-top">
  152. <li><strong class="pname"><code>reader</code></strong> - a <a href="tagger.tagger.Reader-class.html"
  153. class="link">Reader</a> object</li>
  154. <li><strong class="pname"><code>stemmer</code></strong> - a <a href="tagger.tagger.Stemmer-class.html"
  155. class="link">Stemmer</a> object</li>
  156. <li><strong class="pname"><code>rater</code></strong> - a <a href="tagger.tagger.Rater-class.html" class="link">Rater</a>
  157. object</li>
  158. </ul></dd>
  159. <dt>Returns:</dt>
  160. <dd>a new <a href="tagger.tagger.Tagger-class.html"
  161. class="link">Tagger</a> object</dd>
  162. </dl>
  163. </td></tr></table>
  164. </div>
  165. <a name="__call__"></a>
  166. <div>
  167. <table class="details" border="1" cellpadding="3"
  168. cellspacing="0" width="100%" bgcolor="white">
  169. <tr><td>
  170. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  171. <tr valign="top"><td>
  172. <h3 class="epydoc"><span class="sig"><span class="sig-name">__call__</span>(<span class="sig-arg">self</span>,
  173. <span class="sig-arg">text</span>,
  174. <span class="sig-arg">tags_number</span>=<span class="sig-default">5</span>)</span>
  175. <br /><em class="fname">(Call operator)</em>
  176. </h3>
  177. </td><td align="right" valign="top"
  178. ><span class="codelink"><a href="tagger.tagger-pysrc.html#Tagger.__call__">source&nbsp;code</a></span>&nbsp;
  179. </td>
  180. </tr></table>
  181. <dl class="fields">
  182. <dt>Parameters:</dt>
  183. <dd><ul class="nomargin-top">
  184. <li><strong class="pname"><code>text</code></strong> - the string of text to be tagged</li>
  185. <li><strong class="pname"><code>tags_number</code></strong> - number of best tags to be returned
  186. <p>Returns: a list of (hopefully) relevant tags</p></li>
  187. </ul></dd>
  188. </dl>
  189. </td></tr></table>
  190. </div>
  191. <br />
  192. <!-- ==================== NAVIGATION BAR ==================== -->
  193. <table class="navbar" border="0" width="100%" cellpadding="0"
  194. bgcolor="#a0c0ff" cellspacing="0">
  195. <tr valign="middle">
  196. <!-- Tree link -->
  197. <th>&nbsp;&nbsp;&nbsp;<a
  198. href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  199. <!-- Index link -->
  200. <th>&nbsp;&nbsp;&nbsp;<a
  201. href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  202. <!-- Help link -->
  203. <th>&nbsp;&nbsp;&nbsp;<a
  204. href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  205. <!-- Project homepage -->
  206. <th class="navbar" align="right" width="100%">
  207. <table border="0" cellpadding="0" cellspacing="0">
  208. <tr><th class="navbar" align="center"
  209. ><a class="navbar" target="_top" href="http://github.com/apresta/tagger">tagger</a></th>
  210. </tr></table></th>
  211. </tr>
  212. </table>
  213. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
  214. <tr>
  215. <td align="left" class="footer">
  216. Generated by Epydoc 3.0.1 on Wed Jun 8 01:57:46 2011
  217. </td>
  218. <td align="right" class="footer">
  219. <a target="mainFrame" href="http://epydoc.sourceforge.net"
  220. >http://epydoc.sourceforge.net</a>
  221. </td>
  222. </tr>
  223. </table>
  224. <script type="text/javascript">
  225. <!--
  226. // Private objects are initially displayed (because if
  227. // javascript is turned off then we want them to be
  228. // visible); but by default, we want to hide them. So hide
  229. // them unless we have a cookie that says to show them.
  230. checkCookie();
  231. // -->
  232. </script>
  233. </body>
  234. </html>