Heuristic Filtering | NeMo Curator

Heuristic filtering uses simple, rule-based metrics to identify and filter out low-quality documents from your dataset. NVIDIA NeMo Curator provides a variety of pre-built heuristic filters that can be configured and combined to meet your specific needs.

How It Works

Heuristic filters examine specific attributes of text documents and apply predefined thresholds to determine document quality. Unlike classifier-based filtering, heuristic filters don’t require training data but rely on configurable thresholds and rules.

These filters assess quality using measurable document characteristics such as:

Document length (word or character count)
Punctuation ratios and patterns
Repetitive content detection
Language-specific patterns
Text completeness and coherence

For details on filter structure and the filtering process, refer to Data Processing Concepts .

Usage

Python

Configuration

1 from nemo_curator.pipeline import Pipeline
2 from nemo_curator.stages.text.io.reader import JsonlReader
3 from nemo_curator.stages.text.io.writer import JsonlWriter
4 from nemo_curator.stages.text.modules import ScoreFilter
5 from nemo_curator.stages.text.filters import (
6     WordCountFilter,
7     RepeatingTopNGramsFilter,
8     PunctuationFilter
9 )
10 
11 # Create pipeline
12 pipeline = Pipeline(name="heuristic_filtering")
13 
14 # Load your dataset
15 reader = JsonlReader(
16     file_paths="input_data/",
17     fields=["text", "id"]
18 )
19 pipeline.add_stage(reader)
20 
21 # Add filter stages
22 pipeline.add_stage(ScoreFilter(
23     filter_obj=WordCountFilter(min_words=80),
24     text_field="text",
25     score_field="word_count"
26 ))
27 pipeline.add_stage(ScoreFilter(
28     filter_obj=PunctuationFilter(max_num_sentences_without_endmark_ratio=0.85),
29     text_field="text"
30 ))
31 pipeline.add_stage(ScoreFilter(
32     filter_obj=RepeatingTopNGramsFilter(n=2, max_repeating_ngram_ratio=0.2),
33     text_field="text"
34 ))
35 pipeline.add_stage(ScoreFilter(
36     filter_obj=RepeatingTopNGramsFilter(n=3, max_repeating_ngram_ratio=0.18),
37     text_field="text"
38 ))
39 pipeline.add_stage(ScoreFilter(
40     filter_obj=RepeatingTopNGramsFilter(n=4, max_repeating_ngram_ratio=0.16),
41     text_field="text"
42 ))
43 
44 # Add output stage
45 writer = JsonlWriter(path="high_quality_output/")
46 pipeline.add_stage(writer)
47 
48 # Execute pipeline
49 results = pipeline.run()

Available Filters

NeMo Curator includes more than 30 heuristic filters for assessing document quality. Below are the most commonly used filters with their parameters:

Text Length Filters

Filter	Description	Key Parameters	Default Values
WordCountFilter	Filters by word count	`min_words`, `max_words`	min=50, max=100000
TokenCountFilter	Filters by token count	`min_tokens`, `max_tokens`	min=0, max=∞
MeanWordLengthFilter	Filters by average word length	`min_mean_word_length`, `max_mean_word_length`	min=3, max=10
LongWordFilter	Filters by presence of extremely long words	`max_word_length`	1000

Repetition Detection Filters

Filter	Description	Key Parameters	Default Values
RepeatedLinesFilter	Detects repeated lines	`max_repeated_line_fraction`	0.7
RepeatedParagraphsFilter	Detects repeated paragraphs	`max_repeated_paragraphs_ratio`	0.7
RepeatedLinesByCharFilter	Detects repeated lines by character count	`max_repeated_lines_char_ratio`	0.8
RepeatedParagraphsByCharFilter	Detects repeated paragraphs by character count	`max_repeated_paragraphs_char_ratio`	0.8
RepeatingTopNGramsFilter	Detects excessive repetition of n-grams	`n`, `max_repeating_ngram_ratio`	n=2, ratio=0.2
RepeatingDuplicateNGramsFilter	Detects duplicate n-grams	`n`, `max_repeating_duplicate_ngram_ratio`	n=2, ratio=0.2

Character and Symbol Filters

Filter	Description	Key Parameters	Default Values
NonAlphaNumericFilter	Limits non-alphanumeric content	`max_non_alpha_numeric_to_text_ratio`	0.25
SymbolsToWordsFilter	Limits symbols in text	`max_symbol_to_word_ratio`	0.1
NumbersFilter	Limits numeric content	`max_number_to_text_ratio`	0.15
UrlsFilter	Limits URL content	`max_url_to_text_ratio`	0.2
PunctuationFilter	Limits sentences without proper punctuation	`max_num_sentences_without_endmark_ratio`	0.85
WhiteSpaceFilter	Limits excessive whitespace	`max_white_space_ratio`	0.25

Content-specific Filters

Filter	Description	Key Parameters	Default Values
CommonEnglishWordsFilter	Ensures text contains common words	`min_num_common_words`	2
WordsWithoutAlphabetsFilter	Limits words without alphabetic chars	`min_words_with_alphabets`	0.8
BulletsFilter	Limits bullet-point heavy content	`max_bullet_lines_ratio`	0.9
BoilerPlateStringFilter	Detects boilerplate text	`max_boilerplate_string_ratio`, `remove_if_at_top_or_bottom`	0.4, True
ParenthesesFilter	Limits parentheses content	`max_parentheses_ratio`	0.1

Special Purpose Filters

Filter	Description	Key Parameters	Default Values
PornographicUrlsFilter	Detects URLs containing “porn” substring	None	N/A
EllipsisFilter	Limits excessive ellipses	`max_num_lines_ending_with_ellipsis_ratio`	0.3
HistogramFilter	Filters based on character distribution	`threshold`	0.8
SubstringFilter	Filters based on presence of specific substring in a position	`substring`, `position`	N/A (required)

Configuration

NeMo Curator pipelines can be configured using YAML files with Hydra. The configuration uses _target_ to specify class paths:

Hydra Configuration

1 # Hydra-based pipeline configuration
2 input_path: /path/to/input
3 output_path: /path/to/output
4 text_field: text
5 
6 stages:
7   - _target_: nemo_curator.stages.text.io.reader.JsonlReader
8     file_paths: ${input_path}
9     fields: null
10 
11   - _target_: nemo_curator.stages.text.modules.score_filter.ScoreFilter
12     filter_obj:
13       _target_: nemo_curator.stages.text.filters.heuristic_filter.WordCountFilter
14       min_words: 50
15       max_words: 100000
16     text_field: ${text_field}
17     score_field: word_count
18 
19   - _target_: nemo_curator.stages.text.modules.score_filter.ScoreFilter
20     filter_obj:
21       _target_: nemo_curator.stages.text.filters.heuristic_filter.PunctuationFilter
22       max_num_sentences_without_endmark_ratio: 0.85
23     text_field: ${text_field}
24     score_field: null
25 
26   - _target_: nemo_curator.stages.text.io.writer.JsonlWriter
27     path: ${output_path}

See nemo_curator/config/text/ for complete pipeline examples.

For non-English texts, you may need to adjust the filter parameters based on the specific characteristics of your target language.

Best Practices

When building filter chains, follow these best practices:

Order for Efficiency

Performance Tuning

Precision vs. Recall

Language Considerations

Multiple Filters

1 # Efficient ordering - place fast filters first
2 from nemo_curator.pipeline import Pipeline
3 from nemo_curator.stages.text.modules import ScoreFilter
4 from nemo_curator.stages.text.filters import WordCountFilter, UrlsFilter, RepeatingTopNGramsFilter
5 
6 pipeline = Pipeline(name="efficient_filtering")
7 # Fast filters first
8 pipeline.add_stage(ScoreFilter(filter_obj=WordCountFilter(min_words=50), text_field="text"))
9 # Medium complexity filters
10 pipeline.add_stage(ScoreFilter(filter_obj=UrlsFilter(), text_field="text"))
11 # Slow filters last
12 pipeline.add_stage(ScoreFilter(filter_obj=RepeatingTopNGramsFilter(), text_field="text"))

Analyzing Filter Results

When tuning filter thresholds, analyze score distributions before applying filters. NeMo Curator provides two modules for this workflow:

Score: Computes scores and adds them as columns without removing documents
ScoreFilter: Computes scores, filters based on thresholds, and optionally retains scores in output

Use Score first to understand your data distribution, then apply ScoreFilter with tuned thresholds.

Score Without Filtering

Analyze Score Distribution

Apply Tuned Filters

Use Score to add score columns to your data without removing any documents:

1 from nemo_curator.pipeline import Pipeline
2 from nemo_curator.stages.text.io.reader import JsonlReader
3 from nemo_curator.stages.text.io.writer import JsonlWriter
4 from nemo_curator.stages.text.modules import Score
5 from nemo_curator.stages.text.filters import WordCountFilter, RepeatingTopNGramsFilter
6 
7 # Create scoring pipeline (no filtering)
8 pipeline = Pipeline(name="score_analysis")
9 
10 # Load data
11 pipeline.add_stage(JsonlReader(file_paths="input_data/", fields=["text", "id"]))
12 
13 # Add scores without filtering
14 pipeline.add_stage(Score(
15     score_fn=WordCountFilter(min_words=80),
16     text_field="text",
17     score_field="word_count"
18 ))
19 pipeline.add_stage(Score(
20     score_fn=RepeatingTopNGramsFilter(n=3, max_repeating_ngram_ratio=0.18),
21     text_field="text",
22     score_field="ngram_ratio"
23 ))
24 
25 # Write scored data (all documents preserved)
26 pipeline.add_stage(JsonlWriter(path="scored_output/"))
27 
28 pipeline.run()

Output files are written to the scored_output/ directory with one file per input partition.

Performance Tuning

For large datasets, consider these performance optimizations:

XennaExecutor (Default)

RayDataExecutor (Experimental)

Batch Size Optimization

XennaExecutor is the default executor, optimized for streaming workloads. You can customize its configuration or use the defaults:

1 from nemo_curator.backends.xenna import XennaExecutor
2 
3 # Custom configuration for streaming processing
4 executor = XennaExecutor(config={
5     "execution_mode": "streaming",
6     "cpu_allocation_percentage": 0.95,
7     "logging_interval": 60
8 })
9 results = pipeline.run(executor)

If no executor is specified, pipeline.run() uses XennaExecutor with default settings.

Remember that the goal of filtering is to improve the quality of your training data, not necessarily to remove as many documents as possible. Monitor your filtering results and adjust thresholds based on your specific data characteristics and downstream tasks.