Skip to content

docs(paper): clarify local estimator API in Software Design - #131

Merged
TomeHirata merged 1 commit into
mainfrom
docs/paper-joss-review-updates
Aug 20, 2026
Merged

docs(paper): clarify local estimator API in Software Design#131
TomeHirata merged 1 commit into
mainfrom
docs/paper-joss-review-updates

Conversation

@TomeHirata

Copy link
Copy Markdown
Collaborator

Summary

  • The Software Design section of paper/paper.md currently states that "all estimators implement a consistent API with three primary methods" (predict_dte, predict_pte, predict_qte).
  • The local estimators (SimpleLocalDistributionEstimator, AdjustedLocalDistributionEstimator) do not use those methods for their intended estimand — they expose predict_ldte() and predict_lpte() for the imperfect-compliance setting.
  • Split the API description into two sentences so the paper accurately reflects the code.

Test plan

  • Re-render the JOSS paper and confirm the Software Design section reads cleanly.

🤖 Generated with Claude Code

Local estimators do not share predict_dte/predict_pte/predict_qte with the
other estimators; they expose predict_ldte/predict_lpte for the
imperfect-compliance setting. Split the API description accordingly.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings August 20, 2026 06:03

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@TomeHirata
TomeHirata merged commit 285c66e into main Aug 20, 2026
10 checks passed
@TomeHirata
TomeHirata deleted the docs/paper-joss-review-updates branch August 20, 2026 06:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants