hugiml-core Logo

User guide

  • Getting started
    • Installation
    • Minimal classifier workflow
    • Cross-validation and production schemas
    • Recommended first checks
    • Performance-oriented starting point
  • Core concepts
    • HUG-IML process
    • Pattern anatomy
    • Key hyperparameters
    • Missing values
    • Adaptive binning
    • Performance and mining behavior
    • Operational stability controls
    • Constant and zero-utility columns
  • Feature modes
    • Augmented pair features
    • Examples
    • Downstream matrix policy
    • Interpretation notes
    • Compatibility with transform
    • Operational guidance
  • Execution modes
    • Basic usage
    • Production-mode guidance
    • Recommended workflow
  • Augmented pair features
    • When they are active
    • Feature families
    • Example
    • Interpretation
    • Budgeting
    • Review workflow
  • Fast hyperparameter tuning
    • Fast path eligibility
  • Explanations and dashboards
    • Pattern tables
    • Hybrid feature interpretation
    • Interpretability metrics
    • Plotly dashboard
    • Profile views
    • HUGIML versus additive shape models
    • SHAP bridge
  • Governance Studio dashboard
    • Workflow sections
    • Data inputs
  • Governance, pruning, and model cards
    • Model cards
    • Pattern pruning
    • Audit artifacts
    • Calibration
  • Monitoring, drift, and serialization
    • Prediction monitoring
    • Drift detection
    • Serialization
    • Telemetry
  • Deployment
    • FastAPI inference server
    • Kubernetes
    • Production checklist
  • Benchmarks
    • Compared models
    • Predefined datasets
    • Custom datasets
    • Tuned benchmarks
    • Programmatic use
    • Outputs
    • Benchmark visuals
    • Missing-value robustness
    • Interpretation guidance
    • Reproducibility notes
  • Worked notebooks
    • Publishing notebooks
  • Publishing on Read the Docs
    • Repository files used by Read the Docs
    • Recommended update workflow
    • Updating the existing hugiml-core RTD page
    • Local build check
    • PyPI and docs alignment
    • Troubleshooting
  • Paper and scientific scope
    • Reference
    • Scope reflected in this implementation
    • Citation

API reference

  • API reference
    • Core estimator
      • Architecture
      • Quick start
      • HUGIMLClassifier
      • HUGIMLClassifierNative
      • FitMetadata
      • HUGIMLTuneResult
    • Adaptive binning
      • Adaptive-binning algorithm (three steps)
      • Non-finite value handling
      • Usage
      • HUGIMLAdaptive
    • Metrics
      • Quick reference
      • Available metrics
      • InterpretabilityMetrics
      • compute_all_metrics()
      • metrics_dataframe()
    • Calibration
      • CalibrationResult
      • evaluate_calibration()
      • reliability_diagram_data()
      • brier_decomposition()
    • Plots
      • Public API
      • HUGPlotter
    • Governance
      • ModelCard
      • AuditArtifact
      • GovernanceMetadata
      • generate_model_card()
      • package_audit_artifacts()
    • Explainability
      • ExplainabilityReport
      • FeatureLineage
      • ExplanationStabilityMetrics
      • HUGPatternExplainer
      • shap_values_from_pattern_matrix()
    • Monitoring
      • PredictionMonitor
      • DriftDetector
      • DriftReport
    • Multiclass and imbalance
      • MulticlassHUGReport
      • make_imbalanced_pipeline()
      • encode_high_cardinality()
      • apply_encoding()
    • Pattern pruning
      • Workflow
      • PatternEditor
      • RemovalRecord
    • Serialization
      • Format (v3 — default)
      • Authentication
      • Backward compatibility (v1/v2)
      • save_model()
      • load_model()
      • generate_sbom()
    • Telemetry
      • OpenTelemetry
      • Prometheus
      • Debug logging
      • HUGIMLTracer
      • HUGIMLMetrics
      • instrument_classifier()
    • Exceptions
      • HUGIMLError
      • HUGIMLFitError
      • HUGIMLMiningError
      • HUGIMLTimeoutError
      • HUGIMLMemoryError
      • HUGIMLValidationError
      • HUGIMLSchemaError
      • HUGIMLParamError
      • HUGIMLSerializationError
      • HUGIMLVersionError
      • HUGIMLPredictionError
      • HUGIMLWarning
      • HUGIMLConvergenceWarning
      • HUGIMLDtypeDriftWarning
      • HUGIMLRangeWarning
      • HUGIMLDegradedWarning
      • HUGIMLDeprecationWarning

Project

  • Contributing
  • Changelog
hugiml-core
  • Search

© Copyright 2026, Srikumar Krishnamoorthy.

Built with Sphinx using a theme provided by Read the Docs.