.. symspellpy documentation master file, created by
   sphinx-quickstart on Tue Feb 19 09:03:54 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

:orphan:

.. title:: symspellpy: a SymSpell Python port

.. toctree::
   :hidden:

   users/installing
   examples/index
   api/index

**********
symspellpy
**********

symspellpy is a Python port of SymSpell_ v6.7, a Symmetric Delete
spelling correction algorithm which provides much higher speed and lower
memory consumption.

.. _SymSpell: https://github.com/wolfgarbe/SymSpell

Unit tests from the original project are implemented to ensure the accuracy
of the port. Please note that the port has tried to replicate the code
structure of the original project and has not been optimized for speed.

Installation
============

Visit the :doc:`symspellpy installation instructions <users/installing>`.

Usage examples
==============

Check out :doc:`examples <examples/index>` to learn how to use symspellpy.

Documentation
=============

Check out the :doc:`documentation <api/index>`.

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`