tsauditor currently lacks tutorials, and the existing example notebooks are sparse. This makes it difficult for new users to understand how to use the library and for potential contributors to get oriented.
What's Needed:
A minimal end-to-end notebook: load a sample/synthetic time series, run the main audit function(s), show the resulting report
Brief markdown commentary explaining each step and what the output means
Optionally, a second notebook covering a slightly more realistic dataset
What to do:
Add one or more Jupyter notebooks under an examples/ (or similar) directory that walk through basic usage of tsauditor — loading a time series, running the core audit checks, and interpreting the output.
Why this is approachable:
No deep familiarity with internals needed except the public API
Clear, bounded deliverable (a notebook or two)
Directly improves onboarding for new users and contributors
tsauditor currently lacks tutorials, and the existing example notebooks are sparse. This makes it difficult for new users to understand how to use the library and for potential contributors to get oriented.
What's Needed:
A minimal end-to-end notebook: load a sample/synthetic time series, run the main audit function(s), show the resulting report
Brief markdown commentary explaining each step and what the output means
Optionally, a second notebook covering a slightly more realistic dataset
What to do:
Add one or more Jupyter notebooks under an examples/ (or similar) directory that walk through basic usage of tsauditor — loading a time series, running the core audit checks, and interpreting the output.
Why this is approachable:
No deep familiarity with internals needed except the public API
Clear, bounded deliverable (a notebook or two)
Directly improves onboarding for new users and contributors