LogoLogo
GitHubSlackDataCebo
  • SDMetrics
  • Getting Started
    • Installation
    • Quickstart
    • Metadata
      • Single Table Metadata
      • Multi Table Metadata
      • Sequential Metadata
  • Reports
    • Quality Report
      • What's included?
      • Single Table API
      • Multi Table API
    • Diagnostic Report
      • What's included?
      • Single Table API
      • Multi Table API
    • Other Reports
    • Visualization Utilities
  • Metrics
    • Diagnostic Metrics
      • BoundaryAdherence
      • CardinalityBoundaryAdherence
      • CategoryAdherence
      • KeyUniqueness
      • ReferentialIntegrity
      • TableStructure
    • Quality Metrics
      • CardinalityShapeSimilarity
      • CategoryCoverage
      • ContingencySimilarity
      • CorrelationSimilarity
      • KSComplement
      • MissingValueSimilarity
      • RangeCoverage
      • SequenceLengthSimilarity
      • StatisticMSAS
      • StatisticSimilarity
      • TVComplement
    • Privacy Metrics
      • DCRBaselineProtection
      • DCROverfittingProtection
      • DisclosureProtection
      • DisclosureProtectionEstimate
      • CategoricalCAP
    • ML Augmentation Metrics
      • BinaryClassifierPrecisionEfficacy
      • BinaryClassifierRecallEfficacy
    • Metrics in Beta
      • CSTest
      • Data Likelihood
        • BNLikelihood
        • BNLogLikelihood
        • GMLikelihood
      • Detection: Sequential
      • Detection: Single Table
      • InterRowMSAS
      • ML Efficacy: Sequential
      • ML Efficacy: Single Table
        • Binary Classification
        • Multiclass Classification
        • Regression
      • NewRowSynthesis
      • * OutlierCoverage
      • Privacy Against Inference
      • * SmoothnessSimilarity
  • Resources
    • Citation
    • Contributions
      • Defining your metric
      • Development
      • Release FAQs
    • Enterprise
      • Domain Specific Reports
    • Blog
Powered by GitBook
On this page
  • Requirements
  • Download Instructions
  • Troubleshooting
  1. Getting Started

Installation

PreviousSDMetricsNextQuickstart

Last updated 2 months ago

SDMetrics is an open source Python library available under the .

Requirements

  • SDMetrics has been developed and tested on Python

  • We recommend using a virtual environment (such as ) to avoid conflicts with other software on your device

Download Instructions

Download sdmetrics using .

pip install sdmetrics

This automatically downloads from .

Download sdmetrics using .

conda install -c pytorch -c conda-forge sdmetrics

This automatically downloads from .

Troubleshooting

These docs only apply to the latest version. If you're experiencing issues importing and using sdmetrics, check your version using:

import sdmetrics
print(sdmetrics.__version__)

The printed version number should be the latest one found in our .

For other problems, please . You can browse existing issues and raise a new one if you cannot find a solution.

You can also ask questions by joining the .

MIT License
3.8-3.13
virtualenv
pip
PyPi
conda
anaconda
Release Notes
visit our GitHub
SDV Slack