Skip to content

Guides

Guides are the task-oriented part of the Truthound Core docs. Use them when you already know the job to be done and want implementation guidance, operational patterns, and troubleshooting for the main truthound repository.

If your task is primarily about scheduler-native execution or workflow-host integration, jump to Truthound Orchestration. If your task is primarily about reviewable AI proposals or run analysis, jump to Truthound AI. If your task is primarily about sessions, ownership, incidents, secrets, or artifact operations in a web UI, jump to Truthound Dashboard.

Looking for CLI documentation? See CLI Reference.

Looking for Python API lookup? See Python API Reference.

What Belongs Here

If you need to... Use these guides
validate data and design suites Validators
connect files, SQL systems, or warehouses Datasources
automate runs and policies inside the core repo Checkpoint family and Checkpoints overview
render output or persist artifacts Reporters, Data Docs, Stores
profile data and generate rules Profiler
tune execution and benchmark behavior Performance, Benchmark Methodology, Benchmark Workloads

What Does Not Belong Here

Common Core Entry Points

import truthound as th
from truthound.drift import compare

# Basic validation through the core kernel
run = th.check("data.csv")
print(f"Found {len(run.issues)} issues")

# Explicit validators when you need them
run = th.check("data.csv", validators=["null", "duplicate", "range"])

# Learn a baseline schema from trusted data
schema = th.learn("baseline.csv")

# Compare two datasets for drift
drift = compare("baseline.csv", "current.csv", method="auto")

Guide Families

Validation and Data Access

Automation and Operations Inside Core

Reporting, Artifacts, and Persistence

Profiling and Extended Core Workflows

Suggested Reading Paths

New adopter path

  1. Validators
  2. Datasources
  3. Reporters
  4. Checkpoints Overview

Platform team path

  1. Configuration
  2. Checkpoint Family
  3. Stores
  4. Performance

Extended workflow path

  1. Profiler
  2. Data Docs
  3. Great Expectations Comparison
  4. Truthound AI if the next step is human-reviewed proposals or run analysis
  5. Truthound Orchestration if the next step is scheduler-native rollout