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

Update documentation on SeriesIDLoader + Add validation parameter non-equal DS lengths #753

Open
4 tasks
isaacmg opened this issue May 22, 2024 · 0 comments
Open
4 tasks
Labels
documentation Improvements or additions to documentation

Comments

@isaacmg
Copy link
Collaborator

isaacmg commented May 22, 2024

The CSVSeriesIDLoader and SeriesIDTestLoader are still fairly poorly documented and missing relevant code for experiments. By default right now users must have datasets of equal lengths in order to proceed, however there are some cases where this might not be wanted. For instance, now I'm training a large flow foundational model and the un-equal lengths are a given. Therefore this PR will do the following things:

  • Update CSVSeriesIDLoader doc-strings to be more descriptive of functionality.
  • Update Confluence documentation on the supported uses/ideas behind SeriesIDLoader
  • Add parameter called validation that makes it optional to validate that datasets are the same length.
  • Test this out in the training foundational river flow notebook.
@isaacmg isaacmg added the documentation Improvements or additions to documentation label May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant