featuresmith
  • Docs
  • SDK
  • CLI
  • Examples
  • Roadmap
v0.1.0
Documentation

Getting Started

  • Introduction
  • Installation
  • Quick Start
  • Benchmarks
  • Development Setup
  • Contributing

Core Concepts

  • Architecture Overview
  • Dataset Layer
  • Connectors
  • Profiling Engine
  • Rule Engine

Python SDK

  • load()
  • profile()
  • analyze()
  • Data Models
  • Exceptions
  • Plugins

CLI Reference

  • analyze
  • Configuration

Guides

  • CI/CD Integration
  • Custom Rules
  • Writing Plugins

Resources

  • Release Notes
  • FAQ
  • Troubleshooting
DocsGuide

Getting Started

  • Introduction
  • Installation
  • Quick Start
  • Benchmarks
  • Development Setup
  • Contributing

Core Concepts

  • Architecture Overview
  • Dataset Layer
  • Connectors
  • Profiling Engine
  • Rule Engine

Python SDK

  • load()
  • profile()
  • analyze()
  • Data Models
  • Exceptions
  • Plugins

CLI Reference

  • analyze
  • Configuration

Guides

  • CI/CD Integration
  • Custom Rules
  • Writing Plugins

Resources

  • Release Notes
  • FAQ
  • Troubleshooting
HomeDocsRule Engine

Core Concepts

Rule Engine

Deterministic quality and target leakage audits

Featuresmith separates profiling from auditing. The **Rule Engine** consumes a precomputed ProfileResult and evaluates a suite of deterministic, configurable rules. This allows rapid rules execution without re-scanning raw data.

Implemented Seed Rules

Rule IDCategorySeverityDescription
quality.missing_value_thresholdqualitywarningColumns with > 20% missing values (configurable).
quality.duplicate_rowsqualitywarningDatasets with > 10% duplicate rows (configurable).
quality.constant_columnsqualitywarningColumns with exactly one unique non-null value.
quality.fully_empty_columnsqualitycriticalColumns containing 100% null values.
statistical.high_cardinalitystatisticalwarningCategorical columns with > 50% unique ratio.
statistical.outliersstatisticalwarningNumeric outliers detected via the IQR method (factor=1.5).
statistical.high_correlationstatisticalwarningNumeric pairs with Pearson correlation ≥ 0.90.
leakage.potential_leakageleakagecriticalFeatures with Pearson correlation ≥ 0.99 to target.

Rule Exception Isolation

A crash in a custom rule or internal rule evaluation must not block the rest of the profiling pipeline. Featuresmith handles exceptions internally per rule, listing rule failure stack traces in the final RuleResult.failed_rules mapping without terminating the run.

Explore

  • Quick Start
  • Python SDK
  • CLI Reference
  • Examples
featuresmith

Open-source data profiling and validation for Python engineers.

Documentation

  • Introduction
  • Quick Start
  • Python SDK
  • CLI Reference

Community

  • GitHub
  • Discussions
  • Issues
  • Contributing

Project

  • Roadmap
  • Release status
  • Benchmarks
  • Changelog
  • Examples

Legal

  • Apache 2.0 License
  • Code of Conduct
  • Security

© 2026 Featuresmith Contributors. Released under the Apache 2.0 License.

Built in the open — contributions welcome.