collective.classification is a Plone product that aims to provide a set of tools for automatic document classification. Currently it makes use of the Natural Language Toolkit and features a trainable document classifier based on Part Of Speech (POS) tagging, heavily influenced by topia.termextract. This product is mostly intended to be used for experimentation and development. Currently english and dutch are supported.
What is this all about?
It's mostly about having fun! The package is in a very early experimental stage and awaits eagerly contributions. You will get a good understanding of what works or not by looking at the tests. You might also be able to do some useful things with it:
1) Term extraction can be performed to provide quick insight on what a document is about. 2) On a large site with a lot of content and tags (or subjects in the plone lingo) it might be difficult to assign tags to new content. In this case, a trained classifier could provide useful suggestions to an editor responsible for tagging content. 3) Similar documents can be found based on term similarity. 4) Clustering can help you organize unclassified content into groups.
How it works?
At the moment there exist the following type of utilities:
- POS taggers, utilities for classifying words in a document as Parts Of Speech. Two are provided at the moment, a Penn TreeBank tagger and a trigram tagger. Both can be trained with some other language than english which is what we do here.
- Term extractors, utilities responsible for extracting the important terms from some document. The extractor we use here, assumes that in a document only nouns matter and uses a POS tagger to find those mostly used in a document. For details please look at the code and the tests.
- Content classifiers, utilities that can tag content in predefined categories. Here, a naive Bayes classifier is used. Basically, the classifier looks at already tagged content, performs term extraction and trains itself using the terms and tags as an input. Then, for new content, the classifier will provide suggestions for tags according to the extracted terms of the content.
- Utilities that find similar content based on the extracted terms.
- Clusterers, utilities that without prior knowledge of content classification can group content into groups according to feature similarity. At the moment NLTK's k-means clusterer is used.
Installation & Setup
Before running buildout, make sure you have yaml and its python bindings installed (use macports on osx, or your package installer on linux). If nltk exists for your OS you might as well install that, otherwise it will be fetched when you run buildout.
To get started you will simply need to add the package to your "eggs" section and run buildout, restart your Plone instance and install the "collective.classification" package using the quick-installer or via the "Add-on Products" section in "Site Setup".
WARNING: Upon first time installation linguistic data will be fetched from NLTK's repository and stored locally on your filesystem. It's not big (about 400kb) but you need the plone user to have access to its "home". Running the tests will also fetch more data from nltk bringing the total to about 225Mb, so not for the faint at disk space.
- Removed the persistent noun storage altogether. Now noun and noun-phrase terms are stored directly in the catalog using plone.indexer. [ggozad, stefan]
- Using BTrees instead of PersistenDict. Should make writes to ZODB lighter. [ggozad]
- Noun-phrase grammar and normalization is now a property of the language-dependent tagger. [ggozad]
- Removed a lot of the control panel functionality. Not need for confusion. [ggozad]
- Fixed Dutch language support. [ggozad]