Skip to content

Design-doc#1

Open
khadijja1 wants to merge 2 commits into
mainfrom
khadija-design-doc
Open

Design-doc#1
khadijja1 wants to merge 2 commits into
mainfrom
khadija-design-doc

Conversation

@khadijja1

@khadijja1 khadijja1 commented Jul 24, 2026

Copy link
Copy Markdown
Collaborator

What does this PR do?

This PR adds the Design doc with these sections: project summary , problem statement , evaluation plan , module ownership table , known risks(2 known risks) , Defination of done, Public API design sections filled in.

Which module(s) does it touch?

Docs/Design doc

How did you test it?

Manual review

Edge cases handled:

N/A

Checklist:

  • Tests added or updated
  • Docstrings on all new public functions
  • No unused imports
  • README updated if public API changed
  • Lead Engineer has reviewed and approved before submitting to director

…ownership table , known risks(2 known risks) , Defination of done, Public API design sections in design doc
@khadijja1
khadijja1 requested a review from Khubaib8281 July 24, 2026 22:32
@khadijja1 khadijja1 changed the title Degine-doc Design-doc Jul 24, 2026
Expanded the technical approach section with detailed methods, results, and recommendations for near-duplicate detection and language contamination detection. Updated evaluation plan and addressed package name conflict and team size reduction issues.
@Shoaib-Altaf

Copy link
Copy Markdown
Collaborator

Added my Technical Feasibility section (near-duplicate threshold analysis on 20 real RUEmoCorp pairs, langdetect reliability testing on 12 real samples, and scoring formulas for all 5 checks). Also added a third Known Risk based on what I found — langdetect can't reliably detect Roman Urdu at any text length tested (0% correct across 44 detections), which affects check_language_contamination design. Included a proposed mitigation in the risk entry.

Reviewed the Problem Statement — looks solid and concrete. Ready for your review on the
new sections whenever you get a chance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants