Add examples in our documentation

[R1j1t]

We have examples of how to use this package in English and Japanese. It would help if we can improve our documentation so that it becomes easy to understand contextualSpellCheck for others maybe add documentation in other languages.

[R1j1t]

This looks like a good first start
https://packaging.python.org/tutorials/creating-documentation/

[jenriqps]

This is an example for Spanish

import contextualSpellCheck
import os
os.environ['HF_HUB_DISABLE_SYMLINKS_WARNING'] = 'True'
nlp_es = spacy.load("es_core_news_sm")
print(nlp_es.pipe_names)

There are more trained models here https://huggingface.co/models?pipeline_tag=fill-mask&sort=trending&search=spanish

nlp_es.add_pipe("contextual spellchecker",
config={
"model_name": "dccuchile/bert-base-spanish-wwm-uncased",
"max_edit_dist": 2,
},)
print(nlp_es.pipe_names)

In the following, assume that doc_es is a series where each entry is a doc object

start_time=time.time()
doc_es2=doc_es.apply(lambda x: nlp_es(x.text))
end_time=time.time()
elapsed_time = end_time - start_time
print(f"Elapsed time: {elapsed_time} seconds")

Suggestions

doc_es2_err=doc_es2[doc_es2.apply(lambda x: len(x..suggestions_spellCheck)>0)]
doc_es2_err.apply(lambda x: print(x.text,"\n",x..suggestions_spellCheck))