Skip to main content

A Naive Bayes classifier that can identify double entendres.

Project description

TWSS
====

This is an implementation of a simple double entendre classifier in Python.

This currently uses a Naive Bayes classifier (the NLTK implementation) as a
Python package. This was inspired by the `bvandenvos Ruby TWSS project
<https://github.com/bvandenbos/twss/>`_ and uses the same data corpus.

This was built on the eve of `Barcamp Mumbai <http://barcampmumbai.org/>`_ 8
and presented during a session there.

Suggestions welcome. Do file bugs. Fork away. Send us pull requests.

Setup Instructions
------------------

.. code-block:: bash
$ virtualenv --no-site-packages --distribute venv
$ source venv/bin/activate
$ pip install -r requirements.txt

This creates a virtual environment for this project and install all the
packages necessary for the project to work.

Demo
----

Once this is installed, you can take it out for a spin:

.. code-block:: python

>>> from twss import TWSS
>>> twss = TWSS()
>>> twss("That was hard")
True
>>> twss("Hello world")
False

The first call can take a while- the module needs to train the classifier
against the pre-installed training dataset.

Getting dirty
-------------

You can supply your own training data using positive and negative corpus files:

.. code-block:: python

>>> twss = TWSS(positive_corpus_file=open('foo.txt'), negative_corpus_file=open('bar.txt'))

or directly, as a list of tuples:

.. code-block:: python

>>> training_data = [
... ("Sentence 1", True),
... ("Sentence 2", False),
...
... ]
>>> twss = TWSS(training_data)

Roadmap
-------

- Making this pip-installable.
- Writing a sample web app.
- Writing a sample Twitter client.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

twss-0.1.tar.gz (168.3 kB view details)

Uploaded Source

File details

Details for the file twss-0.1.tar.gz.

File metadata

  • Download URL: twss-0.1.tar.gz
  • Upload date:
  • Size: 168.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for twss-0.1.tar.gz
Algorithm Hash digest
SHA256 f080b1ac96f7cd164085d120957da64fce3055820f69df14b943f56ca9da8ad9
MD5 9869a2ef864a48411f33a90b89fc22b2
BLAKE2b-256 cd2730f884dc1b95b3ea841f695692392ebc5eef86745338c487abb273bd3527

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page