dodiscover icon indicating copy to clipboard operation
dodiscover copied to clipboard

Documentation for new users - tutorials and examples

Open adam2392 opened this issue 3 years ago • 1 comments
trafficstars

Reposting from @bloebp and Jaron

https://github.com/cmu-phil/example-causal-datasets for example datasets

The below for real/synthetic datasets used in dowhy.

"You can generate new ones (see the code at the bottom). Otherwise, the notebook uses this: Latencies: https://github.com/py-why/dowhy/blob/main/docs/source/example_notebooks/rca_microservice_architecture_latencies.csv

Supply chain: https://github.com/py-why/dowhy/blob/main/docs/source/example_notebooks/supply_chain_week_over_week.csv"

Proposal

Based on the larger discussion today, we like toy examples into the examples/ directory for communicating core concepts and then tutorials/ for larger more involved code and documentation that works with more complex datasets, such as the above.

What would be nice is to have a tutorial for the key structure learning algorithms that leverage the above two datasets and demonstrates the difference in output.

In addition, it would be nice to have a short sweet example for each core algo.

This Issue is just keeping track of that discussion.

adam2392 avatar Aug 22 '22 16:08 adam2392

Adding some more links:

  • https://py-why.github.io/dowhy/v0.8/example_notebooks/gcm_supply_chain_dist_change.html
  • https://py-why.github.io/dowhy/v0.8/example_notebooks/rca_microservice_architecture.html

adam2392 avatar Aug 22 '22 16:08 adam2392