Skip to content

【PPSCI Doc No.9】 ppsci.data.dataset.VtuDataset #791

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

Merged
merged 3 commits into from
Mar 1, 2024
Merged

【PPSCI Doc No.9】 ppsci.data.dataset.VtuDataset #791

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f2c1957
Add docx
Liyulingyue Feb 27, 2024
7bf2493
Apply suggestions from code review
Liyulingyue Feb 29, 2024
31fb2bf
Apply suggestions from code review
Liyulingyue Feb 29, 2024
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
11 changes: 11 additions & 0 deletions ppsci/data/dataset/vtu_dataset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,17 @@ class VtuDataset(io.Dataset):
labels (Optional[Dict[str, float]]): Temporary variable for [load_vtk_with_time_file].
transforms (vision.Compose, optional): Compose object contains sample wise.
transform(s).

Examples:
>>> from ppsci.dataset import VtuDataset

>>> dataset = VtuDataset(file_path='example.vtu') # doctest: +SKIP

>>> # get the length of the dataset
>>> dataset_size = len(dataset) # doctest: +SKIP
>>> # get the first sample of the data
>>> first_sample = dataset[0] # doctest: +SKIP
>>> print("First sample:", first_sample)
"""

# Whether support batch indexing for speeding up fetching process.
Expand Down