Refactor installation guide and documentation references for clarity #52
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
- Added documentation for BlockInvGPFA class. - Updated configuration files to reflect the new BlockInvGPFA project name. - Modified contribution guidelines to refer to BlockInvGPFA. - Removed outdated GPFA class documentation. - Updated index and examples to use BlockInvGPFA terminology. - Revised installation instructions for BlockInvGPFA. - Updated neural example notebook to distinguish betweenGPFA model and BlockInvGPFA usage. - Adjusted preprocessing documentation to reference BlockInvGPFA. - Remaned GPFA unit tests to BlockInvGPFA. - Updated preprocessing tests to import from BlockInvGPFA.
jdrugo
approved these changes
May 12, 2025
Collaborator
jdrugo
left a comment
jdrugo
left a comment
There was a problem hiding this comment.
I don't have time at the moment to go through all the changes in detail, but from a quick skim, the changes look good to me.
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 PR updates the installation guide and documentation formatting to reflect BlockInvGPFA implementation.
Changes Included
Clarified Package Identity
Reworded sections to emphasize that this is a documented implementation of GPFA called
BlockInvGPFAEnsured users are oriented between model theory (GPFA) and implementation (BlockInvGPFA)
Updated Installation Instructions
pip install .with optional extras[test]and[docs]