Merged
Conversation
Collaborator
Author
|
change pauls email to the correct one in the about.rst and .toml |
joshuasteier
approved these changes
Mar 13, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request significantly improves and expands the PyHealth documentation, providing clearer explanations, practical usage guidance, and new sections for key components. The updates aim to make it much easier for users—especially newcomers—to understand how to load data, define tasks, work with models, and use knowledge graphs in the PyHealth ecosystem.
Major documentation improvements:
General usage and data loading:
BaseDatasetandSampleDataset, initialization parameters, how to use custom YAML schemas, and common pitfalls for new users.Tasks and customization:
BaseTask, specifying input/output schemas, processor string keys, and howset_task()works with multiprocessing.Models and architecture:
BaseModelandEmbeddingModelclasses; detailed task modes and loss functions; and included a template for building custom models.Knowledge graph support:
pyhealth.graphmodule, covering what knowledge graphs are, how to construct and explore them, how to extract patient subgraphs, integration with tasks, and support for pre-computed node embeddings.