Simplify quickstart tutorial by removing redundant diagnostic sections#328
Simplify quickstart tutorial by removing redundant diagnostic sections#328
Conversation
Co-authored-by: talgalili <976006+talgalili@users.noreply.github.com>
Co-authored-by: talgalili <976006+talgalili@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Simplifies the balance quickstart tutorial notebook by removing redundant diagnostic content, aiming to streamline the documentation flow for distribution diagnostics and adjustment-method comparison.
Changes:
- Updated the distribution diagnostics section header to include KLD and removed the standalone “Diagnostics for comparing distributions” section.
- Removed the “Compare ASMD” section under “Comparing Adjustment Methods” to avoid duplicating information already present in summaries.
tutorials/balance_quickstart.ipynb
Outdated
| "\n", | ||
| "These diagnostics complement **ASMD**, which only compares means. Use EMD/CVMD/KS when you want to check whether weighting aligns the *shape* of covariate distributions (not just their means).\n" | ||
| "These diagnostics complement **ASMD**, which only compares means. Use EMD/CVMD/KS when you want to check whether weighting aligns the *shape* of covariate distributions (not just their means).\n", | ||
| "" |
There was a problem hiding this comment.
There is an extra empty string entry at the end of the markdown cell source. Consider removing it (or replacing with a newline string if a trailing blank line is intended) to avoid unnecessary notebook diffs/noise and potential formatting quirks in renderers.
There was a problem hiding this comment.
Removed trailing empty strings from both markdown and code cells. Commit: 69ecbca
|
You also need to add And the sentence you removed about asmd not working on the raw catgorical columns can be moved up there as well |
Co-authored-by: talgalili <976006+talgalili@users.noreply.github.com>
Co-authored-by: talgalili <976006+talgalili@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
@talgalili has imported this pull request. If you are a Meta employee, you can view this in D92658641. |
|
@talgalili merged this pull request in 1e4e9f5. |
Simplify quickstart documentation
Summary
Successfully simplified the quickstart tutorial by consolidating distribution diagnostics and addressing all review feedback:
Changes Made:
Removed redundant sections (4 cells removed):
Enhanced distribution diagnostics section:
print(sample_with_target.covars().kld().T)code exampleCode review feedback addressed:
Result: Cleaner tutorial flow with 4 cells removed (75 → 71), all essential information preserved and better organized.
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.