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

Define, document, and assert/test "standard model output format" #67

Open
afmagee42 opened this issue Dec 16, 2024 · 1 comment
Open
Labels
architecture Pipeline engineering, class structures, etc. documentation Improvements or additions to documentation testing/validating Issues related to testing and validation

Comments

@afmagee42
Copy link
Collaborator

          Do you have any validation methods, so that you can check up front that these df's have the schema you expect?

might not be necessary, but it's a few lines of code that can save a lot of headache later

Originally posted by @swo in #51 (comment)

@afmagee42
Copy link
Collaborator Author

I'd propose that we make a

class MultinomialModelOutput(pl.DataFrame):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.validate()

    def validate(self):
        # Do validation here

and then we can

  1. Type-hint returns/inputs for convenience
  2. Cast things to this as needed to get error checking

@afmagee42 afmagee42 added testing/validating Issues related to testing and validation documentation Improvements or additions to documentation architecture Pipeline engineering, class structures, etc. labels Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
architecture Pipeline engineering, class structures, etc. documentation Improvements or additions to documentation testing/validating Issues related to testing and validation
Projects
None yet
Development

No branches or pull requests

1 participant