Commit 1e4e9f5
Simplify quickstart tutorial by removing redundant diagnostic sections (#328)
Summary:
## Simplify quickstart documentation
- [x] Remove "Diagnostics for comparing distributions" section (cells 29-30)
- [x] Update "Distribution diagnostics (EMD/CVMD/KS)" section title to include "KLD" (cell 27)
- [x] Remove "Compare ASMD (Absolute Standardized Mean Difference)" section (cells 67-68) from "Comparing Adjustment Methods"
- [x] Fix capitalization of KLD to match other diagnostic abbreviations (EMD, CVMD, KS)
- [x] Add KLD description to distribution diagnostics section
- [x] Add kld() code example to distribution diagnostics section
- [x] Include note about raw covariates applying to all diagnostics
- [x] Clarify KLD is a divergence measure (not symmetric distance)
- [x] Remove trailing empty strings from cells
- [x] Run code review and address all feedback
- [x] Run security checks
- [x] Reply to all review comments
Successfully simplified the quickstart tutorial by consolidating distribution diagnostics and addressing all review feedback:
### Changes Made:
1. **Removed redundant sections** (4 cells removed):
- "Diagnostics for comparing distributions" section (cells 29-30)
- "Compare ASMD" section from "Comparing Adjustment Methods" (cells 67-68)
2. **Enhanced distribution diagnostics section**:
- Added KLD to section header: "Distribution diagnostics (KLD/EMD/CVMD/KS)"
- Added KLD description with clarification that it's a divergence measure (non-symmetric)
- Added `print(sample_with_target.covars().kld().T)` code example
- Moved note about raw covariates to separate paragraph applying to all diagnostics
- Removed trailing empty strings for cleaner notebook formatting
3. **Code review feedback addressed**:
- Separated note about raw covariates from KLD bullet to apply to all metrics
- Clarified KLD is a divergence measure vs distance metric
- Cleaned up formatting issues
**Result**: Cleaner tutorial flow with 4 cells removed (75 → 71), all essential information preserved and better organized.
<details>
<summary>Original prompt</summary>
>
> ----
>
> *This section details on the original issue you should resolve*
>
> <issue_title>[BUG] Simplify quick start further</issue_title>
> <issue_description>Fix this:
> https://import-balance.org/docs/tutorials/quickstart/
>
> Remove the section
> 'Diagnostics for comparing distributions'
> But add the the previous section kld:
> "Distribution diagnostics (EMD/CVMD/KS)"
>
> And remove the section
> "Compare ASMD (Absolute Standardized Mean Difference)"
> From the section "Comparing Adjustment Methods"
> </issue_description>
>
> ## Comments on the Issue (you are copilot in this section)
>
> <comments>
> </comments>
>
</details>
- Fixes #327
---
💡 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](https://gh.io/copilot-coding-agent-tips) in the docs.
Pull Request resolved: #328
Differential Revision: D92658641
Pulled By: talgalili
fbshipit-source-id: 60e8e34358d1cbb940a7cb3af8d6b225a2e362261 parent 9810a9f commit 1e4e9f5
1 file changed
+8
-50
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
419 | 419 | | |
420 | 420 | | |
421 | 421 | | |
422 | | - | |
| 422 | + | |
423 | 423 | | |
424 | | - | |
| 424 | + | |
425 | 425 | | |
426 | 426 | | |
| 427 | + | |
| 428 | + | |
427 | 429 | | |
428 | 430 | | |
429 | 431 | | |
430 | 432 | | |
431 | 433 | | |
432 | 434 | | |
433 | 435 | | |
434 | | - | |
| 436 | + | |
| 437 | + | |
| 438 | + | |
435 | 439 | | |
436 | 440 | | |
437 | 441 | | |
| |||
440 | 444 | | |
441 | 445 | | |
442 | 446 | | |
| 447 | + | |
443 | 448 | | |
444 | 449 | | |
445 | 450 | | |
446 | 451 | | |
447 | 452 | | |
448 | | - | |
449 | | - | |
450 | | - | |
451 | | - | |
452 | | - | |
453 | | - | |
454 | | - | |
455 | | - | |
456 | | - | |
457 | | - | |
458 | | - | |
459 | | - | |
460 | | - | |
461 | | - | |
462 | | - | |
463 | | - | |
464 | | - | |
465 | | - | |
466 | | - | |
467 | 453 | | |
468 | 454 | | |
469 | 455 | | |
| |||
947 | 933 | | |
948 | 934 | | |
949 | 935 | | |
950 | | - | |
951 | | - | |
952 | | - | |
953 | | - | |
954 | | - | |
955 | | - | |
956 | | - | |
957 | | - | |
958 | | - | |
959 | | - | |
960 | | - | |
961 | | - | |
962 | | - | |
963 | | - | |
964 | | - | |
965 | | - | |
966 | | - | |
967 | | - | |
968 | | - | |
969 | | - | |
970 | | - | |
971 | | - | |
972 | | - | |
973 | | - | |
974 | | - | |
975 | | - | |
976 | | - | |
977 | | - | |
978 | 936 | | |
979 | 937 | | |
980 | 938 | | |
| |||
0 commit comments