Merge remote-tracking branch 'origin/main' into 790-a5p-planner-flag

# Conflicts:
#	asap-planner-rs/src/bin/optimizer_cli.rs
#	asap-planner-rs/src/optimizer/milp.rs

Author: milindsrivastava1997

Cargo.lock

@@ -25,7 +25,8 @@ struct Args {
     #[arg(long = "data-ingestion-interval-ms", value_parser = clap::value_parser!(u64).range(1..))]
     data_ingestion_interval_ms: u64,
 
-    /// The flat cost table `export_rqe_optimizer_costs.sh` writes
+    /// The flat cost table sketch-bench's
+    /// `study_saturation.py --phase optimizer-cost` writes
     /// (`rqe_atomic_costs.json`).
     #[arg(long = "atomic-costs")]
     atomic_costs: PathBuf,
@@ -41,10 +42,17 @@ struct Args {
     allow_undeployable_families: bool,
 
     /// YAML workload facts: per metric, positive `value_range` and
-    /// `cardinality` per label set, including all labels (the series count).
+    /// `cardinality` per label set, including all labels (the series count),
+    /// plus the `shape` of each grouping sketches may serve.
     #[arg(long = "workload-facts")]
     workload_facts: PathBuf,
 
+    /// sketch-bench's saturation-study directory (`out_grid_1e7_cost/`,
+    /// `out_1e9/`): sketch accuracy is read off its error-vs-N curves at each
+    /// grouping's `shape`.
+    #[arg(long = "saturation-dir")]
+    saturation_dir: PathBuf,
+
     /// Objective weight on CPU-sec/sec. Default: rqe-optimizer's.
     #[arg(long = "w-cpu", value_parser = parse_weight)]
     w_cpu: Option<f64>,
@@ -87,6 +95,7 @@ fn run_milp(args: &Args, config: &ControllerConfig) -> anyhow::Result<()> {
         &MilpInputs {
             workload_facts: &args.workload_facts,
             atomic_costs: &args.atomic_costs,
+            saturation_dir: &args.saturation_dir,
             scrape_interval_ms: args.data_ingestion_interval_ms,
             w_cpu: args.w_cpu,
             w_mem: args.w_mem,

asap-planner-rs/src/bin/optimizer_cli.rs

@@ -62,15 +62,22 @@ struct Args {
     planner: PlannerArg,
 
     /// MILP only. YAML workload facts: per metric, positive `value_range` and
-    /// `cardinality` per label set, including all labels (the series count).
+    /// `cardinality` per label set, including all labels (the series count),
+    /// plus the `shape` of each grouping sketches may serve.
     #[arg(long = "workload-facts", required_if_eq("planner", "milp"))]
     workload_facts: Option<PathBuf>,
 
-    /// MILP only. The flat cost table `export_rqe_optimizer_costs.sh` writes
+    /// MILP only. The flat cost table sketch-bench's
+    /// `study_saturation.py --phase optimizer-cost` writes
     /// (`rqe_atomic_costs.json`).
     #[arg(long = "atomic-costs", required_if_eq("planner", "milp"))]
     atomic_costs: Option<PathBuf>,
 
+    /// MILP only. sketch-bench's saturation-study directory: sketch accuracy
+    /// is read off its error-vs-N curves at each grouping's `shape`.
+    #[arg(long = "saturation-dir", required_if_eq("planner", "milp"))]
+    saturation_dir: Option<PathBuf>,
+
     /// MILP only. Objective weight on CPU-sec/sec. Default: rqe-optimizer's.
     #[arg(long = "w-cpu", value_parser = parse_weight)]
     w_cpu: Option<f64>,
@@ -117,9 +124,11 @@ fn main() -> anyhow::Result<()> {
     anyhow::ensure!(
         args.workload_facts.is_none()
             && args.atomic_costs.is_none()
+            && args.saturation_dir.is_none()
             && args.w_cpu.is_none()
             && args.w_mem.is_none(),
-        "--workload-facts, --atomic-costs, --w-cpu and --w-mem require --planner milp"
+        "--workload-facts, --atomic-costs, --saturation-dir, --w-cpu and --w-mem require \
+         --planner milp"
     );
 
     match args.query_language {
@@ -251,6 +260,10 @@ fn run_milp(args: &Args) -> anyhow::Result<()> {
                 .atomic_costs
                 .as_deref()
                 .expect("clap requires --atomic-costs with --planner milp"),
+            saturation_dir: args
+                .saturation_dir
+                .as_deref()
+                .expect("clap requires --saturation-dir with --planner milp"),
             scrape_interval_ms,
             w_cpu: args.w_cpu,
             w_mem: args.w_mem,

asap-planner-rs/src/main.rs

@@ -1,12 +1,12 @@
-//! The flat atomic-cost table sketch-bench's `export_rqe_optimizer_costs.sh`
-//! writes for the MILP.
+//! The flat atomic-cost table sketch-bench's
+//! `study_saturation.py --phase optimizer-cost` writes for the MILP.
 
 use std::path::Path;
 
 pub use rqe_optimizer::{AtomicCostEntry, AtomicCostTable};
 
-/// Load the flat cost table `export_rqe_optimizer_costs.sh` writes, for the
-/// MILP. An invalid row is an error, not dropped.
+/// Load the flat cost table `study_saturation.py --phase optimizer-cost`
+/// writes, for the MILP. An invalid row is an error, not dropped.
 pub fn load_flat_atomic_cost_table(path: &Path) -> anyhow::Result<AtomicCostTable> {
     let raw = std::fs::read_to_string(path)
         .map_err(|e| anyhow::anyhow!("reading cost table {}: {e}", path.display()))?;
@@ -37,6 +37,21 @@ fn valid_cost_entry(entry: &AtomicCostEntry) -> bool {
     .all(|cost| cost.is_finite() && *cost >= 0.0)
 }
 
+/// A cost row's required `measured_at`, for test fixtures: the cost table's
+/// shape (sketch-bench `study_saturation.py` COST_*). Generic so the
+/// fixture needn't name `aqpbm_core::MeasuredAt`.
+#[cfg(test)]
+pub(crate) fn test_measured_at<T: serde::de::DeserializeOwned>() -> T {
+    serde_json::from_value(serde_json::json!({
+        "items_per_instance": 1_000_000,
+        "keys_per_instance": 10_000,
+        "value_range": null,
+        "merge_operand_items": null,
+        "distribution": null,
+    }))
+    .expect("MeasuredAt fixture")
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
@@ -51,7 +66,7 @@ mod tests {
     fn flat_loader_rejects_non_finite_or_negative_costs() {
         let row = |insert: &str| {
             format!(
-                r#"{{"sketch":"hll","sketch_config":null,"mem_bytes_per_instance":1.0,"insert_cpu_secs":{insert},"merge_cpu_secs":1.0,"query_cpu_secs":1.0,"query_accuracy":{{}}}}"#
+                r#"{{"sketch":"hll","sketch_config":null,"mem_bytes_per_instance":1.0,"insert_cpu_secs":{insert},"merge_cpu_secs":1.0,"query_cpu_secs":1.0,"query_accuracy":{{"relative_error":0.0}},"accuracy_metric":"relative_error","measured_at":{{"items_per_instance":1000000,"keys_per_instance":10000,"value_range":null,"merge_operand_items":null,"distribution":null}}}}"#
             )
         };
         let file = tempfile::NamedTempFile::new().unwrap();
@@ -62,16 +77,21 @@ mod tests {
         assert!(err.to_string().contains("negative"), "{err}");
     }
 
-    /// Rows with `measured_at` load, and older rows without it still do.
+    /// Rows name their accuracy metric and where they were measured; a row
+    /// without either is an old table, rejected rather than guessed.
     #[test]
-    fn atomic_cost_entry_accepts_optional_measured_at() {
-        let base = r#""sketch":"kll-percall","sketch_config":null,"mem_bytes_per_instance":1.0,"insert_cpu_secs":1.0,"merge_cpu_secs":1.0,"query_cpu_secs":1.0,"query_accuracy":{}"#;
-        let with = format!(
-            r#"{{{base},"measured_at":{{"items_per_instance":1000000,"keys_per_instance":100000,"value_range":[1.0,100000.0],"merge_operand_items":62500,"distribution":{{"kind":"zipf","skewness":1.1,"population_size":100000,"seed":42}}}}}}"#
-        );
-        let entry: AtomicCostEntry = serde_json::from_str(&with).unwrap();
-        assert_eq!(entry.measured_at.unwrap().items_per_instance, 1_000_000);
-        let without: AtomicCostEntry = serde_json::from_str(&format!("{{{base}}}")).unwrap();
-        assert!(without.measured_at.is_none());
+    fn atomic_cost_entry_requires_accuracy_metric_and_measured_at() {
+        let base = r#""sketch":"kll-percall","sketch_config":null,"mem_bytes_per_instance":1.0,"insert_cpu_secs":1.0,"merge_cpu_secs":1.0,"query_cpu_secs":1.0,"query_accuracy":{"mean_rank_err":0.01}"#;
+        let measured_at = r#""measured_at":{"items_per_instance":1000000,"keys_per_instance":null,"value_range":null,"merge_operand_items":62500,"distribution":{"kind":"pareto","alpha":2.0,"scale":1000.0,"seed":42}}"#;
+        let full = format!(r#"{{{base},"accuracy_metric":"mean_rank_err",{measured_at}}}"#);
+        let entry: AtomicCostEntry = serde_json::from_str(&full).unwrap();
+        assert_eq!(entry.measured_at.items_per_instance, 1_000_000);
+        assert_eq!(entry.accuracy(), Some(0.01));
+        for partial in [
+            format!(r#"{{{base},{measured_at}}}"#),
+            format!(r#"{{{base},"accuracy_metric":"mean_rank_err"}}"#),
+        ] {
+            assert!(serde_json::from_str::<AtomicCostEntry>(&partial).is_err());
+        }
     }
 }