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
HomeDocsfs.profile()

Python SDK

fs.profile()

SDK Reference: statistical profiling

python
1def profile(
2 source: object,
3 *,
4 max_correlation_columns: int = 100,
5 max_frequency_table_size: int = 1000
6) -> ProfileResult:

Profile a Dataset or tabular source directly, executing vectorized summaries and returning a strongly-typed, serializable ProfileResult.

Arguments

  • source: Dataset | str | DataFrame. Pre-loaded Dataset or file/data source.
  • max_correlation_columns: int (default 100). Column cap for Pearson correlation computations.
  • max_frequency_table_size: int (default 1000). Maximum unique categories to track in frequency table summaries.

Example

python
1import featuresmith as fs
2
3profile = fs.profile("customers.csv", max_correlation_columns=50)
4
5# Inspect column summaries
6print(profile.column_profiles["age"].missing_count)
7print(profile.dataset_summary.row_count)

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.