Skip to content

cmudrc/design-research-experiments

Repository files navigation

design-research-experiments

CI Docs

Important

Current monthly release: Apollo Ascent - April 2026
Due: April 1, 2026
Tracks: March 2026 work

design-research-experiments is the hypothesis-first study-definition and experiment-orchestration layer in the cmudrc design research ecosystem.

It composes sibling libraries rather than reimplementing them:

  • design-research-agents for executable agent behavior, workflows, and traces
  • design-research-problems for problem catalogs, registries, and evaluators
  • design-research-analysis for downstream unified-table analysis and reporting

Overview

This package centers on reproducible experiment structure and execution:

  • typed schemas for studies, factors, blocks, hypotheses, outcomes, and analysis plans
  • design-of-experiments materialization (full/constrained factorial, randomized block, repeated measures, latin square, custom matrices)
  • run orchestration with deterministic seeding, checkpointing, and resume support
  • canonical artifact exports (study.yaml, manifest.json, conditions.csv, runs.csv, events.csv, evaluations.csv, and machine-readable hypothesis/plan files)
  • thin adapters that connect to the public APIs of sibling agent/problem/analysis libraries

Quickstart

Requires Python 3.12+. Reproducible release installs are pinned to Python 3.12.12 (.python-version).

python -m venv .venv
source .venv/bin/activate
make dev
make test

Run a basic example:

make run-example

CLI

The package installs a drexp CLI:

drexp validate-study path/to/study.yaml
drexp materialize-design path/to/study.yaml
drexp generate-doe --kind lhs --factors-json '{"x": [0, 1], "y": [10, 20]}' --n-samples 12 --out artifacts/doe.csv
drexp run-study path/to/study.yaml
drexp resume-study path/to/study.yaml
drexp export-analysis path/to/study.yaml
drexp bundle-results path/to/output_dir

Examples

See examples/README.md for runnable scripts, including end-to-end recipe executions.

Docs

See the published documentation for guides and API reference.

Build docs locally with:

make docs

Public API

Top-level exports are intentionally small:

  • Study, Factor, Level, Constraint, Condition, Block
  • RecipeStudyConfig, recipe-specific typed config classes
  • Hypothesis, OutcomeSpec, AnalysisPlan
  • RunSpec, RunResult, BenchmarkBundle
  • build_design, generate_doe, materialize_conditions
  • build_prompt_framing_study, build_optimization_benchmark_study, and other recipe builders
  • run_study, resume_study
  • export_analysis_tables, validate_study

Contributing

Contribution workflow and quality gates are documented in CONTRIBUTING.md.

About

A hypothesis-first framework for computational experiments

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors