forked from piskvorky/gensim
-
Notifications
You must be signed in to change notification settings - Fork 6
/
install.html
266 lines (237 loc) · 12.5 KB
/
install.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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Installation — gensim</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.8.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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>
<link rel="author" title="About these documents" href="about.html" />
<link rel="top" title="gensim" href="index.html" />
<link rel="next" title="Tutorials" href="tutorial.html" />
<link rel="prev" title="Introduction" href="intro.html" />
<!-- twitter search widget
<script type="text/javascript" src="_static/widget.js"></script>
-->
<meta property="og:title" content="#gensim" />
<meta property="og:description" content="Efficient topic modelling in Python" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-24066335-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="tutorial.html" title="Tutorials"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="intro.html" title="Introduction"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Gensim home</a>| </li>
<li><a href="tutorial.html">Tutorials</a>| </li>
<li><a href="http://groups.google.com/group/gensim">Support</a>| </li>
<li><a href="https://github.com/piskvorky/gensim/wiki">Contribute</a>| </li>
<li><a href="apiref.html">API reference</a>»</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Installation</a><ul>
<li><a class="reference internal" href="#quick-install">Quick install</a></li>
<li><a class="reference internal" href="#dependencies">Dependencies</a></li>
<li><a class="reference internal" href="#install-python-and-easy-install">Install Python and <cite>easy_install</cite></a></li>
<li><a class="reference internal" href="#install-scipy-numpy">Install SciPy & NumPy</a></li>
<li><a class="reference internal" href="#install-gensim">Install <cite>gensim</cite></a></li>
<li><a class="reference internal" href="#testing-gensim">Testing <cite>gensim</cite></a></li>
<li><a class="reference internal" href="#contact">Contact</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="intro.html"
title="previous chapter">Introduction</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="tutorial.html"
title="next chapter">Tutorials</a></p>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="installation">
<span id="install"></span><h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
<div class="section" id="quick-install">
<h2>Quick install<a class="headerlink" href="#quick-install" title="Permalink to this headline">¶</a></h2>
<p>Run in your terminal:</p>
<div class="highlight-python"><pre>sudo easy_install -U gensim</pre>
</div>
<p>In case that fails, or you don’t know what “terminal” means, read on.</p>
</div>
<hr class="docutils" />
<div class="section" id="dependencies">
<h2>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h2>
<p>Gensim is known to run on Linux, Windows and Mac OS X and should run on any other
platform that supports Python 2.5 and NumPy. Gensim depends on the following software:</p>
<ul class="simple">
<li>3.0 > <a class="reference external" href="http://www.python.org">Python</a> >= 2.5. Tested with versions 2.5, 2.6 and 2.7.</li>
<li><a class="reference external" href="http://www.numpy.org">NumPy</a> >= 1.3. Tested with version 1.6.1rc2, 1.5.0rc1, 1.4.0, 1.3.0, 1.3.0rc2.</li>
<li><a class="reference external" href="http://www.scipy.org">SciPy</a> >= 0.7. Tested with version 0.9.0, 0.8.0, 0.8.0b1, 0.7.1, 0.7.0.</li>
</ul>
<p><strong>Windows users</strong> are well advised to try the <a class="reference external" href="http://www.enthought.com/products/epd.php">Enthought distribution</a>,
which conveniently includes Python&NumPy&SciPy in a single bundle, and is free for academic use.</p>
</div>
<div class="section" id="install-python-and-easy-install">
<h2>Install Python and <cite>easy_install</cite><a class="headerlink" href="#install-python-and-easy-install" title="Permalink to this headline">¶</a></h2>
<p>Check what version of Python you have with:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">python</span> <span class="o">--</span><span class="n">version</span>
</pre></div>
</div>
<p>You can download Python from <a class="reference external" href="http://python.org/download">http://python.org/download</a>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Gensim requires Python 2.5 or greater and will not run under earlier versions.</p>
</div>
<p>Next, install the <a class="reference external" href="http://pypi.python.org/pypi/setuptools">easy_install utility</a>,
which will make installing other Python programs easier.</p>
</div>
<div class="section" id="install-scipy-numpy">
<h2>Install SciPy & NumPy<a class="headerlink" href="#install-scipy-numpy" title="Permalink to this headline">¶</a></h2>
<p>These are quite popular Python packages, so chances are there are pre-built binary
distributions available for your platform. You can try installing from source using easy_install:</p>
<div class="highlight-python"><pre>sudo easy_install numpy
sudo easy_install scipy</pre>
</div>
<p>If that doesn’t work or if you’d rather install using a binary package, consult
<a class="reference external" href="http://www.scipy.org/Download">http://www.scipy.org/Download</a>.</p>
</div>
<div class="section" id="install-gensim">
<h2>Install <cite>gensim</cite><a class="headerlink" href="#install-gensim" title="Permalink to this headline">¶</a></h2>
<p>You can now install (or upgrade) <cite>gensim</cite> with:</p>
<div class="highlight-python"><pre>sudo easy_install --upgrade gensim</pre>
</div>
<p>That’s it! Congratulations, you can proceed to the <a class="reference internal" href="tutorial.html"><em>tutorials</em></a>.</p>
<hr class="docutils" />
<p>If you also want to run the algorithms over a cluster
of computers, in <a class="reference internal" href="distributed.html"><em>Distributed Computing</em></a>, you should install with:</p>
<div class="highlight-python"><pre>sudo easy_install gensim[distributed]</pre>
</div>
<p>The optional <cite>distributed</cite> feature installs <a class="reference external" href="http://pypi.python.org/pypi/Pyro">Pyro (PYthon Remote Objects)</a>.
If you don’t know what distributed computing means, you can ignore it:
<cite>gensim</cite> will work fine for you anyway.
This optional extension can also be installed separately later with:</p>
<div class="highlight-python"><pre>sudo easy_install Pyro4</pre>
</div>
<hr class="docutils" />
<p>There are also alternative routes to install:</p>
<ol class="arabic">
<li><p class="first">If you have downloaded and unzipped the <a class="reference external" href="http://pypi.python.org/pypi/gensim">tar.gz source</a>
for <cite>gensim</cite> (or you’re installing <cite>gensim</cite> from <a class="reference external" href="https://github.com/piskvorky/gensim/">github</a>),
you can run:</p>
<div class="highlight-python"><pre>sudo python setup.py install</pre>
</div>
<p>to install <cite>gensim</cite> into your <tt class="docutils literal"><span class="pre">site-packages</span></tt> folder.</p>
</li>
<li><p class="first">If you wish to make local changes to the <cite>gensim</cite> code (<cite>gensim</cite> is, after all, a
package which targets research prototyping and modifications), a preferred
way may be installing with:</p>
<div class="highlight-python"><pre>sudo python setup.py develop</pre>
</div>
<p>This will only place a symlink into your <tt class="docutils literal"><span class="pre">site-packages</span></tt> directory. The actual
files will stay wherever you unpacked them.</p>
</li>
<li><p class="first">If you don’t have root priviledges (or just don’t want to put the package into
your <tt class="docutils literal"><span class="pre">site-packages</span></tt>), simply unpack the source package somewhere and that’s it! No
compilation or installation needed. Just don’t forget to set your PYTHONPATH
(or modify <tt class="docutils literal"><span class="pre">sys.path</span></tt>), so that Python can find the unpacked package when importing.</p>
</li>
</ol>
</div>
<div class="section" id="testing-gensim">
<h2>Testing <cite>gensim</cite><a class="headerlink" href="#testing-gensim" title="Permalink to this headline">¶</a></h2>
<p>To test the package, unzip the <a class="reference external" href="http://pypi.python.org/pypi/gensim">tar.gz source</a> and run:</p>
<div class="highlight-python"><pre>python setup.py test</pre>
</div>
</div>
<div class="section" id="contact">
<h2>Contact<a class="headerlink" href="#contact" title="Permalink to this headline">¶</a></h2>
<p>Use the <a class="reference external" href="http://groups.google.com/group/gensim/">gensim discussion group</a> for
any questions and troubleshooting. For private enquiries, you can also send
me an email to the address at the bottom of this page.</p>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="tutorial.html" title="Tutorials"
>next</a> |</li>
<li class="right" >
<a href="intro.html" title="Introduction"
>previous</a> |</li>
<li><a href="index.html">Gensim home</a>| </li>
<li><a href="tutorial.html">Tutorials</a>| </li>
<li><a href="http://groups.google.com/group/gensim">Support</a>| </li>
<li><a href="https://github.com/piskvorky/gensim/wiki">Contribute</a>| </li>
<li><a href="apiref.html">API reference</a>»</li>
</ul>
</div>
<div class="footer">
© Copyright 2011, Radim Řehůřek <radimrehurek(at)seznam.cz>.
Last updated on Oct 31, 2011.
</div>
</body>
</html>