Skip to content

docs: bring back hierarchy in ParallelLoader docs#706

Merged
luisremis merged 2 commits into
developfrom
fix/issue-482
May 20, 2026
Merged

docs: bring back hierarchy in ParallelLoader docs#706
luisremis merged 2 commits into
developfrom
fix/issue-482

Conversation

@ad-claw000
Copy link
Copy Markdown
Contributor

Summary

  • Brought back the hierarchy of data loaders in the ParallelLoader docstring to make it clear which classes it accepts as inputs.

Verification

  • Inspected the docstring in aperturedb/ParallelLoader.py.

Fixes #482

Copilot AI review requested due to automatic review settings May 20, 2026 00:58
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Restores documentation clarity for ParallelLoader by reintroducing a list of supported data-loader inputs, aiming to address issue #482 about missing “hierarchy” information.

Changes:

  • Added a “Hierarchy of Data Loaders” section to the ParallelLoader class docstring.
  • Listed specific CSV loader classes and base classes (PyTorchData, KaggleData) as accepted inputs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread aperturedb/ParallelLoader.py
Copy link
Copy Markdown
Contributor Author

@ad-claw000 ad-claw000 left a comment

Choose a reason for hiding this comment

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

Applied autopep8 formatting to the new log messages to fix the pre-commit CI failure.

Copy link
Copy Markdown
Contributor Author

@ad-claw000 ad-claw000 left a comment

Choose a reason for hiding this comment

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

Fixed the pre-commit CI failure by applying autopep8 formatting to the new log messages. Ready for review!

Copy link
Copy Markdown
Contributor Author

@ad-claw000 ad-claw000 left a comment

Choose a reason for hiding this comment

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

Addressed the feedback: updated the docstring to clarify that ParallelLoader accepts any Subscriptable that yields (commands, blobs) and the dataset is passed to ingest().

@luisremis luisremis merged commit b352ebd into develop May 20, 2026
3 checks passed
@luisremis luisremis deleted the fix/issue-482 branch May 20, 2026 05:49
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.

hierarchy : can it be brought back in docs?

3 participants