fix documentation type hint issues

dacbench/abstract_benchmark.py

@@ -43,10 +43,8 @@ def get_config(self):
         """Return current configuration.
 
         Returns:
-        -------
-        dict
-            Current config
-
+        --------
+        dict: Current config
         """
         return self.config
 
@@ -127,7 +125,7 @@ def jsonify_wrappers(self):
         """Write wrapper description to list.
 
         Returns:
-        -------
+        --------
         list
 
         """
@@ -421,10 +419,8 @@ def get_environment(self):
         """Make benchmark environment.
 
         Returns:
-        -------
-        env : gym.Env
-            Benchmark environment
-
+        --------
+        gym.Env: Benchmark environment
         """
         raise NotImplementedError
 

dacbench/abstract_env.py

@@ -166,9 +166,8 @@ def step_(self):
         """Pre-step function for step count and cutoff.
 
         Returns:
-        -------
-        bool
-            End of episode
+        --------
+        bool: End of episode
 
         """
         truncated = False
@@ -234,7 +233,7 @@ def step(self, action):
             Action to take
 
         Returns:
-        -------
+        --------
         state
             Environment state
         reward
@@ -259,7 +258,7 @@ def reset(self, seed: int | None = None):
             Seed for the environment
 
         Returns:
-        -------
+        --------
         state
             Environment state
         info: dict
@@ -272,32 +271,26 @@ def get_inst_id(self):
         """Return instance ID.
 
         Returns:
-        -------
-        int
-            ID of current instance
-
+        --------
+        int: ID of current instance
         """
         return self.inst_id
 
     def get_instance_set(self):
         """Return instance set.
 
         Returns:
-        -------
-        list
-            List of instances
-
+        --------
+        list: List of instances
         """
         return self.instance_set
 
     def get_instance(self):
         """Return current instance.
 
         Returns:
-        -------
-        type flexible
-            Currently used instance
-
+        --------
+        type flexible: Currently used instance
         """
         return self.instance
 
@@ -489,9 +482,8 @@ def last(self):
         """Get current step data.
 
         Returns:
-        -------
+        --------
         np.array, float, bool, bool, dict
-
         """
         return (
             self.observation,

dacbench/benchmarks/luby_benchmark.py

@@ -64,7 +64,7 @@ def __init__(self, config_path=None, config=None):
         """Initialize Luby Benchmark.
 
         Parameters
-        -------
+        ----------
         config_path : str
             Path to config file (optional)
         """
@@ -80,9 +80,8 @@ def get_environment(self):
         """Return Luby env with current configuration.
 
         Returns:
-        -------
-        LubyEnv
-            Luby environment
+        --------
+        LubyEnv: Luby environment
         """
         if "instance_set" not in self.config:
             self.read_instance_set()
@@ -101,8 +100,8 @@ def set_cutoff(self, steps):
         """Set cutoff and adapt dependencies.
 
         Parameters
-        -------
-        int
+        ----------
+        int:
             Maximum number of steps
         """
         self.config.cutoff = steps
@@ -122,8 +121,8 @@ def set_history_length(self, length):
         """Set history length and adapt dependencies.
 
         Parameters
-        -------
-        int
+        ----------
+        int:
             History length
         """
         self.config.hist_length = length
@@ -177,7 +176,7 @@ def get_benchmark(self, min_l=8, fuzziness=1.5, seed=0):
         """Get Benchmark from DAC paper.
 
         Parameters
-        -------
+        ----------
         min_l : int
             Minimum sequence lenght, was 8, 16 or 32 in the paper
         fuzziness : float
@@ -186,9 +185,8 @@ def get_benchmark(self, min_l=8, fuzziness=1.5, seed=0):
             Environment seed
 
         Returns:
-        -------
-        env : LubyEnv
-            Luby environment
+        --------
+        LubyEnv: Luby Environment
         """
         self.config = objdict(LUBY_DEFAULTS.copy())
         self.config.min_steps = min_l

dacbench/benchmarks/toysgd_benchmark.py

@@ -87,9 +87,8 @@ def get_environment(self):
         """Return SGDEnv env with current configuration.
 
         Returns:
-        -------
-        SGDEnv
-            SGD environment
+        --------
+        ToySGDEnv: ToySGD environment
         """
         if "instance_set" not in self.config:
             self.read_instance_set()

dacbench/envs/luby.py

@@ -28,7 +28,7 @@ def __init__(self, config) -> None:
         """Initialize Luby Env.
 
         Parameters
-        -------
+        ----------
         config : objdict
             Environment configuration
         """
@@ -68,9 +68,8 @@ def step(self, action: int):
             action to execute
 
         Returns:
-        -------
-        np.array, float, bool, bool, dict
-            state, reward, terminated, truncated, info
+        --------
+        np.array, float, bool, bool, dict: state, reward, terminated, truncated, info
         """
         self.done = super().step_()
         self.prev_state = self._state.copy()
@@ -98,9 +97,8 @@ def reset(self, seed=None, options=None) -> list[int]:
         """Resets env.
 
         Returns:
-        -------
-        numpy.array
-            Environment state
+        --------
+        numpy.array: Environment state
         """
         if options is None:
             options = {}
@@ -142,7 +140,8 @@ def get_default_state(self, _):
             _ (_type_): Empty parameter, which can be used when overriding
 
         Returns:
-            dict: The current state
+        --------
+        dict: The current state
         """
         if self.c_step == 0:
             self._state = [-1 for _ in range(self._hist_len + 1)]
@@ -159,9 +158,8 @@ def close(self) -> bool:
         """Close Env.
 
         Returns:
-        -------
-        bool
-            Closing confirmation
+        --------
+        bool: Closing confirmation
         """
         return True
 

dacbench/envs/theory.py

@@ -406,20 +406,17 @@ def get_obs_domain_from_name(var_name):  # noqa: ARG004
         The observation space will then be created
 
         Returns:
-        -------
-            Two int values, e.g., 1, np.inf
-
+        --------
+        Two int values, e.g., 1, np.inf
         """
         return 0, np.inf
 
     def reset(self, seed=None, options=None):
         """Resets env.
 
         Returns:
-        -------
-        numpy.array
-            Environment state
-
+        --------
+        numpy.array: Environment state
         """
         if options is None:
             options = {}
@@ -475,10 +472,8 @@ def step(self, action):
             action to execute
 
         Returns:
-        -------
-            state, reward, terminated, truncated, info
-            np.array, float, bool, bool, dict
-
+        --------
+        np.array, float, bool, bool, dict: state, reward, terminated, truncated, info
         """
         truncated = super().step_()
 
@@ -592,10 +587,8 @@ def close(self) -> bool:
         No additional cleanup necessary
 
         Returns:
-        -------
-        bool
-            Closing confirmation
-
+        --------
+        bool: Closing confirmation
         """
         return True