diff --git a/ppsci/data/dataset/vtu_dataset.py b/ppsci/data/dataset/vtu_dataset.py index f238a45c7f..f3198c8839 100644 --- a/ppsci/data/dataset/vtu_dataset.py +++ b/ppsci/data/dataset/vtu_dataset.py @@ -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.