Skip to content

ksponspeech remove - #3013

Merged
Adel-Moumen merged 1 commit into
speechbrain:developfrom
Adel-Moumen:remove_ksponspeech
Dec 8, 2025
Merged

Adel-Moumen merged 1 commit into
speechbrain:developfrom
Adel-Moumen:remove_ksponspeech

Conversation

@Adel-Moumen

@Adel-Moumen Adel-Moumen commented Dec 7, 2025 •

Copy link
Copy Markdown
Collaborator

What does this PR do?

We've had many issues regarding ksponspeech. Furthermore, the dataset is not accessible for non-korean citizens making it almost impossible to maintain actively. Given the discussion (#2748 (comment)), I propose to remove the recipe as well as the HF models. Once merged, I will close the related 4 ongoing issues.

Before submitting
  • Did you read the contributor guideline?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Does your code adhere to project-specific code style and conventions?

PR review

Reviewer checklist
  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified
  • Confirm that the changes adhere to compatibility requirements (e.g., Python version, platform)
  • Review the self-review checklist to ensure the code is ready for review

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR removes the KsponSpeech recipe and all associated files from the SpeechBrain repository. The removal is motivated by accessibility issues - the dataset is not available to non-Korean citizens, making it nearly impossible to maintain actively. This cleanup will help streamline the codebase by removing unmaintainable recipes.

Key Changes

  • Complete removal of the KsponSpeech recipe directory including ASR, LM, and Tokenizer subdirectories
  • Removal of test configuration for KsponSpeech
  • Updates to main documentation files (README.md and PERFORMANCE.md) to remove KsponSpeech references

Reviewed changes

Copilot reviewed 19 out of 19 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tests/recipes/KsponSpeech.csv Removes test configuration entries for KsponSpeech ASR, LM, and Tokenizer tasks
recipes/KsponSpeech/unzip_ksponspeech.sh Removes utility script for extracting KsponSpeech dataset
recipes/KsponSpeech/ksponspeech_prepare.py Removes data preparation script with normalization and CSV generation logic
recipes/KsponSpeech/convert_to_wav.py Removes utility for converting PCM files to WAV format
recipes/KsponSpeech/Tokenizer/train.py Removes tokenizer training script
recipes/KsponSpeech/Tokenizer/ksponspeech_prepare.py Removes symlink to parent preparation script
recipes/KsponSpeech/Tokenizer/hparams/5K_unigram_subword_bpe.yaml Removes tokenizer hyperparameter configuration
recipes/KsponSpeech/Tokenizer/README.md Removes tokenizer documentation
recipes/KsponSpeech/README.md Removes main KsponSpeech recipe documentation
recipes/KsponSpeech/LM/train.py Removes language model training script
recipes/KsponSpeech/LM/ksponspeech_prepare.py Removes symlink to parent preparation script
recipes/KsponSpeech/LM/hparams/transformer.yaml Removes LM hyperparameter configuration
recipes/KsponSpeech/LM/README.md Removes LM documentation
recipes/KsponSpeech/ASR/transformer/train.py Removes ASR training script with Conformer/Transformer implementation
recipes/KsponSpeech/ASR/transformer/ksponspeech_prepare.py Removes symlink to parent preparation script
recipes/KsponSpeech/ASR/transformer/hparams/conformer_medium.yaml Removes ASR hyperparameter configuration
recipes/KsponSpeech/ASR/transformer/README.md Removes ASR documentation
README.md Removes KsponSpeech from the list of supported Speech Recognition datasets
PERFORMANCE.md Removes KsponSpeech ASR performance metrics section

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@Adel-Moumen Adel-Moumen added this to the v1.1.0 milestone Dec 8, 2025

@pplantinga pplantinga left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

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.

3 participants