API map¶

The compatibility layer contains 127 public exports. This page groups the most important entry points by workflow so you can find the right family quickly. The complete alphabetical index remains available for exact-name lookup, and every compatibility export has its own reference page.

Find by research stage

Start with the decision you are making¶

Use these fast paths instead of scanning 127 names. Each section pairs the core functions with the scientific role they play.

01Task 02Provenance 03Resampling 04Fit 05Tuning 06Metrics 07Decisions 08Conformal 09External 10Reproducibility 11Artifacts 12Contracts

1. Task and use-case governance¶

Function	Purpose
`declare_gazepoint_task`	Declare outcome, identifiers, scientific workflow, and generalization target.
`assert_gp3ml_use_case`	Enforce the permitted-use boundary.
`validate_gazepoint_ml_roles`	Validate declared data roles.
`gp3ml_prohibited_uses`	Inspect the prohibited-use contract.

2. Feature provenance and leakage¶

Function	Purpose
`create_gazepoint_feature_manifest`	Declare predictor provenance and roles.
`validate_gazepoint_feature_manifest`	Validate a manifest before modelling.
`audit_gazepoint_ml_leakage`	Audit outcome, partition, identifier, and provenance leakage risks.
`write_gazepoint_ml_leakage_audit_csv`	Export the audit for review.

3. Splitting, grouping, and resampling¶

Function	Purpose
`split_gazepoint_ml_data`	Create a governed analysis/assessment split.
`create_gazepoint_group_folds`	Create repeated group-aware folds.
`audit_gazepoint_group_folds`	Audit group overlap and fold structure.
`diagnose_gazepoint_group_folds`	Produce detailed fold diagnostics.
`create_gazepoint_nested_folds`	Create outer/inner grouped resampling.
`audit_gazepoint_nested_resampling`	Audit nested-resampling independence.

4. Preprocessing and model fitting¶

Function	Purpose
`fit_gazepoint_preprocessor`	Fit analysis-local preprocessing.
`bake_gazepoint_preprocessor`	Apply a fitted preprocessor.
`gp3ml_engine_capabilities`	Inspect engine/task/backend capabilities.
`assert_gp3ml_engine_available`	Fail explicitly when a requested engine is unavailable.
`fit_gazepoint_model`	Fit a governed model.
`train_gazepoint_classifier`	Classification-oriented governed training.
`fit_gazepoint_deep_model`	Explicit optional deep-learning path.
`integrate_black_box_model`	Integrate an external model under declared safety constraints.

5. Tuning and nested evaluation¶

Function	Purpose
`create_gazepoint_tuning_grid`	Declare candidate hyperparameters.
`tune_gazepoint_model`	Tune within the permitted partition.
`compare_gazepoint_models`	Compare declared candidates.
`select_gazepoint_model`	Select under an explicit metric/direction.
`evaluate_gazepoint_nested_resampling`	Evaluate nested grouped workflows.
`validate_gazepoint_nested_evaluation`	Validate the nested-evaluation object.

6. Performance, calibration, and uncertainty¶

Function	Purpose
`gazepoint_classification_metrics`	Classification metrics.
`gazepoint_regression_metrics`	Regression metrics.
`gazepoint_performance_metrics`	Task-aware metric dispatch.
`bootstrap_gazepoint_metrics`	Bootstrap metric uncertainty.
`bootstrap_gazepoint_metrics_by_unit`	Bootstrap at the declared grouping unit.
`fit_gazepoint_calibrator`	Fit probability calibration.
`assess_gazepoint_calibration`	Audit calibration.
`evaluate_gazepoint_group_folds`	Run grouped resample evaluation.
`summarize_gazepoint_resample_uncertainty`	Summarize uncertainty across resamples.

7. Decision thresholds and abstention¶

Function	Purpose
`evaluate_gazepoint_thresholds`	Evaluate explicit threshold candidates.
`select_gazepoint_threshold`	Select from candidates under declared rules.
`create_gazepoint_decision_rule`	Store threshold, costs, origin, abstention, and justification.
`apply_gazepoint_decision_rule`	Apply a declared rule.
`audit_gazepoint_abstention`	Audit abstention coverage and covered error.

8. Conformal prediction¶

Function	Purpose
`fit_gazepoint_conformal`	Fit a conformal object under the declared task.
`predict_gazepoint_set`	Produce classification prediction sets.
`predict_gazepoint_interval`	Produce regression prediction intervals.
`assess_gazepoint_conformal_coverage`	Audit nominal and observed coverage.
`validate_gazepoint_conformal`	Validate the conformal contract.

9. External validation, shift, and robustness¶

Function	Purpose
`declare_gazepoint_external_dataset`	Declare external-dataset provenance and role.
`evaluate_gazepoint_external_transportability`	Evaluate transportability.
`validate_gazepoint_transportability`	Validate transportability evidence.
`audit_gazepoint_dataset_shift`	Audit predictor-distribution shift.
`audit_gazepoint_missingness_shift`	Audit missingness shift separately.
`summarize_gazepoint_shift`	Summarize shift evidence.
`audit_gazepoint_model_robustness`	Combine declared stability/sensitivity diagnostics.

10. Analysis plans and reproducibility¶

Function	Purpose
`declare_gazepoint_analysis_plan`	Declare the modelling plan.
`lock_gazepoint_analysis_plan`	Lock a plan before outcome-driven changes.
`audit_gazepoint_plan_deviations`	Compare execution against the plan.
`capture_gazepoint_environment`	Capture package/runtime environment.
`compare_gazepoint_environments`	Compare environments.
`audit_gazepoint_reproducibility`	Audit reproducibility-sensitive artifacts.
`validate_gazepoint_release_checksums`	Validate release artifact checksums.

11. Artifacts, handoffs, and governance evidence¶

Function	Purpose
`create_gazepoint_model_card`	Create a model card.
`create_gazepoint_model_artifact`	Create an auditable model artifact.
`test_gazepoint_model_portability`	Test model portability.
`create_gazepoint_handoff`	Create a typed cross-package handoff.
`validate_gazepoint_research_bundle`	Validate an integrated research bundle.
`write_gazepoint_ro_crate`	Export RO-Crate metadata.
`create_gp3ml_governance_profile`	Assemble governance evidence.
`audit_gp3ml_governance_profile`	Audit control-level evidence.

12. API and object contracts¶

Function	Purpose
`gp3ml_api_contracts`	Inspect stable/experimental public exports.
`gp3ml_object_schema`	Inspect public object schemas.
`validate_gp3ml_object_contract`	Validate an object against its contract.
`audit_gp3ml_api_stability`	Audit a frozen API.
`gp3ml_interop_contracts`	Inspect interoperability contracts.

Synthetic fixtures and examples¶

For tutorials and smoke tests, start with simulate_gazepoint_governed_data, create_gazepoint_synthetic_task, and create_gazepoint_synthetic_manifest.

For visual objects, see the plot gallery. For the exact frozen export list, use the complete alphabetical index or gp3ml_api_contracts().