Skip to content

Commit

Permalink
Gensim adopters table added (#754)
Browse files Browse the repository at this point in the history
  • Loading branch information
tmylk authored Jun 24, 2016
1 parent 48e2e0f commit c746b7c
Show file tree
Hide file tree
Showing 4 changed files with 151 additions and 110 deletions.
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ recursive-include docs *
recursive-include gensim/test/test_data *
recursive-include . *.sh
prune docs/src*
include README.rst
include README.md
include CHANGELOG.md
include COPYING
include COPYING.LESSER
Expand Down
149 changes: 149 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
gensim – Topic Modelling in Python
==================================

![Travis]![Wheel]

Gensim is a Python library for *topic modelling*, *document indexing*
and *similarity retrieval* with large corpora. Target audience is the
*natural language processing* (NLP) and *information retrieval* (IR)
community.

Features
--------

- All algorithms are **memory-independent** w.r.t. the corpus size
(can process input larger than RAM, streamed, out-of-core),
- **Intuitive interfaces**
- easy to plug in your own input corpus/datastream (trivial
streaming API)
- easy to extend with other Vector Space algorithms (trivial
transformation API)
- Efficient multicore implementations of popular algorithms, such as
online **Latent Semantic Analysis (LSA/LSI/SVD)**, **Latent
Dirichlet Allocation (LDA)**, **Random Projections (RP)**,
**Hierarchical Dirichlet Process (HDP)** or **word2vec deep
learning**.

This comment has been minimized.

Copy link
@dselivanov

dselivanov Sep 14, 2016

"deep learning" is not so deep :-)

This comment has been minimized.

Copy link
@tmylk

tmylk Sep 27, 2016

Author Contributor

:) I wish they had a "more layers" emoji on github

- **Distributed computing**: can run *Latent Semantic Analysis* and
*Latent Dirichlet Allocation* on a cluster of computers.
- Extensive [documentation and Jupyter Notebook tutorials].

If this feature list left you scratching your head, you can first read
more about the [Vector Space Model] and [unsupervised document analysis]
on Wikipedia.

Installation
------------

This software depends on [NumPy and Scipy], two Python packages for
scientific computing. You must have them installed prior to installing
gensim.

It is also recommended you install a fast BLAS library before installing
NumPy. This is optional, but using an optimized BLAS such as [ATLAS] or
[OpenBLAS] is known to improve performance by as much as an order of
magnitude. On OS X, NumPy picks up the BLAS that comes with it
automatically, so you don’t need to do anything special.

The simple way to install gensim is:

pip install -U gensim

Or, if you have instead downloaded and unzipped the [source tar.gz]
package, you’d run:

python setup.py test
python setup.py install

For alternative modes of installation (without root privileges,
development installation, optional install features), see the
[documentation].

This version has been tested under Python 2.6, 2.7, 3.3, 3.4 and 3.5
(support for Python 2.5 was dropped in gensim 0.10.0; install gensim
0.9.1 if you *must* use Python 2.5). Gensim’s github repo is hooked
against [Travis CI for automated testing] on every commit push and pull
request.

How come gensim is so fast and memory efficient? Isn’t it pure Python, and isn’t Python slow and greedy?
--------------------------------------------------------------------------------------------------------

Many scientific algorithms can be expressed in terms of large matrix
operations (see the BLAS note above). Gensim taps into these low-level
BLAS libraries, by means of its dependency on NumPy. So while
gensim-the-top-level-code is pure Python, it actually executes highly
optimized Fortran/C under the hood, including multithreading (if your
BLAS is so configured).

Memory-wise, gensim makes heavy use of Python’s built-in generators and
iterators for streamed data processing. Memory efficiency was one of
gensim’s [design goals], and is a central feature of gensim, rather than
something bolted on as an afterthought.

Documentation
-------------

- [QuickStart]
- [Tutorials]
- [Tutorial Videos]
- [Official Documentation and Walkthrough]

[QuickStart]: https://github.com/RaRe-Technologies/gensim/blob/develop/docs/notebooks/gensim%20Quick%20Start.ipynb
[Tutorials]: https://github.com/RaRe-Technologies/gensim/blob/develop/tutorials.md#tutorials
[Tutorial Videos]: https://github.com/RaRe-Technologies/gensim/blob/develop/tutorials.md#videos
[Official Documentation and Walkthrough]: http://radimrehurek.com/gensim/

---------

Adopters
--------



| Name | Logo | URL | Description |
|----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| RaRe Technologies | <img src="http://rare-technologies.com/wp-content/uploads/2016/02/rare_image_only.png" width="100"> | [rare-technologies.com](http://rare-technologies.com) | Machine Learning NLP consulting and training |
| Talentpair | ![Talentpair](https://avatars3.githubusercontent.com/u/8418395?v=3&s=100) | [talentpair.com](http://talentpair.com) | Data science driving high-touch recruiting |
-------



Citing gensim
------------

When [citing gensim in academic papers and theses], please use this
BibTeX entry:

@inproceedings{rehurek_lrec,
title = {{Software Framework for Topic Modelling with Large Corpora}},
author = {Radim {\v R}eh{\r u}{\v r}ek and Petr Sojka},
booktitle = {{Proceedings of the LREC 2010 Workshop on New
Challenges for NLP Frameworks}},
pages = {45--50},
year = 2010,
month = May,
day = 22,
publisher = {ELRA},
address = {Valletta, Malta},
note={\url{http://is.muni.cz/publication/884893/en}},
language={English}
}

[citing gensim in academic papers and theses]: https://scholar.google.cz/citations?view_op=view_citation&hl=en&user=9vG_kV0AAAAJ&citation_for_view=9vG_kV0AAAAJ:u-x6o8ySG0sC

[Travis CI for automated testing]: https://travis-ci.org/RaRe-Technologies/gensim
[design goals]: http://radimrehurek.com/gensim/about.html
[RaRe Technologies]: http://rare-technologies.com/wp-content/uploads/2016/02/rare_image_only.png%20=10x20
[rare\_tech]: //rare-technologies.com
[Talentpair]: https://avatars3.githubusercontent.com/u/8418395?v=3&s=100
[citing gensim in academic papers and theses]: https://scholar.google.cz/citations?view_op=view_citation&hl=en&user=9vG_kV0AAAAJ&citation_for_view=9vG_kV0AAAAJ:u-x6o8ySG0sC

[Travis]: https://img.shields.io/travis/RaRe-Technologies/gensim/develop.svg
[Wheel]: https://img.shields.io/pypi/wheel/gensim.svg
[documentation and Jupyter Notebook tutorials]: https://github.com/RaRe-Technologies/gensim/#documentation
[Vector Space Model]: http://en.wikipedia.org/wiki/Vector_space_model
[unsupervised document analysis]: http://en.wikipedia.org/wiki/Latent_semantic_indexing
[NumPy and Scipy]: http://www.scipy.org/Download
[ATLAS]: http://math-atlas.sourceforge.net/
[OpenBLAS]: http://xianyi.github.io/OpenBLAS/
[source tar.gz]: http://pypi.python.org/pypi/gensim
[documentation]: http://radimrehurek.com/gensim/install.html
108 changes: 0 additions & 108 deletions README.rst

This file was deleted.

2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ def readfile(fname):
name='gensim',
version='0.13.1',
description='Python framework for fast Vector Space Modelling',
long_description=readfile('README.rst'),
long_description=readfile('README.md'),

ext_modules=[
Extension('gensim.models.word2vec_inner',
Expand Down

0 comments on commit c746b7c

Please sign in to comment.