uber / causalml

Uplift modeling and causal inference with machine learning algorithms
Other
5.08k stars 780 forks source link

Consider ordering of examples for new users #664

Closed ras44 closed 1 year ago

ras44 commented 1 year ago

Is your feature request related to a problem? Please describe. The notebooks in examples/ are currently listed alphabetically. Would it benefit to order them somehow for new users who are getting started?

Looking at the examples/ files alphabetically with their first commit timestamp:

examples/benchmark_simulation_studies.ipynb
Date:   Mon Dec 13 18:32:00 2021 -0800

examples/binary_policy_learner_example.ipynb
Date:   Mon Feb 1 09:57:06 2021 -0800

examples/causal_trees_interpretation.ipynb
Date:   Mon Aug 22 22:19:51 2022 +0300

examples/causal_trees_with_synthetic_data.ipynb
Date:   Sun Aug 21 03:47:09 2022 +0300

examples/cevae_example.ipynb
Date:   Mon Feb 1 12:42:04 2021 -0800

examples/counterfactual_unit_selection.ipynb
Date:   Tue Jul 14 04:22:37 2020 +0200

examples/counterfactual_value_optimization.ipynb
Date:   Tue Jul 14 04:21:18 2020 +0200

examples/dr_learner_with_synthetic_data.ipynb
Date:   Mon Feb 1 09:57:06 2021 -0800

examples/dragonnet_example.ipynb
Date:   Tue Feb 18 12:26:34 2020 -0800

examples/feature_interpretations_example.ipynb
Date:   Mon Oct 7 14:25:40 2019 -0700

examples/feature_selection.ipynb
Date:   Tue Aug 4 10:28:07 2020 -0700

examples/iv_nlsym_synthetic_data.ipynb
Date:   Mon Jun 22 20:26:14 2020 -0700

examples/meta_learners_with_synthetic_data.ipynb
Date:   Wed Jul 17 10:51:27 2019 -0700

examples/meta_learners_with_synthetic_data_multiple_treatment.ipynb
Date:   Tue Aug 27 10:14:34 2019 -0700

examples/necessary_and_sufficient.ipynb
Date:   Sun Mar 6 14:05:48 2022 -0800

examples/sensitivity_example_with_synthetic_data.ipynb
Date:   Wed Jun 24 11:33:31 2020 -0700

examples/uplift_tree_visualization.ipynb
Date:   Mon Sep 30 11:47:49 2019 -0700

examples/uplift_trees_with_synthetic_data.ipynb
Date:   Mon Jul 22 16:07:40 2019 +0200

examples/validation_with_tmle.ipynb
Date:   Wed Nov 13 14:06:21 2019 -0800

Describe the solution you'd like

An ordering that gives new users an idea of where to start (most basic functionality first):

examples/001_meta_learners_with_synthetic_data.ipynb
Date:   Wed Jul 17 10:51:27 2019 -0700

examples/002_uplift_trees_with_synthetic_data.ipynb
Date:   Mon Jul 22 16:07:40 2019 +0200

examples/003_meta_learners_with_synthetic_data_multiple_treatment.ipynb
Date:   Tue Aug 27 10:14:34 2019 -0700

examples/004_uplift_tree_visualization.ipynb
Date:   Mon Sep 30 11:47:49 2019 -0700

examples/005_feature_interpretations_example.ipynb
Date:   Mon Oct 7 14:25:40 2019 -0700

examples/006_validation_with_tmle.ipynb
Date:   Wed Nov 13 14:06:21 2019 -0800

examples/007_dragonnet_example.ipynb
Date:   Tue Feb 18 12:26:34 2020 -0800

examples/008_iv_nlsym_synthetic_data.ipynb
Date:   Mon Jun 22 20:26:14 2020 -0700

examples/009_sensitivity_example_with_synthetic_data.ipynb
Date:   Wed Jun 24 11:33:31 2020 -0700

examples/010_counterfactual_unit_selection.ipynb
Date:   Tue Jul 14 04:22:37 2020 +0200

examples/011_counterfactual_value_optimization.ipynb
Date:   Tue Jul 14 04:21:18 2020 +0200

examples/012_feature_selection.ipynb
Date:   Tue Aug 4 10:28:07 2020 -0700

examples/013_binary_policy_learner_example.ipynb
Date:   Mon Feb 1 09:57:06 2021 -0800

examples/014_cevae_example.ipynb
Date:   Mon Feb 1 12:42:04 2021 -0800

examples/015_dr_learner_with_synthetic_data.ipynb
Date:   Mon Feb 1 09:57:06 2021 -0800

examples/016_benchmark_simulation_studies.ipynb
Date:   Mon Dec 13 18:32:00 2021 -0800

examples/017_necessary_and_sufficient.ipynb
Date:   Sun Mar 6 14:05:48 2022 -0800

examples/018_causal_trees_with_synthetic_data.ipynb
Date:   Sun Aug 21 03:47:09 2022 +0300

examples/019_causal_trees_interpretation.ipynb
Date:   Mon Aug 22 22:19:51 2022 +0300

Describe alternatives you've considered Alternative orderings welcome, but the main idea is to make it easier for a new user to walk through progressively complex functionality.

Additional context Add any other context or screenshots about the feature request here.

vincewu51 commented 1 year ago

Good call. The notebook needs some update too. I'll go through them.

ras44 commented 1 year ago

@jeongyoonlee had a good point that numerical ordering could run into issues and that it may make more sense to reference the examples in order via a readme/documentation. I will close under that assumption 👍