-
Notifications
You must be signed in to change notification settings - Fork 47
/
api.html
213 lines (156 loc) · 12.3 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
<!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.cluster.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.cluster.api</h1><div class="highlight"><pre>
<span></span><span class="c1"># Natural Language Toolkit: Clusterer Interfaces</span>
<span class="c1">#</span>
<span class="c1"># Copyright (C) 2001-2021 NLTK Project</span>
<span class="c1"># Author: Trevor Cohn <tacohn@cs.mu.oz.au></span>
<span class="c1"># Porting: Steven Bird <stevenbird1@gmail.com></span>
<span class="c1"># URL: <http://nltk.org/></span>
<span class="c1"># For license information, see LICENSE.TXT</span>
<span class="kn">from</span> <span class="nn">abc</span> <span class="kn">import</span> <span class="n">ABCMeta</span><span class="p">,</span> <span class="n">abstractmethod</span>
<span class="kn">from</span> <span class="nn">nltk.probability</span> <span class="kn">import</span> <span class="n">DictionaryProbDist</span>
<div class="viewcode-block" id="ClusterI"><a class="viewcode-back" href="../../../api/nltk.cluster.api.html#nltk.cluster.api.ClusterI">[docs]</a><span class="k">class</span> <span class="nc">ClusterI</span><span class="p">(</span><span class="n">metaclass</span><span class="o">=</span><span class="n">ABCMeta</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Interface covering basic clustering functionality.</span>
<span class="sd"> """</span>
<div class="viewcode-block" id="ClusterI.cluster"><a class="viewcode-back" href="../../../api/nltk.cluster.api.html#nltk.cluster.api.ClusterI.cluster">[docs]</a> <span class="nd">@abstractmethod</span>
<span class="k">def</span> <span class="nf">cluster</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vectors</span><span class="p">,</span> <span class="n">assign_clusters</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Assigns the vectors to clusters, learning the clustering parameters</span>
<span class="sd"> from the data. Returns a cluster identifier for each vector.</span>
<span class="sd"> """</span></div>
<div class="viewcode-block" id="ClusterI.classify"><a class="viewcode-back" href="../../../api/nltk.cluster.api.html#nltk.cluster.api.ClusterI.classify">[docs]</a> <span class="nd">@abstractmethod</span>
<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">token</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Classifies the token into a cluster, setting the token's CLUSTER</span>
<span class="sd"> parameter to that cluster identifier.</span>
<span class="sd"> """</span></div>
<div class="viewcode-block" id="ClusterI.likelihood"><a class="viewcode-back" href="../../../api/nltk.cluster.api.html#nltk.cluster.api.ClusterI.likelihood">[docs]</a> <span class="k">def</span> <span class="nf">likelihood</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vector</span><span class="p">,</span> <span class="n">label</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns the likelihood (a float) of the token having the</span>
<span class="sd"> corresponding cluster.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">classify</span><span class="p">(</span><span class="n">vector</span><span class="p">)</span> <span class="o">==</span> <span class="n">label</span><span class="p">:</span>
<span class="k">return</span> <span class="mf">1.0</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="mf">0.0</span></div>
<div class="viewcode-block" id="ClusterI.classification_probdist"><a class="viewcode-back" href="../../../api/nltk.cluster.api.html#nltk.cluster.api.ClusterI.classification_probdist">[docs]</a> <span class="k">def</span> <span class="nf">classification_probdist</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vector</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Classifies the token into a cluster, returning</span>
<span class="sd"> a probability distribution over the cluster identifiers.</span>
<span class="sd"> """</span>
<span class="n">likelihoods</span> <span class="o">=</span> <span class="p">{}</span>
<span class="nb">sum</span> <span class="o">=</span> <span class="mf">0.0</span>
<span class="k">for</span> <span class="n">cluster</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cluster_names</span><span class="p">():</span>
<span class="n">likelihoods</span><span class="p">[</span><span class="n">cluster</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">likelihood</span><span class="p">(</span><span class="n">vector</span><span class="p">,</span> <span class="n">cluster</span><span class="p">)</span>
<span class="nb">sum</span> <span class="o">+=</span> <span class="n">likelihoods</span><span class="p">[</span><span class="n">cluster</span><span class="p">]</span>
<span class="k">for</span> <span class="n">cluster</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cluster_names</span><span class="p">():</span>
<span class="n">likelihoods</span><span class="p">[</span><span class="n">cluster</span><span class="p">]</span> <span class="o">/=</span> <span class="nb">sum</span>
<span class="k">return</span> <span class="n">DictionaryProbDist</span><span class="p">(</span><span class="n">likelihoods</span><span class="p">)</span></div>
<div class="viewcode-block" id="ClusterI.num_clusters"><a class="viewcode-back" href="../../../api/nltk.cluster.api.html#nltk.cluster.api.ClusterI.num_clusters">[docs]</a> <span class="nd">@abstractmethod</span>
<span class="k">def</span> <span class="nf">num_clusters</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns the number of clusters.</span>
<span class="sd"> """</span></div>
<div class="viewcode-block" id="ClusterI.cluster_names"><a class="viewcode-back" href="../../../api/nltk.cluster.api.html#nltk.cluster.api.ClusterI.cluster_names">[docs]</a> <span class="k">def</span> <span class="nf">cluster_names</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns the names of the clusters.</span>
<span class="sd"> :rtype: list</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">num_clusters</span><span class="p">()))</span></div>
<div class="viewcode-block" id="ClusterI.cluster_name"><a class="viewcode-back" href="../../../api/nltk.cluster.api.html#nltk.cluster.api.ClusterI.cluster_name">[docs]</a> <span class="k">def</span> <span class="nf">cluster_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns the names of the cluster at index.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">index</span></div></div>
</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>