Metadata-Version: 2.0
Name: synonym-extractor
Version: 0.1.0
Summary: Extract synonyms from sentences using Aho Corasick algorithm
Home-page: http://github.com/vi3k6i5/synonym-extractor
Author: Vikash Singh
Author-email: vikash.duliajan@gmail.com
License: UNKNOWN
Platform: any
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License


synonym-extractor
==============

``Usage``::

  # Create an object of SynonymExtractor
  synonym_extractor = SynonymExtractor()

  # add synonyms to it
  synonym_names = ['NY', 'SF']
  clean_names = ['new york', 'san francisco']

  for synonym_name, clean_name in zip(synonym_names, clean_names):
      synonym_extractor.add_to_synonym(synonym_name, clean_name)

  synonyms_found = synonym_extractor.get_synonyms_from_sentence('I love SF and NY')

``Output``::

  synonyms_found
  >> ['new york', 'san francisco']

Algorithm
----------

synonym-extractor is based on `Aho-Corasick algorithm
<https://en.wikipedia.org/wiki/Aho%E2%80%93Corasick_algorithm>`_.

Documentation
----------

Documentation can be found at `Read the Docs
<http://synonym-extractor.readthedocs.org>`_.

License
-------

The project is licensed under the MIT license.


