Skip to content

Benedixx/Symspellpy-documentation-helper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Symspellpy Documentation Helper

Symspellpy Documentation Helper

Introduction

Symspellpy Documentation Helper is a valuable LLM companion for developers working with Symspellpy, a Python library for spelling correction based on Symmetric Delete spelling correction algorithm. This tool streamlines the process of accessing and comprehending Symspellpy's documentation.

Features

  • Quick access to documentation: Easily navigate through Symspellpy documentation.
  • Simplified querying: Ask questions related to Symspellpy's usage, features, and functionalities.
  • Enhanced understanding: Get concise explanations and examples for better comprehension.
  • Visual aid: Utilize images and diagrams to enhance learning and understanding.

Installation

To use Symspellpy Documentation Helper, you need to clone the repository:

git clone https://github.com/Benedixx/Symspellpy-documentation-helper.git

and install all library that needed by:

pip install -r requirements.txt

Usage

  1. Download Symspellpy documentation :
python download_docs.py
  1. Create index on your pinecone databases in https://www.pinecone.io/ console
  2. make .env file and insert your Azure OpenAI endpoint and API key, and Pinecone host and API key
  3. Ingest data and store it on database by running this command :
python ingestion.py
  1. Open terminal and run :
streamlit run main.py

About

Chat based assistant about sysmpellpy documentation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages