Adding Common Voice Preprocessing for Farsi #1997

msghik · 2025-08-02T08:31:30Z

This pull request introduces a new normalization rule for Persian text in the normalize_text function and adds a comment in the prepare.sh script regarding the release file handling. Below is a breakdown of the most important changes:

Text Normalization Enhancements:

egs/commonvoice/ASR/local/preprocess_commonvoice.py: Added a new normalization rule for Persian (fa) text. This includes replacing Arabic characters with their Persian equivalents, removing unwanted characters, collapsing multiple spaces into one, and stripping leading/trailing spaces.

Script Comments Update:

egs/commonvoice/ASR/prepare.sh: Added a comment suggesting either changing the release name or manually downloading and moving the file to the download folder for better clarity and handling.

Summary by CodeRabbit

New Features
- Improved Persian text normalization by handling specific character replacements and cleaning for Persian language data.
Documentation
- Added a comment to clarify options for handling the release file in the setup script.

coderabbitai · 2025-08-02T08:31:48Z

Walkthrough

A new Persian-specific text normalization branch was added to the normalize_text function in the Common Voice ASR preprocessing script, handling unique Persian character replacements and filtering. Additionally, a clarifying comment was appended to the release variable definition in the dataset preparation shell script. No changes were made to function signatures or control flow.

Changes

Cohort / File(s)	Change Summary
Persian Text Normalization `egs/commonvoice/ASR/local/preprocess_commonvoice.py`	Added a new branch in `normalize_text` for Persian ("fa") that performs character replacements and regex filtering for Persian script, numerals, and whitespace.
Preparation Script Comment `egs/commonvoice/ASR/prepare.sh`	Appended a comment to the `release` variable definition, advising on changing the release name or manual download.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Poem

A hop and a skip in the Persian script,
With yehs and kafs now neatly equipped.
A comment appears, a gentle nudge—
For download paths, don’t let them budge!
In fields of code, these tweaks delight,
As rabbits review by the soft moonlight.
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

egs/commonvoice/ASR/prepare.sh (1)
45-45: Fix typo in comment and improve clarity.

The comment contains a typo and could be more specific about when manual intervention is needed.
-release=cv-corpus-12.0-2022-12-07 ## -> consider changing relaese name or download the file manually and move it to download folder.
+release=cv-corpus-12.0-2022-12-07 ## -> consider changing release name or download the file manually and move it to download folder.
Consider making the comment more specific about the circumstances requiring manual intervention:
-release=cv-corpus-12.0-2022-12-07 ## -> consider changing relaese name or download the file manually and move it to download folder.
+release=cv-corpus-12.0-2022-12-07 ## -> update release name as needed, or download manually if automatic download fails

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 34fc1fd and c053b7c.

📒 Files selected for processing (2)

egs/commonvoice/ASR/local/preprocess_commonvoice.py (1 hunks)
egs/commonvoice/ASR/prepare.sh (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (60)

GitHub Check: py3.10 torch2.7.0 v20250630
GitHub Check: py3.10 torch2.1.1 v20250630
GitHub Check: py3.10 torch2.0.0 v20250630
GitHub Check: py3.10 torch1.13.1 v20250630
GitHub Check: py3.10 torch2.7.1 v20250630
GitHub Check: py3.10 torch2.6.0 v20250630
GitHub Check: py3.10 torch2.7.0 v20250630
GitHub Check: py3.10 torch2.1.1 v20250630
GitHub Check: py3.10 torch2.0.0 v20250630
GitHub Check: py3.10 torch1.13.1 v20250630
GitHub Check: py3.10 torch2.7.1 v20250630
GitHub Check: py3.10 torch2.6.0 v20250630
GitHub Check: py3.10 torch2.7.0 v20250630
GitHub Check: py3.10 torch2.1.1 v20250630
GitHub Check: py3.10 torch2.0.0 v20250630
GitHub Check: py3.10 torch1.13.1 v20250630
GitHub Check: py3.10 torch2.7.1 v20250630
GitHub Check: py3.10 torch2.6.0 v20250630
GitHub Check: py3.10 torch2.7.0 v20250630
GitHub Check: py3.10 torch2.1.1 v20250630
GitHub Check: py3.10 torch2.0.0 v20250630
GitHub Check: py3.10 torch1.13.1 v20250630
GitHub Check: py3.10 torch2.7.1 v20250630
GitHub Check: py3.10 torch2.6.0 v20250630
GitHub Check: py3.10 torch2.7.0 v20250630
GitHub Check: py3.10 torch2.1.1 v20250630
GitHub Check: py3.10 torch2.0.0 v20250630
GitHub Check: py3.10 torch1.13.1 v20250630
GitHub Check: py3.10 torch2.7.1 v20250630
GitHub Check: py3.10 torch2.6.0 v20250630
GitHub Check: py3.10 torch2.7.0 v20250630
GitHub Check: py3.10 torch2.1.1 v20250630
GitHub Check: py3.10 torch2.0.0 v20250630
GitHub Check: py3.10 torch1.13.1 v20250630
GitHub Check: py3.10 torch2.7.1 v20250630
GitHub Check: py3.10 torch2.6.0 v20250630
GitHub Check: py3.10 torch2.7.0 v20250630
GitHub Check: py3.10 torch2.1.1 v20250630
GitHub Check: py3.10 torch2.0.0 v20250630
GitHub Check: py3.10 torch1.13.1 v20250630
GitHub Check: py3.10 torch2.7.1 v20250630
GitHub Check: py3.10 torch2.6.0 v20250630
GitHub Check: py3.10 torch2.7.0 v20250630
GitHub Check: py3.10 torch2.1.1 v20250630
GitHub Check: py3.10 torch2.0.0 v20250630
GitHub Check: py3.10 torch1.13.1 v20250630
GitHub Check: py3.10 torch2.7.1 v20250630
GitHub Check: py3.10 torch2.6.0 v20250630
GitHub Check: py3.10 torch2.7.0 v20250630
GitHub Check: py3.10 torch2.1.1 v20250630
GitHub Check: py3.10 torch2.0.0 v20250630
GitHub Check: py3.10 torch1.13.1 v20250630
GitHub Check: py3.10 torch2.7.1 v20250630
GitHub Check: py3.10 torch2.6.0 v20250630
GitHub Check: py3.10 torch2.7.0 v20250630
GitHub Check: py3.10 torch2.1.1 v20250630
GitHub Check: py3.10 torch2.0.0 v20250630
GitHub Check: py3.10 torch1.13.1 v20250630
GitHub Check: py3.10 torch2.7.1 v20250630
GitHub Check: py3.10 torch2.6.0 v20250630

🔇 Additional comments (1)

egs/commonvoice/ASR/local/preprocess_commonvoice.py (1)

55-59: LGTM! Well-implemented Persian text normalization.

The Persian text normalization logic is correctly implemented:

Character replacements (Arabic yeh/kaf → Persian yeh/kaf) are linguistically accurate

Unicode range filtering appropriately includes Arabic block (\u0600-\u06FF) and both Latin (0-9) and Persian digits (\u06F0-\u06F9)

Punctuation removal and whitespace normalization are appropriate for ASR preprocessing

Correctly omits case conversion since Persian doesn't have uppercase/lowercase distinction

adding farsi cv preprocessing

c053b7c

coderabbitai bot reviewed Aug 2, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Adding Common Voice Preprocessing for Farsi #1997

Adding Common Voice Preprocessing for Farsi #1997

Uh oh!

msghik commented Aug 2, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Aug 2, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Adding Common Voice Preprocessing for Farsi #1997

Are you sure you want to change the base?

Adding Common Voice Preprocessing for Farsi #1997

Uh oh!

Conversation

msghik commented Aug 2, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Text Normalization Enhancements:

Script Comments Update:

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Aug 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

msghik commented Aug 2, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 2, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)