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
HomeDocsfeaturesmith score

CLI Reference

featuresmith score

Understanding ML Readiness Score CLI integration

Overview

There is no standalone featuresmith score CLI subcommand. Instead, the versioned, explainable ML Readiness Score is computed automatically and displayed inline as a section at the end of the standard featuresmith review report.

How it is Used

By default, running a review includes the scorecard output. To prevent calculating or rendering the score scorecard (useful for clean log outputs or minimal JSON size), call the review command with the --no-score flag.

bash
1featuresmith review train.csv --no-score

Console Scorecard Example

When computed, the CLI console renderer formats the score and displays contributing issues dynamically:

python
1ML Readiness Score (scoring v0.3.0)
2Overall: 98.1/100
3
4 Schema Health: 100/100
5 Missing Values: 85/100 (1 finding(s))
6 Feature Quality: 100/100
7 Distribution Health: 100/100
8 Leakage Risk: 100/100
9 Data Quality: 100/100
10 Consistency: 100/100
11
12Summary: Overall ML Readiness is 98.1/100 across 7 dimension(s); 6 fully healthy, 1 with findings lowering the score.
13
14What would improve this score:
15 - Address the flagged issue: High missing values in column 'age' (in column 'age').

JSON Integration

If the review is output with --format json, the score object is nested as the score field in the output payload. If --no-score is requested, the field yields null rather than 0, keeping "not scored" distinct from "scored poorly".

Related Documentation

See the SDK equivalent fs.score() and the review CLI reference featuresmith review.

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.