Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated preprocess_text.py to fix NeMo-text-processing :: WARNING :: Your input is too long and could take a long time to normalize. Use split_text_into_sentences() to make the input shorter and then call normalize_list(). #11780

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Adesoji1
Copy link

@Adesoji1 Adesoji1 commented Jan 7, 2025

What does this PR do ?

Add a one line overview of what this PR aims to accomplish.

Collection: [Note which collection this PR will affect]

Changelog

  • Add specific line by line info of high level changes in this PR.

Usage

  • You can potentially add a usage example below
# Add a code snippet demonstrating how to use this 

GitHub Actions CI

The Jenkins CI system has been replaced by GitHub Actions self-hosted runners.

The GitHub Actions CI will run automatically when the "Run CICD" label is added to the PR.
To re-run CI remove and add the label again.
To run CI on an untrusted fork, a NeMo user with write access must first click "Approve and run".

Before your PR is "Ready for review"

Pre checks:

  • Make sure you read and followed Contributor guidelines
  • Did you write any new necessary tests?
  • Did you add or update any necessary documentation?
  • Does the PR affect components that are optional to install? (Ex: Numba, Pynini, Apex etc)
    • Reviewer: Does the PR have correct import guards for all optional libraries?

PR Type:

  • New Feature
  • Bugfix
  • Documentation

If you haven't finished some of the above items you can still open "Draft" PR.

Who can review?

Anyone in the community is free to review the PR once the checks have passed.
Contributor guidelines contains specific people who can review PRs to various areas.

Additional Information

  • Related to # (issue)

Adesoji1 and others added 3 commits January 7, 2025 11:51
Fix for this warning:  NeMo-text-processing :: INFO     :: Creating ClassifyFst grammars.
0%|                                                                                                                                                                   | 0/8 [00:00<?, ?it/s] NeMo-text-processing :: WARNING  :: Your input is too long and could take a long time to normalize. Use split_text_into_sentences() to make the input shorter and then call normalize_list().
NeMo-text-processing :: WARNING  :: Your input is too long and could take a long time to normalize. Use split_text_into_sentences() to make the input shorter and then call normalize_list().
NeMo-text-processing :: WARNING  :: Your input is too long and could take a long time to normalize. Use split_text_into_sentences() to make the input shorter and then call normalize_list().
NeMo-text-processing :: WARNING  :: Your input is too long and could take a long time to normalize. Use split_text_into_sentences() to make the input shorter and then call normalize_list().   Solution is seen below in Explanation of changes.

Explanation of Changes:

1. Splitting Long Sentences:

After initially splitting the text into sentences, the script iterates through each sentence to check if it exceeds 500 words. If it does, the sentence is further split into smaller chunks of 500 words each.

2. Logging for Debugging:

The script logs a warning if any sentence still exceeds 500 words after the splitting process. This helps in identifying if the splitting logic needs further refinement.

3. Normalization:

Each split sentence is normalized individually. After normalization, the sentences are concatenated back into a single string.

Signed-off-by: Adesoji Alu <[email protected]>
Fix for this warning: NeMo-text-processing :: INFO :: Creating ClassifyFst grammars.
0%| | 0/8 [00:00<?, ?it/s] NeMo-text-processing :: WARNING :: Your input is too long and could take a long time to normalize. Use split_text_into_sentences() to make the input shorter and then call normalize_list().
NeMo-text-processing :: WARNING :: Your input is too long and could take a long time to normalize. Use split_text_into_sentences() to make the input shorter and then call normalize_list().
NeMo-text-processing :: WARNING :: Your input is too long and could take a long time to normalize. Use split_text_into_sentences() to make the input shorter and then call normalize_list().
NeMo-text-processing :: WARNING :: Your input is too long and could take a long time to normalize. Use split_text_into_sentences() to make the input shorter and then call normalize_list(). Solution is seen below in Explanation of changes.

Explanation of Changes:

    Splitting Long Sentences:

After initially splitting the text into sentences, the script iterates through each sentence to check if it exceeds 500 words. If it does, the sentence is further split into smaller chunks of 500 words each.

    Logging for Debugging:

The script logs a warning if any sentence still exceeds 500 words after the splitting process. This helps in identifying if the splitting logic needs further refinement.

    Normalization:

Each split sentence is normalized individually. After normalization, the sentences are concatenated back into a single string.

Signed-off-by: Adesoji Alu <[email protected]>
@github-actions github-actions bot added the TTS label Jan 7, 2025
Copy link
Contributor

github-actions bot commented Jan 7, 2025

beep boop 🤖: 🙏 The following files have warnings. In case you are familiar with these, please try helping us to improve the code base.


Your code was analyzed with PyLint. The following annotations have been identified:

************* Module preprocess_text
scripts/dataset_processing/tts/preprocess_text.py:49:0: C0116: Missing function or method docstring (missing-function-docstring)
scripts/dataset_processing/tts/preprocess_text.py:161:0: C0116: Missing function or method docstring (missing-function-docstring)

-----------------------------------
Your code has been rated at 9.75/10

Mitigation guide:

  • Add sensible and useful docstrings to functions and methods
  • For trivial methods like getter/setters, consider adding # pylint: disable=C0116 inside the function itself
  • To disable multiple functions/methods at once, put a # pylint: disable=C0116 before the first and a # pylint: enable=C0116 after the last.

By applying these rules, we reduce the occurance of this message in future.

Thank you for improving NeMo's documentation!

@Adesoji1
Copy link
Author

Adesoji1 commented Jan 9, 2025

@cuichenx

@cuichenx
Copy link
Collaborator

cuichenx commented Jan 9, 2025

@cuichenx

I don't work on the TTS collection. @titu1994 could you reassign?

@Adesoji1
Copy link
Author

Adesoji1 commented Jan 9, 2025

@cuichenx

I don't work on the TTS collection. @titu1994 could you reassign?

Sure i will, @XuesongYang @titu1994 kindly view my PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants