-
Notifications
You must be signed in to change notification settings - Fork 47
/
api.html
334 lines (252 loc) · 21.4 KB
/
api.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
<!DOCTYPE html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="theme-color" content="#2D2D2D" />
<title>NLTK :: nltk.classify.api</title>
<link rel="stylesheet" href="../../../_static/css/nltk_theme.css"/>
<link rel="stylesheet" href="../../../_static/css/custom.css"/>
<script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script src="https://email.tl.fortawesome.com/c/eJxNjUEOgyAQAF8jR7Kw6wIHDh7sP1Cw2mgxgmn6-3JsMqc5zEQfE8dkxOY1KKMUOI3ACFKRJpSW2AAp7ontYIaxI6i7XPJVwyeVfCQ550Os3jLrGSNOLgbdAy6s0PBk2TFNjEbsfq31LB0OnX407pJa5v2faRadwSW63mn5KuLyR9j2tgx3zecanl-55R_-jjPs"></script>
</head>
<body>
<div id="nltk-theme-container">
<header>
<div id="logo-container">
<h1>
<a href="../../../index.html">NLTK</a>
</h1>
</div>
<div id="project-container">
<h1>Documentation</h1>
</div>
<a id="menu-toggle" class="fa fa-bars" aria-hidden="true"></a>
<script type="text/javascript">
$("#menu-toggle").click(function() {
$("#menu-toggle").toggleClass("toggled");
$("#side-menu-container").slideToggle(300);
});
</script>
</header>
<div id="content-container">
<div id="side-menu-container">
<div id="search" role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<div id="side-menu" role="navigation">
<p class="caption" role="heading"><span class="caption-text">NLTK Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../api/nltk.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference external" href="http://www.nltk.org/howto">Example Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../py-modindex.html">Module Index</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/nltk/nltk/wiki">Wiki</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/nltk/nltk/wiki/FAQ">FAQ</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Installation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../install.html">Installing NLTK</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../data.html">Installing NLTK Data</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">More</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../news.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../contribute.html">Contributing to NLTK</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../team.html">NLTK Team</a></li>
</ul>
</div>
</div>
<div id="main-content-container">
<div id="main-content" role="main">
<h1>Source code for nltk.classify.api</h1><div class="highlight"><pre>
<span></span><span class="c1"># Natural Language Toolkit: Classifier Interface</span>
<span class="c1">#</span>
<span class="c1"># Copyright (C) 2001-2021 NLTK Project</span>
<span class="c1"># Author: Edward Loper <edloper@gmail.com></span>
<span class="c1"># Steven Bird <stevenbird1@gmail.com> (minor additions)</span>
<span class="c1"># URL: <http://nltk.org/></span>
<span class="c1"># For license information, see LICENSE.TXT</span>
<span class="sd">"""</span>
<span class="sd">Interfaces for labeling tokens with category labels (or "class labels").</span>
<span class="sd">``ClassifierI`` is a standard interface for "single-category</span>
<span class="sd">classification", in which the set of categories is known, the number</span>
<span class="sd">of categories is finite, and each text belongs to exactly one</span>
<span class="sd">category.</span>
<span class="sd">``MultiClassifierI`` is a standard interface for "multi-category</span>
<span class="sd">classification", which is like single-category classification except</span>
<span class="sd">that each text belongs to zero or more categories.</span>
<span class="sd">"""</span>
<span class="kn">from</span> <span class="nn">nltk.internals</span> <span class="kn">import</span> <span class="n">overridden</span>
<span class="c1">##//////////////////////////////////////////////////////</span>
<span class="c1"># { Classification Interfaces</span>
<span class="c1">##//////////////////////////////////////////////////////</span>
<div class="viewcode-block" id="ClassifierI"><a class="viewcode-back" href="../../../api/nltk.classify.api.html#nltk.classify.api.ClassifierI">[docs]</a><span class="k">class</span> <span class="nc">ClassifierI</span><span class="p">:</span>
<span class="sd">"""</span>
<span class="sd"> A processing interface for labeling tokens with a single category</span>
<span class="sd"> label (or "class"). Labels are typically strs or</span>
<span class="sd"> ints, but can be any immutable type. The set of labels</span>
<span class="sd"> that the classifier chooses from must be fixed and finite.</span>
<span class="sd"> Subclasses must define:</span>
<span class="sd"> - ``labels()``</span>
<span class="sd"> - either ``classify()`` or ``classify_many()`` (or both)</span>
<span class="sd"> Subclasses may define:</span>
<span class="sd"> - either ``prob_classify()`` or ``prob_classify_many()`` (or both)</span>
<span class="sd"> """</span>
<div class="viewcode-block" id="ClassifierI.labels"><a class="viewcode-back" href="../../../api/nltk.classify.api.html#nltk.classify.api.ClassifierI.labels">[docs]</a> <span class="k">def</span> <span class="nf">labels</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :return: the list of category labels used by this classifier.</span>
<span class="sd"> :rtype: list of (immutable)</span>
<span class="sd"> """</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="ClassifierI.classify"><a class="viewcode-back" href="../../../api/nltk.classify.api.html#nltk.classify.api.ClassifierI.classify">[docs]</a> <span class="k">def</span> <span class="nf">classify</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">featureset</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :return: the most appropriate label for the given featureset.</span>
<span class="sd"> :rtype: label</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">overridden</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">classify_many</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">classify_many</span><span class="p">([</span><span class="n">featureset</span><span class="p">])[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="ClassifierI.prob_classify"><a class="viewcode-back" href="../../../api/nltk.classify.api.html#nltk.classify.api.ClassifierI.prob_classify">[docs]</a> <span class="k">def</span> <span class="nf">prob_classify</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">featureset</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :return: a probability distribution over labels for the given</span>
<span class="sd"> featureset.</span>
<span class="sd"> :rtype: ProbDistI</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">overridden</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">prob_classify_many</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">prob_classify_many</span><span class="p">([</span><span class="n">featureset</span><span class="p">])[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="ClassifierI.classify_many"><a class="viewcode-back" href="../../../api/nltk.classify.api.html#nltk.classify.api.ClassifierI.classify_many">[docs]</a> <span class="k">def</span> <span class="nf">classify_many</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">featuresets</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Apply ``self.classify()`` to each element of ``featuresets``. I.e.:</span>
<span class="sd"> return [self.classify(fs) for fs in featuresets]</span>
<span class="sd"> :rtype: list(label)</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">classify</span><span class="p">(</span><span class="n">fs</span><span class="p">)</span> <span class="k">for</span> <span class="n">fs</span> <span class="ow">in</span> <span class="n">featuresets</span><span class="p">]</span></div>
<div class="viewcode-block" id="ClassifierI.prob_classify_many"><a class="viewcode-back" href="../../../api/nltk.classify.api.html#nltk.classify.api.ClassifierI.prob_classify_many">[docs]</a> <span class="k">def</span> <span class="nf">prob_classify_many</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">featuresets</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Apply ``self.prob_classify()`` to each element of ``featuresets``. I.e.:</span>
<span class="sd"> return [self.prob_classify(fs) for fs in featuresets]</span>
<span class="sd"> :rtype: list(ProbDistI)</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">prob_classify</span><span class="p">(</span><span class="n">fs</span><span class="p">)</span> <span class="k">for</span> <span class="n">fs</span> <span class="ow">in</span> <span class="n">featuresets</span><span class="p">]</span></div></div>
<div class="viewcode-block" id="MultiClassifierI"><a class="viewcode-back" href="../../../api/nltk.classify.api.html#nltk.classify.api.MultiClassifierI">[docs]</a><span class="k">class</span> <span class="nc">MultiClassifierI</span><span class="p">:</span>
<span class="sd">"""</span>
<span class="sd"> A processing interface for labeling tokens with zero or more</span>
<span class="sd"> category labels (or "labels"). Labels are typically strs</span>
<span class="sd"> or ints, but can be any immutable type. The set of labels</span>
<span class="sd"> that the multi-classifier chooses from must be fixed and finite.</span>
<span class="sd"> Subclasses must define:</span>
<span class="sd"> - ``labels()``</span>
<span class="sd"> - either ``classify()`` or ``classify_many()`` (or both)</span>
<span class="sd"> Subclasses may define:</span>
<span class="sd"> - either ``prob_classify()`` or ``prob_classify_many()`` (or both)</span>
<span class="sd"> """</span>
<div class="viewcode-block" id="MultiClassifierI.labels"><a class="viewcode-back" href="../../../api/nltk.classify.api.html#nltk.classify.api.MultiClassifierI.labels">[docs]</a> <span class="k">def</span> <span class="nf">labels</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :return: the list of category labels used by this classifier.</span>
<span class="sd"> :rtype: list of (immutable)</span>
<span class="sd"> """</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="MultiClassifierI.classify"><a class="viewcode-back" href="../../../api/nltk.classify.api.html#nltk.classify.api.MultiClassifierI.classify">[docs]</a> <span class="k">def</span> <span class="nf">classify</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">featureset</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :return: the most appropriate set of labels for the given featureset.</span>
<span class="sd"> :rtype: set(label)</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">overridden</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">classify_many</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">classify_many</span><span class="p">([</span><span class="n">featureset</span><span class="p">])[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="MultiClassifierI.prob_classify"><a class="viewcode-back" href="../../../api/nltk.classify.api.html#nltk.classify.api.MultiClassifierI.prob_classify">[docs]</a> <span class="k">def</span> <span class="nf">prob_classify</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">featureset</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :return: a probability distribution over sets of labels for the</span>
<span class="sd"> given featureset.</span>
<span class="sd"> :rtype: ProbDistI</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">overridden</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">prob_classify_many</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">prob_classify_many</span><span class="p">([</span><span class="n">featureset</span><span class="p">])[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="MultiClassifierI.classify_many"><a class="viewcode-back" href="../../../api/nltk.classify.api.html#nltk.classify.api.MultiClassifierI.classify_many">[docs]</a> <span class="k">def</span> <span class="nf">classify_many</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">featuresets</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Apply ``self.classify()`` to each element of ``featuresets``. I.e.:</span>
<span class="sd"> return [self.classify(fs) for fs in featuresets]</span>
<span class="sd"> :rtype: list(set(label))</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">classify</span><span class="p">(</span><span class="n">fs</span><span class="p">)</span> <span class="k">for</span> <span class="n">fs</span> <span class="ow">in</span> <span class="n">featuresets</span><span class="p">]</span></div>
<div class="viewcode-block" id="MultiClassifierI.prob_classify_many"><a class="viewcode-back" href="../../../api/nltk.classify.api.html#nltk.classify.api.MultiClassifierI.prob_classify_many">[docs]</a> <span class="k">def</span> <span class="nf">prob_classify_many</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">featuresets</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Apply ``self.prob_classify()`` to each element of ``featuresets``. I.e.:</span>
<span class="sd"> return [self.prob_classify(fs) for fs in featuresets]</span>
<span class="sd"> :rtype: list(ProbDistI)</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">prob_classify</span><span class="p">(</span><span class="n">fs</span><span class="p">)</span> <span class="k">for</span> <span class="n">fs</span> <span class="ow">in</span> <span class="n">featuresets</span><span class="p">]</span></div></div>
<span class="c1"># # [XX] IN PROGRESS:</span>
<span class="c1"># class SequenceClassifierI:</span>
<span class="c1"># """</span>
<span class="c1"># A processing interface for labeling sequences of tokens with a</span>
<span class="c1"># single category label (or "class"). Labels are typically</span>
<span class="c1"># strs or ints, but can be any immutable type. The set</span>
<span class="c1"># of labels that the classifier chooses from must be fixed and</span>
<span class="c1"># finite.</span>
<span class="c1"># """</span>
<span class="c1"># def labels(self):</span>
<span class="c1"># """</span>
<span class="c1"># :return: the list of category labels used by this classifier.</span>
<span class="c1"># :rtype: list of (immutable)</span>
<span class="c1"># """</span>
<span class="c1"># raise NotImplementedError()</span>
<span class="c1"># def prob_classify(self, featureset):</span>
<span class="c1"># """</span>
<span class="c1"># Return a probability distribution over labels for the given</span>
<span class="c1"># featureset.</span>
<span class="c1"># If ``featureset`` is a list of featuresets, then return a</span>
<span class="c1"># corresponding list containing the probability distribution</span>
<span class="c1"># over labels for each of the given featuresets, where the</span>
<span class="c1"># *i*\ th element of this list is the most appropriate label for</span>
<span class="c1"># the *i*\ th element of ``featuresets``.</span>
<span class="c1"># """</span>
<span class="c1"># raise NotImplementedError()</span>
<span class="c1"># def classify(self, featureset):</span>
<span class="c1"># """</span>
<span class="c1"># Return the most appropriate label for the given featureset.</span>
<span class="c1"># If ``featureset`` is a list of featuresets, then return a</span>
<span class="c1"># corresponding list containing the most appropriate label for</span>
<span class="c1"># each of the given featuresets, where the *i*\ th element of</span>
<span class="c1"># this list is the most appropriate label for the *i*\ th element</span>
<span class="c1"># of ``featuresets``.</span>
<span class="c1"># """</span>
<span class="c1"># raise NotImplementedError()</span>
</pre></div>
</div>
</div>
</div>
<footer>
<div id="footer-info">
<ul id="build-details">
<li class="footer-element">
<a href="https://github.com/nltk/nltk/tree/3.6.5">3.6.5</a>
</li>
<li class="footer-element">
Oct 11, 2021
</li>
</ul>
<div id="copyright">
© 2021, NLTK Project
</div>
<div id="credit">
created with <a href="http://sphinx-doc.org/">Sphinx</a> and <a href="https://github.com/tomaarsen/nltk_theme">NLTK Theme</a>
</div>
</div>
</footer>
</div>
</body>
</html>