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

Initial setup, porting/adapting model code from flusion-experiments #1

Merged
merged 7 commits into from
Nov 7, 2024

Conversation

elray1
Copy link
Contributor

@elray1 elray1 commented Nov 7, 2024

This PR does the following:

  • Initial package setup with things like the readme and pyproject.toml.
  • move modeling code for sarix and gbqr over from flusion-experiments
  • adapt that code to be organized around two classes: sarix.SARIXModel and gbqr.GBQRModel.
    • For now, each takes a config object with model settings on instantiation, and has a run method that takes another config object with model run settings.
    • I'm thinking that in this package, it likely makes sense to just have them accept a bunch of named keyword arguments rather than the config objects. To do later.
  • Add some integration tests.
    • SARIX model runs are reproducible on different machines, so that test should pass everywhere.
    • GBQR model runs are not reproducible. That test asserts equality of a data frame, and I expect it to pass only on my computer. Automated tests run by github actions fail for that reason.
    • There is an R script in there that can be used to confirm that the expected test data looks plausible; it generates this plot:
      image

@elray1
Copy link
Contributor Author

elray1 commented Nov 7, 2024

Noting that tests pass locally on my machine, with a bunch of warnings related to deprecated pandas functionality.

============================================== 3 passed, 21 warnings in 88.84s (0:01:28) ===============================================

Copy link
Member

@matthewcornell matthewcornell left a comment

Choose a reason for hiding this comment

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

approved via live review

@elray1 elray1 merged commit b08602e into main Nov 7, 2024
1 check failed
@elray1 elray1 deleted the init_setup branch November 7, 2024 21:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants