Featuresmith Icon
Featuresmith
  • Docs
  • SDK
  • CLI
  • Examples
  • Roadmap
v0.4.0
Documentation

Getting Started

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

Core Concepts

  • Architecture Overview
  • Dataset Layer
  • Connectors
  • Profiling Engine
  • Rule Engine
  • Dataset Review Engine
  • ML Readiness Score
  • Target Leakage Detection
  • Dataset Diff Engine
  • Target Column Concept
  • Mental Model & Workflow
  • Interpreting Findings
  • Workflow Cheat Sheet
  • Beginner Glossary

Python SDK

  • load()
  • profile()
  • analyze()
  • review()
  • diff()
  • score()
  • plan()
  • Dataset
  • Data Models
  • Profile Models
  • Rule & Finding Models
  • Review Models
  • Score Models
  • Leakage Models
  • Diff Models
  • Exceptions
  • Plugins

CLI Reference

  • analyze
  • review
  • diff
  • score
  • plan
  • Configuration

Guides

  • CI/CD Integration
  • Custom Rules
  • Writing Plugins

Resources

  • Release Notes
  • FAQ
  • Troubleshooting
DocsGuide

Getting Started

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

Core Concepts

  • Architecture Overview
  • Dataset Layer
  • Connectors
  • Profiling Engine
  • Rule Engine
  • Dataset Review Engine
  • ML Readiness Score
  • Target Leakage Detection
  • Dataset Diff Engine
  • Target Column Concept
  • Mental Model & Workflow
  • Interpreting Findings
  • Workflow Cheat Sheet
  • Beginner Glossary

Python SDK

  • load()
  • profile()
  • analyze()
  • review()
  • diff()
  • score()
  • plan()
  • Dataset
  • Data Models
  • Profile Models
  • Rule & Finding Models
  • Review Models
  • Score Models
  • Leakage Models
  • Diff Models
  • Exceptions
  • Plugins

CLI Reference

  • analyze
  • review
  • diff
  • score
  • plan
  • Configuration

Guides

  • CI/CD Integration
  • Custom Rules
  • Writing Plugins

Resources

  • Release Notes
  • FAQ
  • Troubleshooting
HomeDocsML Readiness Score

Core Concepts

ML Readiness Score

Explainable 0–100 quality scorecard for tabular data

The ML Readiness Score answers a fundamental question: "Is this dataset ready for model training?" It translates complex statistical profiles and finding lists into a single, explainable 0–100 score supported by 7 effective weighted health dimensions.

The 7 Scoring Dimensions

  • 1. Schema Health: Evaluates structural validity and column naming.
  • 2. Missing Values: Evaluates column null ratios and missingness spikes.
  • 3. Feature Quality: Flags near-constant, redundant, and low-signal columns.
  • 4. Distribution Health: Analyzes distribution skewness and kurtosis anomalies.
  • 5. Leakage Risk: Evaluates target correlation, timestamp, and identifier leakage risk.
  • 6. Data Quality: Consolidated dimension covering duplicate rows and constant columns.
  • 7. Consistency: Consolidated dimension covering data types and high cardinality.

A registered Class Balance dimension exists but is never applicable until its minority-class detector ships, so it is omitted from the aggregate rather than silently counted as a perfect or zero score.

Scoring & Deduction Math

Each dimension starts at a perfect score of 100. Findings deduct points based on severity:

  • CRITICAL finding: -30.0 points
  • WARNING finding: -15.0 points
  • INFO finding: -5.0 points

All applicable dimensions carry equal default weight (1.0). The overall score is the weighted arithmetic mean of applicable dimension scores. Inapplicable dimensions are automatically omitted and weights renormalize so missing dimensions never silently penalize the score.

Important Caveat

A score of 100.0 / 100 indicates that no statistical quality or target leakage issues were detected by Featuresmith's rules. However, it does not guarantee that a model will achieve high predictive accuracy — domain assumptions, feature engineering choices, and business logic still require human data science expertise.

Explore

  • Quick Start
  • Python SDK
  • CLI Reference
  • Examples
Featuresmith Icon
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 by Aditya Gangwani in the open.