Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor Ensemble Functions & Change Ensemble APIs #61

Merged
merged 28 commits into from
Sep 8, 2023

Conversation

michaelmckinsey1
Copy link
Collaborator

@michaelmckinsey1 michaelmckinsey1 commented Jul 11, 2023

Summary

thicket.py is becoming quite unwieldy so this refactor is in an effort to improve readability, maintainability and usability.

  1. API name changes. Old API now errors.
    • Thicket.columnar_join -> Thicket.concat_thickets(axis="columns")
    • Thicket.unify_ensemble -> Thicket.concat_thickets(axis="index")
  2. 3 separate unify functions now made into 1 function, _unify.
  3. Functions are now hidden away from the user and in Thicket we only expose the functions we want to be user facing.
  4. Refactoring of sub-functions.

We should consider doing something similar for the filter functions, etc.

@michaelmckinsey1 michaelmckinsey1 added area-thicket Issues and PRs involving Thicket's core Thicket datastructure and associated classes priority-normal Normal priority issues and PRs status-work-in-progress PR is currently being worked on type-internal-cleanup PRs or Issues related to the structure of the codebase, directories, and refactors labels Jul 12, 2023
@michaelmckinsey1 michaelmckinsey1 changed the title Refactor Ensemble Functions Refactor Ensemble Functions & Change Ensemble APIs Aug 3, 2023
@michaelmckinsey1 michaelmckinsey1 marked this pull request as ready for review August 3, 2023 17:08
@michaelmckinsey1 michaelmckinsey1 added status-ready-for-review This PR is ready to be reviewed by assigned reviewers and removed status-work-in-progress PR is currently being worked on labels Aug 3, 2023
Copy link
Collaborator

@cscully-allison cscully-allison left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR looks pretty good, just one small comment.

@slabasan slabasan added this to the 2023.3.0 milestone Aug 25, 2023
@slabasan
Copy link
Collaborator

@vanessalama09 This PR is making changes to the tutorial notebooks, but to the rendered ones in the thicket source. How would you like to get these changes over into the thicket-docs version?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes should be in thicket-tutorial, and then rendered here

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes to notebooks should be in thicket-tutorial, then rendered here

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@slabasan
Copy link
Collaborator

slabasan commented Sep 6, 2023

@michaelmckinsey1 Can you please rebase this branch on top of develop to fix the conflict?

@vanessalama09
Copy link
Contributor

@vanessalama09 This PR is making changes to the tutorial notebooks, but to the rendered ones in the thicket source. How would you like to get these changes over into the thicket-docs version?

Thicket-docs are in thicket source. The rendered versions are the ones in docs. Did you mean over to thicket-tutorial?

@slabasan slabasan merged commit 445aa83 into LLNL:develop Sep 8, 2023
2 checks passed
@michaelmckinsey1 michaelmckinsey1 deleted the refactor-ensemble-code branch September 8, 2023 18:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-thicket Issues and PRs involving Thicket's core Thicket datastructure and associated classes priority-normal Normal priority issues and PRs status-ready-for-review This PR is ready to be reviewed by assigned reviewers type-internal-cleanup PRs or Issues related to the structure of the codebase, directories, and refactors
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants