Quick Start - Baselinr

1

Install Baselinr

Install the package using pip. This will download Baselinr and all required dependencies.

bash

pip install baselinr

Optional: Install with additional features: pip install baselinr[snowflake] or pip install baselinr[all]

2

Create Configuration File

Create a config.yml file with your database connection and profiling targets.

yaml

environment: development

source:
  type: postgres
  host: localhost
  port: 5432
  database: mydb
  username: user
  password: password
  schema: public

storage:
  connection:
    type: postgres
    host: localhost
    port: 5432
    database: mydb
    username: user
    password: password
  results_table: baselinr_results
  runs_table: baselinr_runs
  create_tables: true

profiling:
  tables:
    - table: customers
      sample_ratio: 1.0
    - table: orders
      sample_ratio: 1.0
  
  default_sample_ratio: 1.0
  compute_histograms: true
  histogram_bins: 10

See full example configurations for other database types.

3

Start Profiling

Preview, profile, and detect drift with simple commands:

bash

# Preview what will be profiled
baselinr plan --config config.yml

bash

# Run profiling
baselinr profile --config config.yml

bash

# Detect drift (after multiple runs)
baselinr drift --config config.yml --dataset customers

Get Started in Minutes

✓ Requirements

What's Next?

Full Documentation

Explore Features

View on GitHub

Need Help?