Skip to content

Batching documentation - #272

Open
sjavis wants to merge 3 commits into
batching-buffer-periodfrom
batching-documentation
Open

sjavis wants to merge 3 commits into
batching-buffer-periodfrom
batching-documentation

Conversation

@sjavis

@sjavis sjavis commented Oct 2, 2026 •

Copy link
Copy Markdown
Collaborator

This improves the docstring for batching and adds a tutorial notebook for using the batching function. This gets included in the documentation.

Here is the notebook in the documentation: https://tctrack--272.org.readthedocs.build/en/272/getting-started/tutorial_batching.html

Closes #263

@sjavis sjavis self-assigned this Oct 2, 2026
@sjavis
sjavis changed the base branch from main to batching-buffer-period October 2, 2026 12:46
@sjavis
sjavis added this pull request to stack #262 October 2, 2026 12:46
@sjavis
sjavis force-pushed the batching-documentation branch from 5cdbac1 to ced3107 Compare October 2, 2026 12:52
Comment thread tutorial/batching.ipynb

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could this be cleared before pushing?

@sjavis sjavis Oct 6, 2026 •

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Ideally we would, but I want to include them in the documentation. We could instead run the notebooks as part of the build. But due to time required for the data download + preprocessing I think it is better to just commit the outputs. They shouldn't need to be changed regularly.

@sjavis
sjavis removed this pull request from stack #262 October 5, 2026 16:27
@sjavis
sjavis force-pushed the batching-documentation branch from ced3107 to 68d5163 Compare October 7, 2026 08:50
@sjavis
sjavis force-pushed the batching-documentation branch 2 times, most recently from 461fc42 to db87f1c Compare October 12, 2026 09:15
@sjavis
sjavis added this pull request to stack #275 October 12, 2026 13:47
@sjavis
sjavis force-pushed the batching-documentation branch from db87f1c to 904b970 Compare October 14, 2026 12:20

This branch has not been deployed

No deployments
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.

Add documentation for batching

2 participants