[ENH] censoring indicator conventions #677
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add comprehensive documentation of censoring indicator conventions used across lifelines, scikit-survival, and ngboost adapters. Clarifies: - skpro convention: C=0 (uncensored), C=1 (censored) - lifelines: event_col=1 (uncensored), event_col=0 (censored) - scikit-survival: delta=True (uncensored), delta=False (censored) - ngboost: E=1 (uncensored), E=0 (censored) All existing transformations are confirmed to be correct. All external packages use the same opposite convention to skpro.
Add detailed comments and docstring updates to clarify the censoring indicator conventions for issue sktime#313. Changes: - Add explicit transformation comments in lifelines adapter - Add explicit transformation comments in scikit-survival adapter - Add explicit transformation comments in ngboost adapter - Update docstrings to document the convention conversions All adapters correctly translate between: - skpro: C=0 (uncensored), C=1 (censored) - lifelines: event_col=1 (uncensored), event_col=0 (censored) - scikit-survival: delta=True (uncensored), delta=False (censored) - ngboost: E=1 (uncensored), E=0 (censored)
Add detailed summary documenting: - Issue investigation and findings - Verification of all three adapters (lifelines, scikit-survival, ngboost) - Confirmation that all implementations are correct - Documentation and code enhancements made - Verification steps performed All censoring indicator translations are correct and now well-documented to prevent future confusion.
arnavk23
requested review from
SaiRevanth25,
felipeangelimvieira and
fkiraly
as code owners
fkiraly
requested changes
Dec 11, 2025
Collaborator
fkiraly
left a comment
fkiraly
left a comment
There was a problem hiding this comment.
Thanks for checking!
There is no need to change the comments in the code though if they are complete and correct?
fkiraly
added
documentation
Refactor censoring indicator conversion for clarity.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reference Issues/PRs
Fixes #313 by double checking and adding comments in the private function docstring
What does this implement/fix? Explain your changes.
Add comprehensive documentation of censoring indicator conventions
used across lifelines, scikit-survival, and ngboost adapters.
Clarifies:
All existing transformations are confirmed to be correct.
All external packages use the same opposite convention to skpro.
Does your contribution introduce a new dependency? If yes, which one?
What should a reviewer concentrate their feedback on?
Did you add any tests for the change?
Any other comments?
PR checklist
For all contributions
How to: add yourself to the all-contributors file in the
skproroot directory (not theCONTRIBUTORS.md). Common badges:code- fixing a bug, or adding code logic.doc- writing or improving documentation or docstrings.bug- reporting or diagnosing a bug (get this pluscodeif you also fixed the bug in the PR).maintenance- CI, test framework, release.See here for full badge reference
For new estimators
docs/source/api_reference/taskname.rst, follow the pattern.Examplessection.python_dependenciestag and ensureddependency isolation, see the estimator dependencies guide.