CSpell

Because of a lapse in government funding, the information on this website may not be up to date, transactions submitted via the website may not be processed, and the agency may not be able to respond to inquiries until appropriations are enacted. The NIH Clinical Center (the research hospital of NIH) is open. For more details about its operating status, please visit cc.nih.gov. Updates regarding government operating status and resumption of normal operations can be found at OPM.gov

CSpell

Ensemble Source Code Analysis

The ensemble spelling correction (by Halil) is used as the baseline for this project. The reviewed status and suggesting plan for the original source code are described as follows:

	Original Java Code	Notes	Module	Status	Plan
1	SpellingPreProcessor.java	Preprocess for input text (contractions, punctuation, split digit, etc.) Decomposition: PreProcXml.java (refactoring with modifications) PreProcContractions.java (rewrite) PreProcSentence.java (redesign) PreProcSplit.java (refactoring with modifications)	PreProcessor	1st review	Rewrite or refactoring
2	DictionaryBasedSpellChecker.java	Uses jazzy for the dictionary and suggestion Planned to be replaced by a better mechanism.	Dictionary	1st review	Rewrite
3	SpellingCandidateGenerator.java	It uses exhausted mechanism (slow) to get candidates Method, getLevenshteinEdits(), is used to get all candidates from the dictionary Does not use jazzySpellChecker decomposition: EditDistance.java (refactoring) OverLapUtil.java (refactoring) MergeUtil.java (refactoring) SplitUtil.java (rewrite for better performance and bug fixed)	Candidate	1st review	Rewrite or refactoring
4	CorpusFrequencyCounts.java	Get frequency score A bug found: getUnigramScore( )	Ranking	1st review	Rewrite
5	Word2Vector.java	Used for WordEmbedding algorithm (contextual Similarity)	Ranking	No Review	TBD
6	SpellCorrectionEvaluator.java	OK code to use it as is. Suggested to rewrite for simplicity and speed. Decomposition: Span.java TokenSpan.java TokenSpanUtil.java CoreNLPWrapper.java FileUtils.java	Evaluator	1st review	Rewrite
7	diff_match_patch.java	Library codes for comparing two text Nice to use it. Plan to rewrite for simplicity, maintenance and speed	Evaluator	No review	Rewrite
8	SpellCorrection.java	Interface, might not need it	System	1st review	Remove or redesign
9	LinearWeightedEnsembleSpellCorrection.java	Add a new class for configurable setting ESpellCorrection.java (process multiple files) Decomposition: EnsembleSpellCorrectText.java (correct 1 text file) EnsembleSpellPreProcess.java EnsembleSpellPreProcessObj.java EnsembleSpellSpans.java (convert input text to spanText) EnsembleSpellProcess.java EnsembleSpellCorrectSentence.java (correct a sentence) EnsembleSpellFindCandidates.java (find candidates for a instance) EnsembleSpellCandidates.java (find candidate for a token) EnsembleSpellMergeCandidates.java (find merge candidate for a token) EnsembleSpellFindRanking.java (find best ranked candidate for a instance)	System	1st review	Rewrite
10	JazzySpellCorrection.java	Use ASpell (Jazzy) to correct text	System	No review Completed	Remove
11	ESpellCorrection.java	Use ESpell to correct text	System	No review Completed	Remove

where,

Remove: delete the code (no use)
Refactoring: compile the code to meet coding standard
Revise: modify the current code and meet coding standard
Rewrite: change the algorithm, signature, name for the individual file
Redesign: Change the architecture design, data structure, algorithm, ...

Plan Summary:

Improve from research code to production code:

Performance Maintenance Thread Safe Distributable Configurable
OO Design X X
Coding standard X X
Limited comment X
static global variable X
Algorithm (exhausted) X
Package Dependency X X X
Systematic approach for data acquisition:
- Dictionary
- Frequency
- Contextual
- lemma