Add docstring to ParametricUMAP placeholder class for better documentation#1276
Draft
Lang-Qiu wants to merge 1 commit into
Draft
Add docstring to ParametricUMAP placeholder class for better documentation#1276Lang-Qiu wants to merge 1 commit into
Lang-Qiu wants to merge 1 commit into
Conversation
lmcinnes
approved these changes
Jun 6, 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.
Problem
The
ParametricUMAPclass inumap/__init__.py, which serves as a placeholder when TensorFlow is not installed, was missing a docstring. This reduced code readability and made it harder for users to understand its purpose and error handling.Solution
Added a comprehensive docstring to the
ParametricUMAPclass. The docstring includes:load_ParametricUMAP) for better discoverability.Verification
__init__.pyfile to confirm the docstring is present and correctly formatted.python -m pytestin the repository).ImportErrorwhen instantiated without TensorFlow.