Skip to content

9. Documentation: what changed, how the weighting was chosen - #9

Merged
dadudu13 merged 2 commits into
mainfrom
pr/9-docs
Oct 21, 2026
Merged

dadudu13 merged 2 commits into
mainfrom
pr/9-docs

Conversation

@dadudu13

Copy link
Copy Markdown
Owner
  • README.md: what the fork is for, the foundation fixes, the opt-in modifications and their switches, install, a minimal example, and how the history is organised.
  • docs/modifications.md: each change's problem, change, switch and test; how the landmark weighting was chosen, with a synthetic reproduction anyone can rerun; and the experiment that was tried and not adopted (kept on experiments/all-landmark-rank) and why.
  • evaluation/README.md: data layout, workflow, exact metric definitions, comparing against an existing score, and which outputs are patient-level.
  • LICENSE: the original MIT notice plus a line for the modifications.

docs/modifications.md walks through the changes in the order they were
made: what was wrong or missing, what changed, which argument switches it
and what its default does, and how it was checked. For the landmark
weighting it also records how the weighting was chosen, with a synthetic
reproduction of the first-visit effect that anyone can rerun. It ends
with the one experiment kept on an experiments/* branch and why it was
not merged.

LICENSE keeps the original MIT notice and adds a copyright line for the
modifications.
The README now says what the fork is for (landmark prediction from
irregular visits with a competing risk), lists the foundation fixes and the
opt-in modifications with their switches, gives the install recipe CI uses
and a minimal API example, and explains how the history is organised.

evaluation/README.md documents the data layout and column mapping, the
train -> apply -> evaluate -> ablation workflow on the synthetic cohort, the
exact metric definitions, how to compare against an existing score, and
which outputs are patient-level and must stay with the data.
@dadudu13
dadudu13 changed the base branch from pr/8-evaluation to main October 21, 2026 20:37
@dadudu13
dadudu13 merged commit 4e98de6 into main Oct 21, 2026
4 checks passed
@dadudu13
dadudu13 deleted the pr/9-docs branch October 21, 2026 20:37
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.

1 participant