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.

Sign up for GitHub

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

Clarify OfflineDataset usage for #255 #318

Merged
merged 1 commit into from
Feb 14, 2025
Merged

Clarify OfflineDataset usage for #255 #318

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion bayesflow/datasets/offline_dataset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@

class OfflineDataset(keras.utils.PyDataset):
"""
A dataset that is pre-simulated and stored in memory.
A dataset that is pre-simulated and stored in memory. When storing and loading data from disk, it is recommended to
save any pre-simulated data in raw form and create the `OfflineDataset` object only after loading in the raw data.
See the `DiskDataset` class for handling large datasets that are split into multiple smaller files.
"""

def __init__(self, data: dict[str, np.ndarray], batch_size: int, adapter: Adapter | None, **kwargs):
Expand Down