跳到内容
DispatchAtlas
搜索

API 参考

公共 API 按发行包分组。请从拥有相应行为的最窄命名空间导入。下面的列表镜像了 当前的公共命名空间导出,使读者无需阅读各个包的 __init__.py 文件即可审查 受支持的导入面。

📦 根发行包

使用 dispatchatlas.version 获取轻量级根包版本面:

  • __version__

🧱 核心

dispatchatlas.core 是内层包边界。它导出领域对象、验证、溯源、序列化、种子、 文件系统、日志以及协议契约。

配置契约:

  • FoundationConfig
  • SeedPolicy
  • SerializationFormat
  • ValidationMode

错误契约:

  • DataQualityError
  • DispatchAtlasError
  • DomainValidationError
  • InfeasibleScheduleError
  • MissingOptionalDependencyError
  • ProvenanceError
  • ScheduleValidationError
  • SeedDerivationError
  • SerializationContractError
  • UnsupportedCapabilityError
  • require_finite — 返回强制转换为有限浮点数的值,当其为 NaN 或无穷大时抛出给定的错误契约。
  • require_non_negative_int — 返回该整数,当其为负时抛出给定的错误契约。
  • require_positive_int — 返回该整数,当其非正时抛出给定的错误契约。
  • require_text — 返回去除空白后的文本,当其为空白时抛出给定的错误契约。

文件系统辅助函数:

  • read_text_resilient
  • safe_child_directory
  • safe_directory_name
  • safe_namespaced_id
  • write_json_artifact
  • write_json_artifact_atomic
  • write_text_artifact
  • write_text_artifact_atomic

可观测性(集中式日志):

  • get_logger
  • make_formatter
  • console_handler
  • file_handler
  • scoped_logging
  • configure_root_logging
  • MESSAGE_FORMAT
  • CONSOLE_FORMAT
  • STRUCTURED_FORMAT
  • DEFAULT_DATEFMT
  • ROOT_LOGGER_NAME

战役清单契约:

  • CampaignCheckpointManifest
  • CampaignFailureRecord
  • CampaignRunRecord
  • campaign_checkpoint_from_jsonable
  • campaign_checkpoint_to_jsonable
  • campaign_failure_record_from_jsonable
  • campaign_failure_record_to_jsonable
  • campaign_run_record_from_jsonable
  • campaign_run_record_to_jsonable

调度模型契约:

  • Assignment
  • Constraint
  • ConstraintKind
  • Dependency
  • DependencyKind
  • Duration
  • Metadata
  • Objective
  • ObjectiveSense
  • ObjectiveValue
  • ParityBasis
  • ProblemId
  • ProblemSpec
  • ResourceAmount
  • ResourceId
  • ResourceRequirement
  • ResourceSpec
  • Schedule
  • ScheduleResult
  • ScheduleStatus
  • TaskId
  • TaskMode
  • TaskSpec
  • TimePoint
  • metadata_items

集成协议:

  • AnalysisExporter
  • BenchmarkDescriptor
  • BenchmarkProvider
  • DisclosureLabel
  • DisclosurePolicy
  • ExperimentPlan
  • ExperimentResult
  • ExperimentRunner
  • ResultRepository
  • Solver
  • SolverDescriptor
  • SolverRun

溯源契约:

  • ArtifactHash
  • CitationStatus
  • EnvironmentStamp
  • EvidenceClass
  • PackageRecord
  • Provenance
  • QualityGateStatus
  • SeedLineage
  • SourceReference
  • hash_bytes
  • utc_now

种子契约:

  • MAX_SEED
  • SEED_DOMAIN_SEPARATOR
  • Seed
  • SeedStream
  • derive_seed

序列化契约:

  • ArtifactEnvelope
  • canonical_json_bytes
  • dumps_envelope
  • envelope_artifact
  • envelope_from_jsonable
  • envelope_to_jsonable
  • environment_from_jsonable
  • environment_to_jsonable
  • loads_envelope
  • problem_from_jsonable
  • problem_to_jsonable
  • provenance_from_jsonable
  • provenance_to_jsonable
  • schedule_from_jsonable
  • schedule_to_jsonable

验证契约:

  • ValidatedProblem
  • ValidationIssue
  • ValidationReport
  • ValidationSeverity
  • ValidationStamp
  • collect_problem_issues
  • collect_schedule_issues
  • validate_problem
  • validate_schedule

核心尺寸常量:

  • DEFAULT_CPU_RESERVE — 默认从工作进程池中保留不用的 CPU 数。
  • DEFAULT_MEMORY_RESERVE_FRACTION — 默认保留备用的系统内存比例。
  • OBJECTIVE_FAMILY — 将每种目标类型映射到其规范定义的注册表。

主机并发:

  • available_cpu_count / available_system_memory_bytes — 本进程可用的 CPU 数以及尽力获取的可用系统内存。
  • maximal_safe_worker_count — 该主机的最大安全并行工作进程数。

连续统模型(边缘–雾–云):

  • ComputeTier — 一个连续统计算层(边缘、雾、云)及其聚合容量。
  • NetworkTopology / NetworkLink — 通信结构及其有向的跨层链路。
  • Bandwidth / DataVolume — 以字节每秒计的正链路吞吐量,以及以字节计的非负可传输数据量。
  • PlacementAffinity — 任务对连续统上某个放置目标的偏好。

成本模型(R||Cmax、通信、负载相关执行、序列相关装配):

  • CostModel / cost_model_from_jsonable / cost_model_to_jsonable — 通过标识符关联到某问题的成本模型包及其序列化。
  • ExecutionTimeMatrix / ExecutionTimeEntry / execution_matrix_from_iterable — 非相关机器执行时间矩阵(p_ij)。
  • CompatibilityMask — 显式的任务到机器的资格集合。
  • CommunicationModel / CommunicationLink — 稀疏图上的跨资源通信惩罚。
  • LoadModel / LoadModelKind / LoadBreakpoint — 负载相关的执行曲线及其在断点之间的插值。
  • SetupMatrix / SetupEntry / SetupReferenceKind — 按转移和机器编键的序列相关装配时间。

目标族:

  • ObjectiveKind / ObjectiveDefinition / objective_definition — 命名的调度目标及其规范元数据。
  • ObjectiveReduction / VectorObjectiveValue — 标量化规则,以及带披露元数据的、已测量的多目标向量。
  • vector_objective_from_jsonable / vector_objective_to_jsonable — 向量目标序列化。

目标评估:

  • evaluate_objective / evaluate_objectives / ObjectiveEvaluation — 在一个调度上评估一个或每个命名目标。
  • MultiObjectiveOutcome / computed_vector / multi_objective_outcome_from_jsonable — 一个调度的标量目标与向量目标以及可行性。
  • EvaluationStatus / objective_sense — 某值是已计算还是已延迟,以及某目标的优化取向。

可行性与约束:

  • FeasibilityReport / build_feasibility_report — 硬违约行加上软约束惩罚核算。
  • InfeasibleRow / SoftConstraintPenalty — 一条审阅者可见的硬违约和一项加权软约束惩罚。
  • ServiceLevelConstraint / ServiceLevelOutcome / evaluate_service_level / evaluate_service_level_over_schedule / resolve_metric — 调度指标上的命名服务水平约束及其评估。
  • ConstraintViolationSummary / summarize_constraints — 聚合的硬约束、软约束和服务水平约束核算。

帕累托前沿与质量指标:

  • dominates / to_minimization — 最小化下的帕累托支配关系与混合取向转换。
  • fast_non_dominated_sort / non_dominated_front / non_dominated_indices — NSGA-II 非支配排序与非支配集合。
  • FrontierPoint / LabelledPoint / frontier_data — 带标签的目标向量与前沿就绪记录。
  • hypervolume / igd_plus / additive_epsilon_indicator / spread — 四个质量指标:超体积、IGD+、加性 epsilon 和最近邻分布。
  • QualityIndicatorReport / quality_indicator_report — 一个前沿相对于参考集的全部四个指标。

鲁棒性:

  • PerturbationScenario / PerturbationSet — 一个目标的命名扰动情景。
  • RobustnessAggregation / RobustnessValue / evaluate_robustness — 扰动集如何在其陈述的基准上聚合为一个鲁棒性数值。

运行清单:

  • RunTiming / ResourceUsage / SolverCounters — 一次运行的挂钟与随时计时、峰值资源使用量和求解器投入计数器。
  • ConvergenceSample / TimedObjectiveSample — 在某迭代次数和某挂钟偏移处观测到的目标值。

终止:

  • TerminationPolicy — 一个可组合的多准则求解器停止策略。

文件系统安全:

  • safe_path_under_root — 仅当路径解析到某授权根目录之下时才返回的路径。

连续统序列化:

  • bandwidth_from_jsonable / bandwidth_to_jsonable
  • compute_tier_from_jsonable / compute_tier_to_jsonable
  • data_volume_from_jsonable / data_volume_to_jsonable
  • network_link_from_jsonable / network_link_to_jsonable
  • network_topology_from_jsonable / network_topology_to_jsonable
  • placement_affinity_from_jsonable / placement_affinity_to_jsonable

🧪 基准测试

dispatchatlas.bench 导出基准目录、通用和连续统族生成器、生成器元数据、 物化、引用验证、特征刻画、难度与分布距离指标、选择、下载以及分类法契约。

目录契约:

  • StaticBenchmarkProvider
  • benchmark_provider_for_selectors
  • build_feasibility_diagnostic_catalog
  • build_full_catalog
  • build_smoke_catalog
  • full_benchmark_provider
  • full_catalog_configs
  • smoke_benchmark_provider
  • smoke_catalog_configs

特征刻画契约:

  • CharacterizationMetrics
  • CharacterizationReport
  • characterize_problem

引用契约:

  • CitationClaim
  • CitationMatrix
  • SourceKind
  • default_citation_matrix
  • validate_citation_matrix

生成器契约:

  • BenchmarkGenerator
  • DagWorkflowGenerator
  • GeneratorRegistry
  • IndependentTaskGenerator
  • cloud_edge_profile
  • default_registry
  • workflow_profile

物化契约:

  • BenchmarkInstance
  • BenchmarkInstanceSet
  • CatalogManifest
  • CatalogManifestEntry
  • config_to_jsonable
  • manifest_to_jsonable
  • materialize_benchmark
  • materialize_with_generator
  • write_instance_set

元数据契约:

  • BenchmarkConfig
  • DomainProfile
  • GeneratorMetadata
  • ScaleSpec

通用族契约:

  • CostModelGenerator
  • GenericFamilyGenerator
  • flexible_job_shop_generator
  • flow_shop_generator
  • generic_family_full_configs
  • generic_family_generators
  • generic_family_smoke_configs
  • job_shop_generator
  • machine_scheduling_generator
  • rcpsp_generator
  • setup_flow_shop_generator

连续统族契约:

  • ContinuumFamilyGenerator
  • ContinuumFamilySpec
  • ContinuumScenario
  • ContinuumStratum
  • DistinctivenessRecord
  • build_continuum_catalog
  • build_continuum_full_catalog
  • continuum_family_distinctiveness
  • continuum_family_full_configs
  • continuum_family_generators
  • continuum_family_smoke_configs
  • continuum_family_specs

难度契约:

  • HardnessAxis
  • HardnessSpec
  • hardness_axis
  • hardness_axis_registry
  • measured_communication_compute_ratio
  • measured_deadline_slack_ratio
  • measured_dependency_density
  • measured_duration_cv
  • measured_fabric_churn
  • measured_offload_deception
  • measured_release_stagger

分布距离契约:

  • MAX_DISTRIBUTION_DISTANCE
  • DistributionDistanceBridge
  • DistributionDistanceScore
  • DistributionDistanceStatus
  • default_distribution_distance_bridges
  • metrics_from_instance_set
  • per_feature_wasserstein
  • distribution_distance_score
  • validate_distribution_distance_bridge

选择契约:

  • DifficultyStratum
  • SubsetCriteria
  • difficulty_score
  • difficulty_stratum
  • instance_family
  • instance_profile_class
  • select_benchmark_subset
  • stratify_instances

目录元数据与下载契约:

  • CATALOG_SCALAR_COLUMNS
  • CatalogInstanceMetadata
  • DownloadFormat
  • catalog_instance_metadata
  • catalog_instance_to_jsonable
  • catalog_instance_to_row
  • catalog_metadata_for_instances
  • catalog_metadata_for_sets
  • catalog_subset_from_bundle
  • catalog_subset_from_csv
  • catalog_subset_from_json
  • catalog_subset_to_bundle
  • catalog_subset_to_csv
  • catalog_subset_to_json
  • select_catalog_metadata
  • serialize_catalog_subset

分类法契约:

  • DEFAULT_TAXONOMY
  • BenchmarkTaxonomy
  • BenchmarkTier
  • ConstraintFeature
  • DynamismFeature
  • EnvironmentDomain
  • InfrastructureRealism
  • ObjectiveFeature
  • ProfileClass
  • SchedulingFamily
  • SchedulingStructure
  • UncertaintyFeature

参考套件注册表契约:

  • InstanceCountStatus
  • ReferenceSuite
  • SuiteFormat
  • default_reference_suites
  • reference_suite
  • validate_reference_suites

已知最优解契约:

  • BestKnownIngest
  • BestKnownKind
  • BestKnownRegistry
  • BestKnownValue
  • load_best_known
  • load_best_known_registry

规范实例摄取契约:

  • SUPPORTED_FORMATS
  • ParseContext
  • ParsedInstance
  • ReferenceSuiteGenerator
  • load_reference_suite
  • parse_fjs
  • parse_standard_jsp
  • parse_taillard_pfsp
  • parse_wfformat_json
  • reference_suite_config
  • reference_suite_distribution_distance_bridge

🧮 求解器

dispatchatlas.solve 导出求解器元数据、注册表、构造式基线、元启发式、 NDSO 变体、算子、可选适配器以及性能分析辅助工具。

基线与执行契约:

  • DispatchRule
  • DispatchingSolver
  • OrderRunRequest
  • TerminationTracker — 有状态的首先触发评估器,它将搜索循环的进度折叠进 一个 TerminationPolicy,并报告是哪个准则停止了该次运行。
  • baseline_solvers
  • neh_order — NEH 插入式构造顺序(Nawaz–Enscore–Ham)。

求解器元数据契约:

  • DependencyRequirement
  • SolverCapability
  • SolverDescriptorSpec
  • SolverFamily
  • SolverMetadata
  • Stochasticity

元启发式契约:

  • MetaheuristicKind
  • PermutationMetaheuristicSolver
  • PermutationSearchConfig
  • metaheuristic_solvers

基于秩的列表调度契约:

  • ListSchedulingRank
  • ListSchedulingSolver
  • list_scheduling_solvers
  • heft_profile — 上行秩列表调度(HEFT)。
  • cpop_profile — 组合上行+下行秩列表调度(CPOP)。
  • peft_profile — 乐观成本表列表调度(PEFT)。

就绪集映射规则契约:

  • MappingRule
  • MappingRuleSolver
  • mapping_rule_profile
  • mapping_rule_solvers — min-min、max-min 与 sufferage 批量规则。

帕累托多目标竞品契约:

  • NSGA2Config
  • NSGA2Solver
  • MOEADConfig
  • MOEADSolver
  • nsga2_profile
  • moead_profile
  • multi_objective_solvers
  • crowding_distances — NSGA-II 拥挤距离密度估计器。
  • nsga2_environmental_selection — 先按秩再按拥挤度的精英存活。
  • tchebycheff — MOEA/D 的切比雪夫标量化函数。

迭代贪心契约:

  • ITERATED_GREEDY_RS_CITATION
  • IteratedGreedyRSConfig
  • IteratedGreedyRSSolver — 用于置换流水车间的规范破坏–构造配置。
  • iterated_greedy_rs_profile
  • iterated_greedy_rs_solvers

关键路径禁忌契约:

  • CriticalPathTabuConfig
  • CriticalPathTabuSolver
  • critical_path_tabu_profile
  • critical_path_tabu_solvers
  • critical_pairs — 关键路径相邻对邻域生成器。

项目调度(串行 SGS)契约:

  • SerialSGSJustificationSolver — 带双重论证的串行调度生成,用于资源受限项目调度。
  • serial_sgs_justification_profile
  • serial_sgs_justification_solvers
  • double_justified_order — 后向–前向论证遍。
  • latest_finish_order — 最迟完成时间优先顺序。

NDSO 契约:

  • NDSOAblation
  • NDSOMechanisms
  • NDSOSolver
  • NDSOVariant
  • ndso_ablation_catalog
  • ndso_solvers

调度算子契约:

  • BatchScoreResult
  • ScheduleMetrics
  • adjacent_swap_neighbor
  • batch_score_orders
  • construct_schedule
  • earliest_finish_task_order
  • local_search_order
  • normalize_task_order
  • objective_values_for
  • random_topological_task_order
  • repair_schedule
  • schedule_metrics
  • score_order
  • score_schedule
  • topological_task_order

可选适配器契约:

  • OptionalExactSolver
  • optional_solvers
  • ortools_dependency

性能契约:

  • BatchScoringProfile
  • ProfiledResult
  • profile_call

注册表契约:

  • ProfiledSolver
  • SolverRegistry
  • default_solver_registry

求解器调优常量:

  • NATIVE_EXACT_TASK_CAP — 原生精确求解器在其之上即失败关闭的任务数上限。
  • RUN_COUNT_FLOOR — 公平比较所要求的最小重复运行次数。
  • VELOCITY_WINDOW — 随时控制器所监视的改进速度窗口。
  • IMPROVEMENT_FLOOR — 计为进展的最小相对改进。
  • FEATURE_ORIGIN — 每个选择特征所派生自的基准平台指标。

基线调度族:

  • DispatchingFamilySpec — 绑定到某确定性优先规则的命名调度族。
  • RetiredFamily / RetirementReason / retired_dispatching_families — 被有意搁置的命名族,每个都附带其理由。

多样化竞争者(命名的元启发式领域):

  • CompetitorKind / CompetitorSolver / CompetitorConfig — 共享有界搜索参数的命名竞争者。
  • competitor_solvers / diversified_competitors — 多样化、披露感知的竞争者集合。
  • post_2020_currency_anchor — 该领域的 post-2020 时效锚定参考文献。
  • recent_peer_strength_bar — 在发表场所强度门槛下保留的近期同行工作。

连续优化器(解码到离散顺序上):

  • clpso_optimize / CLPSOConfig — 综合学习粒子群优化。
  • lshade_optimize / LSHADEConfig — 带线性种群缩减的成功历史自适应差分进化。
  • EncodedSolverKind / EncodedAdapterSolver / encoded_adapter_solvers — 绑定到离散编码适配器的连续族。
  • ContinuousResult / SearchBudget — 一次连续运行的结果及其迭代、随机性和挂钟预算。

连续到离散编码:

  • EncodingAdapter / encoding_adapter / encoding_adapter_catalog — 带显式修复的命名连续到离散编码。
  • DecodeRule / DecodeOutcome — 将变换后的键向量转为任务顺序的规则及其修复结果。
  • RepairPolicy — 在解码后恢复前驱可行性的策略。
  • TransferFunction — 将连续分量映射到选择信号的压缩函数。

精确求解器:

  • ExactMethod / ExactSolver — 命名的精确方法和一个在缺失后端或输入过大时失败关闭的适配器。
  • ExactAdapterSpec / exact_adapter_specs / exact_solvers — 捆绑的精确求解器适配器契约。

多目标竞争者(NSGA-III):

  • NSGA3Solver / NSGA3Config / nsga3_solvers / nsga3_profile — 在前驱安全顺序上运行的 NSGA-III 竞争者。
  • nsga3_reference_points — 单位单纯形上的 Das & Dennis 结构化参考点。
  • nsga3_environmental_selection — NSGA-III 参考点小生境选择。

学术调度变体:

  • SchedulingVariantKind / PermutationSchedulingVariantSolver / SchedulingVariantConfig — 在离散顺序编码上的命名学术混合变体。
  • scheduling_variant_solvers — 一等的调度变体基线。

算法选择:

  • RuleBasedSelector — 仅从元数据对候选进行排名的纯基准基线。
  • SupervisedSelector — 一个确定性的距离加权最近邻学习型选择器。
  • SelectionFeature / SelectionFeatures / feature_origin — 选择器所消费的命名特征刻画特征及其来源。
  • SelectionLabel / SolverRecommendation / RecommendationSource — 带标签的训练样例和带置信度与局限的排名推荐。

选择器交叉验证(无泄漏泛化):

  • cross_validate / GeneralizationReport — 在语料上的留一族法保留泛化。
  • leave_one_family_out / partition_by_families / TrainTestSplit — 族不相交的训练/测试划分。
  • held_out_generalization — 在划分的训练半部上训练,并在其测试半部上报告 top-1 准确率。
  • leakage_report / LeakageReport — 无泄漏划分必须保持为空的实例、族和特征刻画记录重叠。
  • validated_supervised_selector — 一个其置信度反映其保留泛化的选择器。

学习与混合接口(可选,失败关闭):

  • LearningInterfaceKind / LearningInterface / learning_interface / learning_interface_catalog — 带状态、策略和回退的命名学习与混合接口。
  • InterfaceStatus / LearningEvidencePolicy — 每个此类面所声明的生命周期状态与证据契约。
  • ConfidenceLabel / confidence_rank — 推荐可携带的置信度及其序数强度。
  • learning_backend_available / learning_dependency / require_learning_backend — 可选的学习后端(一个额外项,绝非默认)及其带类型的缺失依赖错误。

求解器元数据与引用:

  • Citation / CitationStatus — 一个规范的开创性参考(或一条显式的不适用理由),以及某族是否携带它。
  • SolverEncoding — 求解器搜索或构造其上的解编码。
  • SUMMIT_EVIDENCE_LABEL — 用于元数据、证据和导出的披露上下文标签。

NDSO 族面:

  • NDSOFamilySolver — 每个 NDSO 族求解器(单群或议会)的公共面。
  • fast_mechanisms — 快速组合的固定机制集合。

NDSO 机制(设计即有效构造):

  • PrecedenceIndex / precedence_index — 每个构造器所使用的前驱集合和稳定任务排序。
  • GuidanceSource / GuidanceContext / select_guidance — 三个三重引导源以及候选解的共享构造输入。
  • guided_construction — 从一个引导顺序构建一个可行候选解。
  • confidence_weighted_elite — 通过置信度加权投票锻造精英解。
  • ConfidenceMatrix / consolidate_confidence / latent_archive — 学习到的逐单元信任、其跨群整合,以及精英解已舍弃的高置信单元。
  • quality_guidance / quantity_update / BetaSchedule — 质量与数量规则以及统一的自适应系数。
  • rank_reward — 一个在 [0, 1] 内的、由排名派生的奖励。

NDSO 群间议会:

  • NDSOSummitSolver / summit_solver / summit_profile / SummitConfig — 群间议会,即该族的质量组合。
  • CouncilTopology — 连接议会各群的群间交换拓扑。
  • SummitDiagnostics — 附加到一次运行上的不可变议会协调摘要。

NDSO 机制消融:

  • AblationEntry / ablation_map — 每个规范机制对应一项隔离消融。
  • build_ablation_solver / run_ablation_suite / AblationRunResult — 构建并运行每项可行性有界的隔离消融。
  • ABLATION_STATISTICAL_PLAN / StatisticalTestPlan — 消融比较所使用的命名分析层统计检验。

NDSO 随时控制:

  • AnytimeController / AnytimeReport — 改进速度早停控制器及其活动记录。

NDSO 诊断:

  • DiagnosticsCollector / DiagnosticsSnapshot — 一个可选的、禁用时零开销的收敛记录器及其摘要。
  • IterationTrace — 一次迭代的收敛记录。
  • population_diversity — 在 [0, 1] 内的平均成对位置分歧。

NDSO 披露(失败关闭机制门控):

  • MechanismDescriptor / mechanism_descriptor / mechanism_catalog — 命名机制以及每个机制所属的披露下限。
  • DisclosureFilter / DisclosureViolationError — 关于报告范围可以暴露哪些机制的失败关闭门。
  • ReportScope / EvidenceProgram — 分阶段的报告范围以及映射到披露下限的四个分阶段证据计划。
  • base_disclosure_filter / program_disclosure_filter — 基础范围和逐计划的失败关闭过滤器。
  • blocks_summit_evidence — 某计划的过滤器是否屏蔽仅议会的质量下限。

🚀 战役

dispatchatlas.lab 导出可复现的战役配置、预算、环境、仓库、失败以及执行契约。

预算契约:

  • CampaignBudgetReport
  • dry_run_campaign

配置契约:

  • FULL_CAMPAIGN_BLOCKER
  • BudgetScaling
  • CampaignConfig
  • CampaignPlan
  • CampaignRunSpec
  • CampaignStage
  • ExecutionMode
  • FailureCategory
  • OutputPolicy
  • ResourceBudget
  • RetryPolicy
  • campaign_config_hash
  • config_to_jsonable
  • plan_to_jsonable

环境契约:

  • capture_campaign_environment

错误契约:

  • BudgetEstimationError
  • CampaignConfigError
  • CampaignExecutionError
  • CheckpointRecoveryError
  • EnvironmentCaptureError

仓库契约:

  • CampaignResultIndex
  • CheckpointManifest
  • FailureRecord
  • FileResultRepository
  • RunRecord

运行器契约:

  • CampaignRunner
  • classify_failure
  • default_campaign_runner
  • resume_campaign
  • run_campaign
  • validate_campaign

战役配置:

  • CampaignKind — 一个战役所实现的实验设计类别。
  • StoppingProtocol / StoppingProtocolKind — 用于随机求解器报告的命名、可独立报告的停止协议。
  • RunCountPolicy / STATISTICAL_POWER_FLOOR — 运行次数策略,以及在其之下某求解器的运行被标记为功效不足的最小重复次数。
  • TuningBudget — 保持比较公平的每算法相等调优预算。
  • campaign_config_from_jsonable — 从 JSON 兼容数据重新构造一个已验证的战役配置。

运行次数解析:

  • ReplicateResolution / resolve_replicates — 在运行次数策略下,某求解器解析后的重复次数及任何功效不足标记。

公平比较不变式:

  • assert_fair_comparison — 验证公平比较不变式的结构性前置条件。
  • fair_comparison_manifest — 记录公平比较保证的清单行。

引擎设置(四层溯源戳记解析):

  • EngineSettings / resolve_engine_settings — 跨四个配置层解析的引擎旋钮,每个字段都戳记溯源。
  • ResolvedSetting / SettingSource — 一个设置的值与提供它的层配对。
  • apply_environment_overrides — 将环境层叠加到文件或调用点战役配置之上。

工作进程拓扑与聚合:

  • WorkerTopology / topology_for_plan / probe_capacity — 在探测主机容量后为战役选定的、尊重预算的工作进程拓扑。
  • AggregateManifest / merge_only_aggregation — 将已完成的运行记录确定性地仅合并聚合为一个位稳定的战役哈希。

实验图谱:

  • ExperimentAtlas / default_experiment_atlas — 一个披露感知的、自有证据轨道图谱。
  • EvidenceTrack — 实验图谱中的一个自有证据切片。

按基准族划分的求解器适用性矩阵:

  • ApplicabilityMatrix / default_applicability_matrix — 完整的按基准族划分的求解器适用性矩阵,先从活跃注册表派生,再由覆盖表加以标注。
  • ApplicabilityCell — 一条 (基准族, 求解器) 适用性陈述,携带其状态、理据与可选的证据指针。
  • ApplicabilityStatus — 每个单元的已验证 / 近似 / 不适用状态枚举。
  • ApplicabilityEvidence / ApplicabilityEvidenceKind — 一个门户安全的证据指针(活动、引用或测试)及其出处类别。
  • ApplicabilityOverride / default_applicability_overrides — 对一个派生单元的一次可复核的手动升级,以及已验证单元所在的代码内覆盖表。
  • SchedulingFamilyCell — 一个按调度族划分的求解器汇总,聚合其构成的基准族单元。
  • derive_applicability_cell — 从已声明的元数据派生一个近似-或-不适用单元。
  • constraint_capability_bridge — 类型化的约束特性到能力标签的桥接(单一真相来源)。
  • ApplicabilityScreen / screen_campaign_applicability — 将一个已规划活动的叉积对照矩阵进行筛查,报告被阻断、近似与已验证的配对。

📊 分析

dispatchatlas.analytica 导出披露过滤、摄取、统计摘要、确定性 Markdown 表格 写入器、十六个图表族(每个都以双格式渲染:可主题化的 SVG 和可编辑的 PGFPlots .tex)、证据包以及门户数据集。

披露契约:

  • DisclosureExclusion
  • DisclosureFilterResult
  • DisclosurePolicy
  • EvidenceTier
  • default_disclosure_policy
  • ensure_dataset_allowed
  • filter_dataset

导出契约:

  • ExportBundle
  • evidence_bundle_directory
  • write_evidence_bundle
  • write_portal_dataset

摄取契约:

  • PlanRunFacts
  • load_campaign_dataset
  • load_result_dataset

模型契约:

  • AnalysisConfig
  • AnalysisDataset
  • AnalysisSummary
  • CampaignManifest
  • CorrectionMethod
  • ExportSurface
  • FailureObservation
  • ObjectiveObservation
  • PairwiseComparison
  • RankEntry
  • RunObservation
  • SolverSummary

统计契约:

  • bootstrap_mean_interval
  • cliffs_delta
  • cohens_d
  • paired_cohens_dz
  • paired_observation_counts
  • summarize_dataset
  • two_sided_sign_test

表格契约:

  • ablation_table_markdown
  • arpd_markdown
  • benchmark_table_markdown
  • constraints_table_markdown
  • ensure_effect_sizes_beside_p_values
  • infeasible_rows_markdown
  • multiobjective_indicators_markdown
  • optimality_gap_table_markdown
  • pairwise_comparison_markdown
  • portal_csv
  • ranking_markdown
  • sensitivity_table_markdown
  • solver_summary_markdown

可视化契约(每个图表族都渲染为可主题化的 SVG 和可编辑的 PGFPlots .tex):

  • ablation_svg · ablation_tex
  • characterization_svg · characterization_tex
  • convergence_svg · convergence_tex
  • critical_difference_svg · critical_difference_tex
  • data_profile_svg · data_profile_tex
  • ecdf_svg · ecdf_tex
  • exploration_exploitation_svg · exploration_exploitation_tex
  • frontier_svg · frontier_tex
  • performance_profile_svg · performance_profile_tex
  • ranking_svg · ranking_tex
  • robustness_svg · robustness_tex
  • run_order_trend_svg · run_order_trend_tex
  • runtime_quality_svg · runtime_quality_tex
  • scalability_svg · scalability_tex
  • sensitivity_svg · sensitivity_tex
  • stability_svg · stability_tex

比较契约:

  • ComplexityRow
  • EvidenceCaveat
  • EvidenceCaveatScope
  • HeadToHeadComparison
  • HeadToHeadRow
  • complexity_table_markdown
  • evidence_caveats_markdown
  • head_to_head_comparison

推断与效应量(确定性、无依赖的显著性检验):

  • friedman_test / FriedmanResult — 在多个算法上的 Friedman 综合秩检验。
  • FriedmanOutcome — 在完整求解器领域上的 Friedman 综合秩检验。
  • nemenyi_critical_difference / CriticalDifference — 用于平均秩的 Nemenyi 全配对临界差。
  • wilcoxon_signed_rank / WilcoxonResult — 用于配对差异的双侧 Wilcoxon 符号秩检验。
  • bayesian_sign_test / BayesianSignTestResult — 在配对差异上带实际等价区域的贝叶斯符号检验。
  • bayesian_signed_rank_test / BayesianSignedRankResult — 在配对差异上带实际等价区域的、带种子 Dirichlet 过程的贝叶斯符号秩检验。
  • vargha_delaney_a12 / interpret_a12 — Vargha-Delaney A12 效应量及其量级标签。
  • bca_bootstrap_interval / BootstrapInterval — 偏差校正与加速的 bootstrap 置信区间。
  • standard_normal_cdf / standard_normal_ppf — 标准正态累积分布与分位数。
  • chi_square_sf — 卡方上尾(生存)概率。
  • detectable_effect_size / required_paired_count / PowerAssessment — 在给定运行次数下可检测的最小标准化配对效应,及其逆运算。
  • ArpdRow / arpd_rows — 以显式出处对照调用方提供的已知最优参考值的、逐求解器平均相对百分比偏差。
  • ensure_equal_budgets — 对按规模缩放的等预算协议的失败关闭校验。

分析方法注册表(失败关闭的方法选择):

  • AnalysisMethod / method_registry / method_by_id — 带其假设和披露下限的命名方法。
  • AnalysisFamily / methods_in_family — 方法族及其成员资格。
  • MethodSupport / evaluate_support — 某方法在给定样本量上的失败关闭支持判定。
  • MethodLimitation — 一个被路由到局限性面的不受支持命名方法。
  • STATISTICAL_POWER_FLOOR — 在其之下功效不足方法即失败关闭的最小样本量。

分析框(图形或表格消费者所渲染的辅助行框与序列框):

  • AnalysisFrames — 一个数据集的辅助框集合。
  • BenchmarkRow / benchmark_rows — 跨求解器领域的逐基准实例覆盖。
  • CharacterizationRow / characterization_rows — 来自观测扩散的逐问题难度描述符。
  • ConstraintRow — 数据集上的一行约束核算。
  • ConvergenceSeries / convergence_series — 按迭代的逐求解器最优目标轨迹。
  • DataProfileSeries / data_profile_series — 为数据剖面图在一个评估组预算内被求解到某个目标精度的逐求解器单元份额。
  • DiversitySeries / diversity_series — 为探索-利用平衡图按迭代的逐求解器种群多样性轨迹。
  • InfeasibleRunRow / infeasible_rows — 被路由到补充材料的不可行已完成运行和已记录失败。
  • OptimalityGapRow / optimality_gap_rows — 相对于参考界的逐 (问题, 求解器) 最优性差距。
  • RobustnessPoint / robustness_points — 为鲁棒性图在目标集上的逐求解器 CVaR + 最坏情况尾部风险。
  • RuntimeQualityPoint / runtime_quality_points — 为运行时-质量图的运行时-质量观测。
  • ScalabilitySeries / scalability_series — 为可扩展性图的逐求解器按实例规模的平均运行时轨迹。
  • SensitivityPoint — 灵敏度扫描的一个参数级均值。
  • StabilityPoint / stability_points — 为稳定性图的逐求解器种子稳定性(平均变异系数)。
  • AblationRow — 相对于完整配置的一项机制隔离结果。

多目标指标:

  • MultiObjectiveIndicatorRow / multiobjective_indicators — 每个求解器的近似前沿对应的四个命名质量指标。
  • MultiObjectiveIndicatorReport / multiobjective_indicator_report — 指标行及其旁边所归档的、产生它们的共享参考点。
  • ReferencePointRule / ReferencePointRecord — 参考点导出规则,以及带其失败关闭出处词汇的归档记录。
  • ensure_shared_reference_points — 失败关闭检查,确认被比较的产物共享一个归档参考点。
  • quality_indicator_method_ids — 此面端到端计算的注册表方法 id。

平台比较(能力与分布距离证据):

  • PlatformComparison / platform_comparison_markdown — 四组平台比较行集及其 Markdown。
  • RivalFrameworkRow / rival_framework_markdown — 相对于竞争框架的能力比较。
  • FeatureRichnessRow / feature_richness_markdown — 特性覆盖矩阵。
  • DistributionDistanceRow / distribution_distance_markdown — 逐基准族的分布距离桥接评估。
  • ArtifactInspectionRow / artifact_inspection_markdown — 门户制品检查证据。
  • EvidenceSource — 一行平台比较的主张是如何得到支持的。

报告脚手架、主张门与编校:

  • ReportScaffold / ReportScaffoldSpec / ReportProfile / ReportSection / CANONICAL_SECTION_ORDER / write_report_scaffold — 确定性、源链接、披露过滤的报告脚手架。
  • ClaimGate / ClaimGateKind / ClaimGateState / ClaimGateOutcome / evaluate_claim_gate — 证据门控的报告主张及其晋升判定。
  • ContributionMatrix / ContributionRow / ContributionOverlap / contribution_partition — 跨证据层的零重叠贡献划分。
  • RedactionFinding / redaction_report / assert_redaction_clean — 扫描候选公共面以查找禁用术语和跨层泄漏。
  • ReproducibilityBadge — 一个可复现性徽章目标,以及制品索引如何满足它。
  • MaintenanceLedgerEntry / maintenance_ledger_markdown — 不得削弱披露边界的未来扩展面。

可复现性清单:

  • ReproducibilityManifest / build_reproducibility_manifest / reproducibility_manifest_markdown — 逐运行的可复现性事实及其 Markdown 文档。
  • FIGURE_GENERATORS — 清单所记录的图形生成器注册表。

求解器术语表(无隐喻命名面):

  • SOLVER_OPERATIONAL_DESCRIPTIONS / solver_operational_description — 每个求解器的无隐喻操作性描述。
  • SOLVER_EQUIVALENCE_NOTES / solver_equivalence_note — 每个求解器的已知算法等价说明。
  • INSPIRATION_DOMAIN_TERMS / metaphor_terms_in — 灵感来源领域术语清单及其检测。

显示名注册表:

  • BENCHMARK_DISPLAY_NAMES / benchmark_display_name — 为基准标识符注册的显示名。
  • SOLVER_DISPLAY_NAMES / solver_display_name — 为求解器标识符注册的显示名。
  • ABLATION_DISPLAY_NAMES / ablation_display_name — 机制隔离消融变体的显示名。
  • benchmark_instance_label — 一个保持实例身份可见的显示标签。
  • UnknownDisplayNameError — 当某标识符没有已注册的显示名时抛出。

证据层:

  • Tier / tier / TIER_REGISTRY — 公共证据层以及每层证据可出现之处。
  • UnknownTierError — 当某层标识符没有注册表条目时抛出。

图形主题:

  • FigureTheme / DEFAULT_THEME — 跨每个图表族共享的、可外部控制的颜色、排版和画布宽度。