style: fix spelling

PKU-Alignment · Jun 19, 2024 · 9809987 · 9809987
1 parent 3934192
commit 9809987
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/omnisafe/common/experiment_grid.py b/omnisafe/common/experiment_grid.py
@@ -561,7 +561,7 @@ def analyze(
             cost_limit (float or None, optional): Value for one line showed on graph to indicate
                 cost. Defaults to None.
             show_image (bool): Whether to show graph image in GUI windows.
-            reward_metrics (str, optional): The column name for reward metrics. Defaults to 'Metrics/EpReward'.
+            reward_metrics (str, optional): The column name for reward metrics. Defaults to 'Metrics/EpRet'.
             cost_metrics (str, optional): The column name for cost metrics. Defaults to 'Metrics/EpCost'.
         """
         assert self._statistical_tools is not None, 'Please run run() first!'

diff --git a/omnisafe/common/statistics_tools.py b/omnisafe/common/statistics_tools.py
@@ -105,7 +105,7 @@ def draw_graph(
             cost_limit (float or None, optional): The cost limit of the experiment. Defaults to None.
             smooth (int, optional): The smooth window size. Defaults to 1.
             show_image (bool): Whether to show graph image in GUI windows.
-            reward_metrics (str, optional): The column name for reward metrics. Defaults to 'Metrics/EpReward'.
+            reward_metrics (str, optional): The column name for reward metrics. Defaults to 'Metrics/EpRet'.
             cost_metrics (str, optional): The column name for cost metrics. Defaults to 'Metrics/EpCost'.
 
         .. note::

diff --git a/omnisafe/utils/plotter.py b/omnisafe/utils/plotter.py
@@ -168,7 +168,7 @@ def get_datasets(
         self,
         logdir: str,
         condition: str | None = None,
-        reward_metrics: str = 'Metrics/EpReward',
+        reward_metrics: str = 'Metrics/EpRet',
         cost_metrics: str = 'Metrics/EpCost',
     ) -> list[DataFrame]:
         """Recursively look through logdir for files named "progress.txt".
@@ -178,7 +178,7 @@ def get_datasets(
         Args:
             logdir (str): The directory to search for progress.txt files
             condition (str or None, optional): The condition label. Defaults to None.
-            reward_metrics (str, optional): The column name for reward metrics. Defaults to 'Metrics/EpReward'.
+            reward_metrics (str, optional): The column name for reward metrics. Defaults to 'Metrics/EpRet'.
             cost_metrics (str, optional): The column name for cost metrics. Defaults to 'Metrics/EpCost'.
 
         Returns:
@@ -258,7 +258,7 @@ def get_all_datasets(
             legend (list of str or None, optional): List of legend names. Defaults to None.
             select (str or None, optional): Select logdirs that contain this string. Defaults to None.
             exclude (str or None, optional): Exclude logdirs that contain this string. Defaults to None.
-            reward_metrics (str, optional): The column name for reward metrics. Defaults to 'Metrics/EpReward'.
+            reward_metrics (str, optional): The column name for reward metrics. Defaults to 'Metrics/EpRet'.
             cost_metrics (str, optional): The column name for cost metrics. Defaults to 'Metrics/EpCost'.
 
         Returns:
@@ -378,7 +378,7 @@ def make_plots(
                 to ``png``.
             show_image (bool, optional): Optional flag. If set, the plot will be displayed on screen.
                 Defaults to ``False``.
-            reward_metrics (str, optional): The column name for reward metrics. Defaults to 'Metrics/EpReward'.
+            reward_metrics (str, optional): The column name for reward metrics. Defaults to 'Metrics/EpRet'.
             cost_metrics (str, optional): The column name for cost metrics. Defaults to 'Metrics/EpCost'.
         """
         assert xaxis is not None, 'Must specify xaxis'