Skip to main content

Crate dag_ml

Crate dag_ml 

Source
Expand description

Public Rust facade for DAG-ML.

Modules§

aggregation
bundle
campaign
controller
controller_registry
Loader for declarative *.controller.yaml registries.
data
dsl
error
fold
generation
graph
ids
metrics
observability
ADR-12 observability hooks.
oof
phase
plan
policy
provenance
relation
rng
runtime
selection

Structs§

AggregateRepresentation
AggregatedPredictionBlock
AggregationControllerResult
AggregationControllerSpec
AggregationControllerTask
AggregationPolicy
ArtifactHandleRecord
ArtifactId
ArtifactInputSpec
ArtifactMaterializationRequest
ArtifactPayloadMaterializationRecord
ArtifactRef
AugmentationPolicy
BranchId
BranchViewPlan
BundleDataRequirement
BundleId
BundlePredictionBlockCacheRecord
BundlePredictionCachePayload
BundlePredictionCachePayloadSet
BundlePredictionCacheRecord
BundlePredictionRequirement
BundleReplayExecution
CampaignFingerprintSpec
CampaignSpec
CandidateScore
CartesianProductRepresentation
ColumnarPredictionCacheBlock
ColumnarPredictionCacheManifest
ColumnarPredictionCacheStore
CombinationPlan
CompiledPipelineDsl
ControllerId
ControllerManifest
ControllerRegistry
DagMlErrorDescriptor
A stable ADR-11 error payload that can be serialized across bindings.
DataBinding
DataHandleRecord
DataMaterializationRequest
DataModelShapePlan
DataOutputProvenance
DataPlan
DataPlanStep
DataProviderViewSpec
DataViewHandleRecord
DataViewPolicy
DataViewRequest
DataViewSelector
EdgeContract
EdgeSpec
EvaluationResult
ExecutionBundle
ExecutionPlan
ExecutionScopePlan
ExplanationBlock
An EXPLAIN-phase output block (ADR-12 explain contract). Explanations are a node output returned in the NodeResult — like predictions, they cross as data, not as an opaque host handle. The payload shape is controller-defined (e.g. per-feature importances); the core does not interpret it. Explanations are only valid in the EXPLAIN phase.
ExternalDataPlanEnvelope
FeatureSelectionPolicy
FileArtifactManifest
Versioned, file-backed artifact manifest. This is a manifest/portability layer only: it records portable ArtifactRef metadata for a bundle’s refit artifacts. It does not deserialize ML objects or materialize artifact payloads; payload stores remain future work.
FileArtifactManifestEntry
One persisted artifact entry. Mirrors the bundle RefitArtifactRecord identity (node, controller, artifact and params fingerprint) while requiring the ArtifactRef to be portable so the manifest stays movable with its payloads.
FileArtifactManifestStore
File-backed artifact manifest store rooted at a directory.
FileArtifactPayloadStore
FilePredictionCacheEntry
FilePredictionCacheManifest
FilePredictionCacheStore
FitInfluenceDiagnostic
FitInfluenceTask
FoldAssignment
FoldId
FoldSet
GenerationChoice
GenerationDimension
GenerationParamOverride
GenerationSpec
GraphInterface
GraphPlan
GraphSpec
GroupId
GroupKFoldSpec
HandleRef
InMemoryAggregatedPredictionStore
InMemoryArtifactStore
InMemoryDataProvider
InMemoryLineageRecorder
InMemoryPredictionCacheStore
InMemoryPredictionStore
KFoldSpec
LeakageUnitPolicy
LineageId
LineageRecord
ModelInputFusionPolicy
ModelInputPortSpec
ModelInputSpec
MonteCarloCartesianRepresentation
NodeId
NodePlan
NodeResult
NodeSpec
NodeTask
ObservationId
ObservationPredictionBlock
OofCampaign
OofMatrix
OpenLineageRunEventOptions
OperatorSelector
ParallelScheduler
PhaseExecutionSchedule
PipelineDslBranch
PipelineDslBranchStep
PipelineDslConcatBranch
PipelineDslConcatTransformStep
PipelineDslDataPort
PipelineDslGenerationChoice
PipelineDslGenerationDimension
PipelineDslGenerationParamOverride
PipelineDslGeneratorStage
PipelineDslGeneratorStep
PipelineDslMergeModelStep
PipelineDslMergeSelector
PipelineDslMergeStep
PipelineDslOperatorStep
PipelineDslPredictionPort
PipelineDslSequenceStep
PipelineDslShapePlan
PipelineDslSpec
PipelineDslTuningSpec
PipelineDslVariantChoice
PortRef
PortSchema
PortSpec
PredictionBlock
PredictionCacheMaterializationRecord
PredictionCacheMaterializationRequest
PredictionInputSpec
PredictionJoinPolicy
RankedCandidate
ReductionPlan
RefitArtifactRecord
RefitSlotPlan
RegressionMetricReport
RegressionTargetBlock
RelationContract
ReplayPhaseRequest
RepresentationComboSelectionRecord
RepresentationCompatibilityReport
RepresentationReplayManifest
RepresentationSampleObservationMapping
ResearchProvenanceExport
ResearchProvenancePackage
ResearchProvenancePackageFile
ResearchProvenancePackageValidation
RunContext
RunId
RuntimeControllerRegistry
SampleId
SampleRelation
SampleRelationSet
SchemaMigrationPolicy
SeedContext
SelectionDecision
SelectionMetric
SelectionPolicy
SequentialScheduler
ShapeDelta
SplitInvocation
StackFixedRepresentation
StackPaddedMaskedRepresentation
StackingFitContract
StratifiedKFoldSpec
Stratified K-fold: each sample is validated exactly once (OOF-safe like plain K-fold), but folds are balanced by a per-sample class label so every fold mirrors the overall class distribution. strata maps each sample id to its class label (identity-keyed metadata — never feature values).
TargetId
VariantExecutionSpec
VariantId
VariantPlan

Enums§

AggregationControllerInput
AggregationControllerOutput
AggregationMethod
AggregationWeights
ArtifactBackend
ArtifactPolicy
AugmentationScope
BranchViewMode
CombinationMode
ControllerCapability
ControllerFitScope
DagMlError
DataPlanStepKind
DataRequestPartition
EntityUnitLevel
EvaluationScope
FeatureSelectionScope
FitBoundary
FitInfluenceMechanism
FitInfluencePolicy
FoldPartition
GenerationStrategy
Granularity
HandleKind
InferenceFeatures
MetaRowDomain
MetaTrainingFeatures
MetricObjective
MissingnessPolicy
ModelInputFusionMode
NestedCvSpec
Inner (nested) cross-validation policy.
NodeKind
Phase
PipelineDslBranchMode
PipelineDslGeneratorMode
PipelineDslGeneratorValue
PipelineDslMergeOutput
PipelineDslParamGenerator
PipelineDslSelectionSpec
PipelineDslStep
PortCardinality
PortKind
PredictionJoinKey
PredictionLevel
PredictionPartition
PredictionUnitId
ReductionAxis
ReductionMethod
ReductionRole
ReductionTaskCompatibility
RefitStrategy
RegressionMetricKind
RepresentationCardinality
RepresentationCompatibilityOutcome
RepresentationCompatibilitySeverity
RepresentationMissingSourcePolicy
RepresentationPlan
RngPolicy
SelectionProtocol
ShapeDeltaKind
SplitUnit

Constants§

AGGREGATION_CONTROLLER_RESULT_SCHEMA_ID
AGGREGATION_CONTROLLER_RESULT_SCHEMA_VERSION
AGGREGATION_CONTROLLER_TASK_SCHEMA_ID
AGGREGATION_CONTROLLER_TASK_SCHEMA_VERSION
BUNDLE_PREDICTION_CACHE_FORMAT
CAMPAIGN_SPEC_SCHEMA_ID
CAMPAIGN_SPEC_SCHEMA_VERSION
CONTROLLER_MANIFEST_SCHEMA_ID
CONTROLLER_MANIFEST_SCHEMA_VERSION
DAGML_OPENLINEAGE_FACET_SCHEMA_URL
DATA_OUTPUT_PROVENANCE_KEY
DATA_OUTPUT_PROVENANCE_SCHEMA_ID
DATA_OUTPUT_PROVENANCE_SCHEMA_VERSION
DATA_PLAN_SCHEMA_ID
DATA_PLAN_SCHEMA_VERSION
EXECUTION_BUNDLE_FILE
EXECUTION_BUNDLE_SCHEMA_VERSION
EXECUTION_PLAN_FILE
EXECUTION_PLAN_SCHEMA_ID
EXECUTION_PLAN_SCHEMA_VERSION
EXTERNAL_DATA_PLAN_ENVELOPE_SCHEMA_VERSION
FILE_ARTIFACT_MANIFEST_FILE
FILE_ARTIFACT_MANIFEST_SCHEMA_VERSION
FILE_PREDICTION_CACHE_MANIFEST_FILE
FILE_PREDICTION_CACHE_STORE_SCHEMA_VERSION
GRAPH_SPEC_SCHEMA_ID
GRAPH_SPEC_SCHEMA_VERSION
LINEAGE_RECORDS_FILE
MIN_READABLE_EXECUTION_BUNDLE_SCHEMA_VERSION
MIN_READABLE_PREDICTION_CACHE_PAYLOAD_SCHEMA_VERSION
MIN_WRITABLE_EXECUTION_BUNDLE_SCHEMA_VERSION
MIN_WRITABLE_PREDICTION_CACHE_PAYLOAD_SCHEMA_VERSION
MODEL_INPUT_SPEC_SCHEMA_ID
MODEL_INPUT_SPEC_SCHEMA_VERSION
NODE_RESULT_SCHEMA_ID
NODE_RESULT_SCHEMA_VERSION
NODE_TASK_SCHEMA_ID
NODE_TASK_SCHEMA_VERSION
OBSERVABILITY_FIELD_ALLOWLIST
Frozen ADR-12 telemetry field allowlist. Every field emitted by this module must appear here, and each entry is an identifier or a count — never data. Adding a field requires an ADR-12 update and a review per the privacy rule.
OPENLINEAGE_RUN_EVENT_SCHEMA_URL
PIPELINE_DSL_SCHEMA_ID
PIPELINE_DSL_SCHEMA_VERSION
PREDICTION_CACHE_PAYLOAD_SCHEMA_VERSION
PROV_JSONLD_FILE
RESEARCH_PROVENANCE_SCHEMA_VERSION
RO_CRATE_METADATA_FILE
SELECTION_DECISION_SCHEMA_ID
SELECTION_DECISION_SCHEMA_VERSION
SELECTION_POLICY_SCHEMA_ID
SELECTION_POLICY_SCHEMA_VERSION

Traits§

RuntimeArtifactStore
RuntimeController
RuntimeDataProvider
RuntimePredictionCacheStore

Functions§

aggregate_observation_predictions
aggregate_sample_predictions_by_unit
build_aggregated_prediction_cache_payload
build_aggregated_prediction_cache_record
build_execution_bundle
build_execution_bundle_with_prediction_contracts
build_execution_bundle_with_prediction_requirements
build_execution_plan
build_openlineage_run_event
build_openlineage_run_event_from_package_files
build_prediction_cache_payload
build_prediction_cache_record
build_research_provenance_export
build_research_provenance_package
bundle_prediction_requirement_key
campaign_fingerprint
capabilities_support_fit_influence
compile_pipeline_dsl
compile_pipeline_dsl_with_controller_registry
compile_pipeline_dsl_with_generation
compile_pipeline_dsl_with_generation_and_controller_registry
dispatch_custom_aggregation_task
dispatch_custom_observation_aggregation
dispatch_custom_sample_aggregation
emit_oof_refusal
Emit the ADR-12 out-of-fold leakage refusal event with stable taxonomy fields (category/code mirror crate::DagMlError::OofLeakage) so log consumers can alert on refusals without parsing messages.
enumerate_variants
execution_bundle_schema_migration_policy
fold_set_fingerprint
generation_spec_fingerprint
join_oof_campaign_features
join_oof_features
load_yaml_manifest_from_path
Load and validate a single manifest from disk.
load_yaml_manifests_from_dir
Walk a directory for *.controller.yaml files and return a deterministically ordered, validated manifest list. Duplicate controller_ids across files are rejected so a directory cannot silently ship two definitions of the same controller.
lower_nirs4all_compat_pipeline_dsl
node_span
Build the per-node span (ADR-12), nested under the current phase span so node telemetry is attributed to its run, plan and controller. Identifiers only.
oof_campaign_fingerprint
parse_pipeline_dsl_json
parse_yaml_manifest
Parse a single YAML manifest from raw text. The same ControllerManifest deserializer is reused so YAML and JSON cannot drift on field shape.
phase_span
Build the per-phase-scope span (ADR-12). run_id/plan_id correlate concurrent or overlapping runs; empty variant_id/fold_id mean the field is not applicable to the current phase. Fields are identifiers only.
prediction_cache_payload_schema_migration_policy
refit_artifact_input_key
regression_report_to_candidate_score
relation_set_fingerprint
resolve_inner_cv
Resolve the effective inner-CV policy for a node: a node-local policy overrides the campaign-global default; None means no nested CV.
resolve_pipeline_dsl_minimal_aliases
score_regression_aggregated_block
score_regression_prediction_block
select_candidate
select_candidate_groups
validate_data_binding_envelope
validate_inner_fold_set_within_outer
Enforce the nested-CV invariant: every sample in inner — both the top-level universe and every fold’s train/validation members — must be an outer-fold training sample (never an outer-validation sample). Holds by construction for dag-ml-built inner folds, and also validates inner folds supplied from elsewhere. Refuses with an OOF-validation error on any leaking sample.
validate_oof_campaign
validate_prediction_blocks_against_folds
validate_prediction_blocks_are_oof
validate_prediction_cache_payload_matches_record
validate_research_provenance_package_files

Type Aliases§

Result