Skip to content

Conversation

@IyarLin
Copy link
Contributor

@IyarLin IyarLin commented Aug 25, 2025

Proposed changes

This PR adds the ability to benchmark causal inference algorithms on specific datasets of interest by implementing the approach outlined at "Schuler, A., Jung, K., Tibshirani, R., Hastie, T., and Shah, N. Synth-validation: Selecting the best causal inference method for a given dataset (2017)" https://arxiv.org/pdf/1711.00083

Usage of this functionality is demonstrated in docs/examples/benchmark_semi_synthetic_simulation_studies.ipynb

I've built the docs locally.

Types of changes

What types of changes does your code introduce to CausalML?
Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the CONTRIBUTING doc
  • I have signed the CLA
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc. This PR template is adopted from appium.

Copy link
Collaborator

@ras44 ras44 left a comment

Choose a reason for hiding this comment

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

might want to update the docs, specifically docs/examples/ to include this new contribution- thanks!

@IyarLin
Copy link
Contributor Author

IyarLin commented Sep 5, 2025

@ras44 I have added a notebook demonstrating the added functionality at docs/examples/benchmark_semi_synthetic_simulation_studies.ipynb

I've also built the docs locally though I didn't see it added anything to the PR.

If I'm still missing some docs please let me know how to add those as I didn't find anything under the contribution guidelines.

Thanks!

@jeongyoonlee
Copy link
Collaborator

Thanks for the contribution, @IyarLin. You can add the link to your notebook to docs/examples.rst to show it on the documentation website.

@IyarLin IyarLin requested a review from ras44 September 7, 2025 06:13
@IyarLin
Copy link
Contributor Author

IyarLin commented Sep 9, 2025

@jeongyoonlee @ras44 I've added the notebook demonstrating the added functionality to docs/examples.rst
Let me know if there's anything else missing

Copy link
Collaborator

@ras44 ras44 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for your contribution 👍

@ras44 ras44 changed the title done add ability to benchmark via synth validation Sep 9, 2025
@jeongyoonlee jeongyoonlee merged commit de4dcfc into uber:master Sep 12, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants