Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revised documentation #1087

Merged
merged 1 commit into from
Dec 1, 2023
Merged

Revised documentation #1087

merged 1 commit into from
Dec 1, 2023

Conversation

bloebp
Copy link
Member

@bloebp bloebp commented Nov 26, 2023

  • Slightly update and revise existing GCM notebooks
  • Moving mediation analysis, direct arrow strength and ICC to their own "Quantify Causal Influence" section
  • Adding brief overview to describe differences between the quantification methods
  • Change navigation image to reflect newest changes
  • Adding related notebooks links to some of the causal task entries
  • Adding a direct arrow strength example to the ICC notebook
  • Adding a brief overview of the available root cause analysis and explanation methods
  • Smaller revision of other GCM entries, such as the basic example
  • Smaller typos and missing reference fixes

New user guide image:
Screenshot 2023-11-28 at 08 52 50

@bloebp
Copy link
Member Author

bloebp commented Nov 26, 2023

@amit-sharma I noticed that 'effect_estimation_with_estimators.rst' is not referenced in the main overview. It also has some overlap with other entries. Is this a left over from the previous documentation change or did we miss listing it explicitly?

@bloebp bloebp force-pushed the revise_documentation branch 3 times, most recently from 170bc2e to 5d30a4e Compare November 29, 2023 18:09
- Slightly update and revise existing GCM notebooks
- Moving mediation analysis, direct arrow strength and ICC to their own "Quantify Causal Influence" section
- Adding brief overview to describe differences between the quantification methods
- Change navigation image to reflect newest changes
- Adding related notebooks links to some of the causal task entries
- Adding a direct arrow strength example to the ICC notebook
- Adding a brief overview of the available root cause analysis and explanation methods
- Smaller revision of other GCM entries, such as the basic example
- Smaller typos and missing refernce fixes

Signed-off-by: Patrick Bloebaum <bloebp@amazon.com>
@bloebp bloebp force-pushed the revise_documentation branch from 5d30a4e to 1a3af8e Compare November 29, 2023 18:12
Copy link
Member

@amit-sharma amit-sharma left a comment

Choose a reason for hiding this comment

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

Thanks for these changes @bloebp . I think there are a lot of clarifying changes and overall they will make the documentation stronger.

@bloebp bloebp merged commit 9ebf9e3 into main Dec 1, 2023
30 checks passed
@bloebp bloebp deleted the revise_documentation branch December 1, 2023 14:58
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