rename 'num_timestamp' to 'num_timestamps'

Author: HydrogenSulfate

ppsci/geometry/timedomain.py

@@ -64,9 +64,9 @@ def __init__(
         if time_step is not None:
             if time_step <= 0:
                 raise ValueError(f"time_step({time_step}) must be larger than 0.")
-            self.num_timestamp = int(np.ceil((t1 - t0) / time_step)) + 1
+            self.num_timestamps = int(np.ceil((t1 - t0) / time_step)) + 1
         elif timestamps is not None:
-            self.num_timestamp = len(timestamps)
+            self.num_timestamps = len(timestamps)
 
     def on_initial(self, t):
         return np.isclose(t, self.t0).flatten()
@@ -120,7 +120,7 @@ def uniform_points(self, n, boundary=True):
             nx = int(np.ceil(n / nt))
         elif self.timedomain.timestamps is not None:
             # exclude start time t0
-            nt = self.timedomain.num_timestamp - 1
+            nt = self.timedomain.num_timestamps - 1
             nx = int(np.ceil(n / nt))
         else:
             nx = int(
@@ -216,7 +216,7 @@ def random_points(self, n, random="pseudo", criteria=None):
                 tx = tx[:n]
             return tx
         elif self.timedomain.timestamps is not None:
-            nt = self.timedomain.num_timestamp - 1
+            nt = self.timedomain.num_timestamps - 1
             t = self.timedomain.timestamps[1:]
             nx = int(np.ceil(n / nt))
 
@@ -431,7 +431,7 @@ def random_boundary_points(self, n, random="pseudo", criteria=None):
                 return t_x
         elif self.timedomain.timestamps is not None:
             # exclude start time t0
-            nt = self.timedomain.num_timestamp - 1
+            nt = self.timedomain.num_timestamps - 1
             t = self.timedomain.timestamps[1:]
             nx = int(np.ceil(n / nt))
 

ppsci/validate/geo_validator.py

@@ -92,19 +92,19 @@ def __init__(
         self.output_keys = list(label_dict.keys())
 
         nx = dataloader_cfg["total_size"]
-        self.num_timestamp = 1
+        self.num_timestamps = 1
         # TODO(sensen): simplify code below
         if isinstance(geom, geometry.TimeXGeometry):
-            if geom.timedomain.num_timestamp is not None:
+            if geom.timedomain.num_timestamps is not None:
                 if with_initial:
                     # include t0
-                    self.num_timestamp = geom.timedomain.num_timestamp
+                    self.num_timestamps = geom.timedomain.num_timestamps
                     assert (
-                        nx % self.num_timestamp == 0
-                    ), f"{nx} % {self.num_timestamp} != 0"
-                    nx //= self.num_timestamp
+                        nx % self.num_timestamps == 0
+                    ), f"{nx} % {self.num_timestamps} != 0"
+                    nx //= self.num_timestamps
                     input = geom.sample_interior(
-                        nx * (geom.timedomain.num_timestamp - 1),
+                        nx * (geom.timedomain.num_timestamps - 1),
                         random,
                         criteria,
                         evenly,
@@ -115,13 +115,13 @@ def __init__(
                     }
                 else:
                     # exclude t0
-                    self.num_timestamp = geom.timedomain.num_timestamp - 1
+                    self.num_timestamps = geom.timedomain.num_timestamps - 1
                     assert (
-                        nx % self.num_timestamp == 0
-                    ), f"{nx} % {self.num_timestamp} != 0"
-                    nx //= self.num_timestamp
+                        nx % self.num_timestamps == 0
+                    ), f"{nx} % {self.num_timestamps} != 0"
+                    nx //= self.num_timestamps
                     input = geom.sample_interior(
-                        nx * (geom.timedomain.num_timestamp - 1),
+                        nx * (geom.timedomain.num_timestamps - 1),
                         random,
                         criteria,
                         evenly,

ppsci/visualize/plot.py

@@ -66,21 +66,21 @@
 ]
 
 
-def _save_plot_from_1d_array(filename, coord, value, value_keys, num_timestamp=1):
+def _save_plot_from_1d_array(filename, coord, value, value_keys, num_timestamps=1):
     """Save plot from given 1D data.
 
     Args:
         filename (str): Filename.
         coord (np.ndarray): Coordinate array.
         value (Dict[str, np.ndarray]): Dict of value array.
         value_keys (Tuple[str, ...]): Value keys.
-        num_timestamp (int, optional): Number of timestamps coord/value contains. Defaults to 1.
+        num_timestamps (int, optional): Number of timestamps coord/value contains. Defaults to 1.
     """
-    fig, a = plt.subplots(len(value_keys), num_timestamp, squeeze=False)
+    fig, a = plt.subplots(len(value_keys), num_timestamps, squeeze=False)
     fig.subplots_adjust(hspace=0.8)
 
-    len_ts = len(coord) // num_timestamp
-    for t in range(num_timestamp):
+    len_ts = len(coord) // num_timestamps
+    for t in range(num_timestamps):
         st = t * len_ts
         ed = (t + 1) * len_ts
         coord_t = coord[st:ed]
@@ -93,29 +93,29 @@ def _save_plot_from_1d_array(filename, coord, value, value_keys, num_timestamp=1
                 color=cnames[i],
                 label=key,
             )
-            if num_timestamp > 1:
+            if num_timestamps > 1:
                 a[i][t].set_title(f"{key}(t={t})")
             else:
                 a[i][t].set_title(f"{key}")
             a[i][t].grid()
             a[i][t].legend()
 
-        if num_timestamp == 1:
+        if num_timestamps == 1:
             fig.savefig(filename, dpi=300)
         else:
             fig.savefig(f"{filename}_{t}", dpi=300)
 
-    if num_timestamp == 1:
+    if num_timestamps == 1:
         logger.info(f"1D result is saved to {filename}.png")
     else:
         logger.info(
             f"1D result is saved to {filename}_0.png"
-            f" ~ {filename}_{num_timestamp - 1}.png"
+            f" ~ {filename}_{num_timestamps - 1}.png"
         )
 
 
 def save_plot_from_1d_dict(
-    filename, data_dict, coord_keys, value_keys, num_timestamp=1
+    filename, data_dict, coord_keys, value_keys, num_timestamps=1
 ):
     """Plot dict data as file.
 
@@ -124,7 +124,7 @@ def save_plot_from_1d_dict(
         data_dict (Dict[str, Union[np.ndarray, paddle.Tensor]]): Data in dict.
         coord_keys (Tuple[str, ...]): Tuple of coord key. such as ("x", "y").
         value_keys (Tuple[str, ...]): Tuple of value key. such as ("u", "v").
-        num_timestamp (int, optional): Number of timestamp in data_dict. Defaults to 1.
+        num_timestamps (int, optional): Number of timestamp in data_dict. Defaults to 1.
     """
     space_ndim = len(coord_keys) - int("t" in coord_keys)
     if space_ndim not in [1, 2, 3]:
@@ -146,14 +146,14 @@ def save_plot_from_1d_dict(
             value = [x for x in value]
         value = np.concatenate(value, axis=1)
 
-    _save_plot_from_1d_array(filename, coord, value, value_keys, num_timestamp)
+    _save_plot_from_1d_array(filename, coord, value, value_keys, num_timestamps)
 
 
 def _save_plot_from_2d_array(
     filename: str,
     visu_data: Tuple[np.ndarray, ...],
     visu_keys: Tuple[str, ...],
-    num_timestamp: int = 1,
+    num_timestamps: int = 1,
     stride: int = 1,
     xticks: Optional[Tuple[float, ...]] = None,
     yticks: Optional[Tuple[float, ...]] = None,
@@ -164,7 +164,7 @@ def _save_plot_from_2d_array(
         filename (str): Filename.
         visu_data (Tuple[np.ndarray, ...]): Data that requires visualization.
         visu_keys (Tuple[str, ...]]): Keys for visualizing data. such as ("u", "v").
-        num_timestamp (int, optional): Number of timestamps coord/value contains. Defaults to 1.
+        num_timestamps (int, optional): Number of timestamps coord/value contains. Defaults to 1.
         stride (int, optional): The time stride of visualization. Defaults to 1.
         xticks (Optional[Tuple[float, ...]]): Tuple of xtick locations. Defaults to None.
         yticks (Optional[Tuple[float, ...]]): Tuple of ytick locations. Defaults to None.
@@ -176,10 +176,10 @@ def _save_plot_from_2d_array(
 
     fig, ax = plt.subplots(
         len(visu_keys),
-        num_timestamp,
+        num_timestamps,
         squeeze=False,
         sharey=True,
-        figsize=(num_timestamp, len(visu_keys)),
+        figsize=(num_timestamps, len(visu_keys)),
     )
     fig.subplots_adjust(hspace=0.3)
     target_flag = any(["target" in key for key in visu_keys])
@@ -188,7 +188,7 @@ def _save_plot_from_2d_array(
             c_max = np.amax(data)
             c_min = np.amin(data)
 
-        for t_idx in range(num_timestamp):
+        for t_idx in range(num_timestamps):
             t = t_idx * stride
             ax[i, t_idx].imshow(
                 data[t, :, :],
@@ -223,7 +223,7 @@ def save_plot_from_2d_dict(
     filename: str,
     data_dict: Dict[str, Union[np.ndarray, paddle.Tensor]],
     visu_keys: Tuple[str, ...],
-    num_timestamp: int = 1,
+    num_timestamps: int = 1,
     stride: int = 1,
     xticks: Optional[Tuple[float, ...]] = None,
     yticks: Optional[Tuple[float, ...]] = None,
@@ -234,7 +234,7 @@ def save_plot_from_2d_dict(
         filename (str): Output filename.
         data_dict (Dict[str, Union[np.ndarray, paddle.Tensor]]): Data in dict.
         visu_keys (Tuple[str, ...]): Keys for visualizing data. such as ("u", "v").
-        num_timestamp (int, optional): Number of timestamp in data_dict. Defaults to 1.
+        num_timestamps (int, optional): Number of timestamp in data_dict. Defaults to 1.
         stride (int, optional): The time stride of visualization. Defaults to 1.
         xticks (Optional[Tuple[float,...]]): The list of xtick locations. Defaults to None.
         yticks (Optional[Tuple[float,...]]): The list of ytick locations. Defaults to None.
@@ -243,7 +243,7 @@ def save_plot_from_2d_dict(
     if isinstance(visu_data[0], paddle.Tensor):
         visu_data = [x.numpy() for x in visu_data]
     _save_plot_from_2d_array(
-        filename, visu_data, visu_keys, num_timestamp, stride, xticks, yticks
+        filename, visu_data, visu_keys, num_timestamps, stride, xticks, yticks
     )
 
 
@@ -305,21 +305,21 @@ def _save_plot_from_3d_array(
     filename: str,
     visu_data: Tuple[np.ndarray, ...],
     visu_keys: Tuple[str, ...],
-    num_timestamp: int = 1,
+    num_timestamps: int = 1,
 ):
     """Save plot from given 3D data.
 
     Args:
         filename (str): Filename.
         visu_data (Tuple[np.ndarray, ...]): Data that requires visualization.
         visu_keys (Tuple[str, ...]]): Keys for visualizing data. such as ("u", "v").
-        num_timestamp (int, optional): Number of timestamps coord/value contains. Defaults to 1.
+        num_timestamps (int, optional): Number of timestamps coord/value contains. Defaults to 1.
     """
 
     fig = plt.figure(figsize=(10, 10))
-    len_ts = len(visu_data[0]) // num_timestamp
-    for t in range(num_timestamp):
-        ax = fig.add_subplot(1, num_timestamp, t + 1, projection="3d")
+    len_ts = len(visu_data[0]) // num_timestamps
+    for t in range(num_timestamps):
+        ax = fig.add_subplot(1, num_timestamps, t + 1, projection="3d")
         st = t * len_ts
         ed = (t + 1) * len_ts
         visu_data_t = [data[st:ed] for data in visu_data]
@@ -340,37 +340,37 @@ def _save_plot_from_3d_array(
             loc="upper right",
             framealpha=0.95,
         )
-        if num_timestamp == 1:
+        if num_timestamps == 1:
             fig.savefig(filename, dpi=300)
         else:
             fig.savefig(f"{filename}_{t}", dpi=300)
 
-    if num_timestamp == 1:
+    if num_timestamps == 1:
         logger.info(f"3D result is saved to {filename}.png")
     else:
         logger.info(
             f"3D result is saved to {filename}_0.png"
-            f" ~ {filename}_{num_timestamp - 1}.png"
+            f" ~ {filename}_{num_timestamps - 1}.png"
         )
 
 
 def save_plot_from_3d_dict(
     filename: str,
     data_dict: Dict[str, Union[np.ndarray, paddle.Tensor]],
     visu_keys: Tuple[str, ...],
-    num_timestamp: int = 1,
+    num_timestamps: int = 1,
 ):
     """Plot dict data as file.
 
     Args:
         filename (str): Output filename.
         data_dict (Dict[str, Union[np.ndarray, paddle.Tensor]]): Data in dict.
         visu_keys (Tuple[str, ...]): Keys for visualizing data. such as ("u", "v").
-        num_timestamp (int, optional): Number of timestamp in data_dict. Defaults to 1.
+        num_timestamps (int, optional): Number of timestamp in data_dict. Defaults to 1.
     """
 
     visu_data = [data_dict[k] for k in visu_keys]
     if isinstance(visu_data[0], paddle.Tensor):
         visu_data = [x.numpy() for x in visu_data]
 
-    _save_plot_from_3d_array(filename, visu_data, visu_keys, num_timestamp)
+    _save_plot_from_3d_array(filename, visu_data, visu_keys, num_timestamps)

ppsci/visualize/vtu.py

@@ -19,15 +19,15 @@
 from ppsci.utils import logger
 
 
-def _save_vtu_from_array(filename, coord, value, value_keys, num_timestamp=1):
+def _save_vtu_from_array(filename, coord, value, value_keys, num_timestamps=1):
     """Save data to '*.vtu' file(s).
 
     Args:
         filename (str): Output filename.
         coord (np.ndarray): Coordinate points with shape of [N, 2] or [N, 3].
         value (np.ndarray): Value of each coord points with shape of [N, M].
         value_keys (Tuple[str, ...]): Names of each dimension of value, such as ("u", "v").
-        num_timestamp (int, optional): Number of timestamp over coord and value.
+        num_timestamps (int, optional): Number of timestamp over coord and value.
             Defaults to 1.
     """
     if not isinstance(coord, np.ndarray):
@@ -38,10 +38,10 @@ def _save_vtu_from_array(filename, coord, value, value_keys, num_timestamp=1):
         raise ValueError(
             f"coord length({len(coord)}) should be equal to value length({len(value)})"
         )
-    if len(coord) % num_timestamp != 0:
+    if len(coord) % num_timestamps != 0:
         raise ValueError(
             f"coord length({len(coord)}) should be an integer multiple of "
-            f"num_timestamp({num_timestamp})"
+            f"num_timestamps({num_timestamps})"
         )
     if coord.shape[1] not in [2, 3]:
         raise ValueError(f"ndim of coord({coord.shape[1]}) should be 2 or 3.")
@@ -57,8 +57,8 @@ def _save_vtu_from_array(filename, coord, value, value_keys, num_timestamp=1):
         value_keys = ["dummy_key"]
 
     data_ndim = value.shape[1]
-    nx = npoint // num_timestamp
-    for t in range(num_timestamp):
+    nx = npoint // num_timestamps
+    for t in range(num_timestamps):
         # NOTE: each array in data_vtu should be 1-dim, i.e. [N, 1] will occur error.
         if coord_ndim == 2:
             axis_x = np.ascontiguousarray(coord[t * nx : (t + 1) * nx, 0])
@@ -75,28 +75,28 @@ def _save_vtu_from_array(filename, coord, value, value_keys, num_timestamp=1):
                 value[t * nx : (t + 1) * nx, j]
             )
 
-        if num_timestamp > 1:
+        if num_timestamps > 1:
             hl.pointsToVTK(f"{filename}_t-{t}", axis_x, axis_y, axis_z, data=data_vtu)
         else:
             hl.pointsToVTK(filename, axis_x, axis_y, axis_z, data=data_vtu)
 
-    if num_timestamp > 1:
+    if num_timestamps > 1:
         logger.info(
-            f"Visualization results are saved to {filename}_t-0 ~ {filename}_t-{num_timestamp - 1}"
+            f"Visualization results are saved to {filename}_t-0 ~ {filename}_t-{num_timestamps - 1}"
         )
     else:
         logger.info(f"Visualization result is saved to {filename}")
 
 
-def save_vtu_from_dict(filename, data_dict, coord_keys, value_keys, num_timestamp=1):
+def save_vtu_from_dict(filename, data_dict, coord_keys, value_keys, num_timestamps=1):
     """Save dict data to '*.vtu' file.
 
     Args:
         filename (str): Output filename.
         data_dict (Dict[str, Union[np.ndarray, paddle.Tensor]]): Data in dict.
         coord_keys (Tuple[str, ...]): Tuple of coord key. such as ("x", "y").
         value_keys (Tuple[str, ...]): Tuple of value key. such as ("u", "v").
-        num_timestamp (int, optional): Number of timestamp in data_dict. Defaults to 1.
+        num_timestamps (int, optional): Number of timestamp in data_dict. Defaults to 1.
     """
     if len(coord_keys) not in [2, 3, 4]:
         raise ValueError(f"ndim of coord ({len(coord_keys)}) should be 2, 3 or 4")
@@ -117,4 +117,4 @@ def save_vtu_from_dict(filename, data_dict, coord_keys, value_keys, num_timestam
             value = [x for x in value]
         value = np.concatenate(value, axis=1)
 
-    _save_vtu_from_array(filename, coord, value, value_keys, num_timestamp)
+    _save_vtu_from_array(filename, coord, value, value_keys, num_timestamps)