mirror of
https://github.com/saymrwulf/stable-baselines3.git
synced 2026-11-18 09:54:10 +00:00
Fix test_vec_normalize.py, test_tensorboard.py and common/monitor.py type hint (#1194)
* Remove from mypy exclude * type hint for metadata * Union[float, int] -> float * Remove useless __init__ * Type hint for model and logger in BaseCallback * Type hint for metric_dict * Update changelog * fix test_tensorboard * ignore gamma type checking * Fix monitor type hint * Update logger type hints * Fix type annotation and bump version * Fix circular import Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
This commit is contained in:
parent
9bb1538b78
commit
92f7a6f23b
12 changed files with 47 additions and 42 deletions
|
|
@ -268,11 +268,9 @@ Here is an example of how to save hyperparameters in TensorBoard:
|
||||||
|
|
||||||
|
|
||||||
class HParamCallback(BaseCallback):
|
class HParamCallback(BaseCallback):
|
||||||
def __init__(self):
|
"""
|
||||||
"""
|
Saves the hyperparameters and metrics at the start of the training, and logs them to TensorBoard.
|
||||||
Saves the hyperparameters and metrics at the start of the training, and logs them to TensorBoard.
|
"""
|
||||||
"""
|
|
||||||
super().__init__()
|
|
||||||
|
|
||||||
def _on_training_start(self) -> None:
|
def _on_training_start(self) -> None:
|
||||||
hparam_dict = {
|
hparam_dict = {
|
||||||
|
|
@ -284,7 +282,7 @@ Here is an example of how to save hyperparameters in TensorBoard:
|
||||||
# Tensorbaord will find & display metrics from the `SCALARS` tab
|
# Tensorbaord will find & display metrics from the `SCALARS` tab
|
||||||
metric_dict = {
|
metric_dict = {
|
||||||
"rollout/ep_len_mean": 0,
|
"rollout/ep_len_mean": 0,
|
||||||
"train/value_loss": 0,
|
"train/value_loss": 0.0,
|
||||||
}
|
}
|
||||||
self.logger.record(
|
self.logger.record(
|
||||||
"hparams",
|
"hparams",
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@ Changelog
|
||||||
==========
|
==========
|
||||||
|
|
||||||
|
|
||||||
Release 1.8.0a0 (WIP)
|
Release 1.8.0a1 (WIP)
|
||||||
--------------------------
|
--------------------------
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -28,6 +28,9 @@ Deprecations:
|
||||||
|
|
||||||
Others:
|
Others:
|
||||||
^^^^^^^
|
^^^^^^^
|
||||||
|
- Fixed ``tests/test_tensorboard.py`` type hint
|
||||||
|
- Fixed ``tests/test_vec_normalize.py`` type hint
|
||||||
|
- Fixed ``stable_baselines3/common/monitor.py`` type hint
|
||||||
|
|
||||||
Documentation:
|
Documentation:
|
||||||
^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^
|
||||||
|
|
|
||||||
|
|
@ -39,7 +39,6 @@ exclude = (?x)(
|
||||||
| stable_baselines3/common/envs/identity_env.py$
|
| stable_baselines3/common/envs/identity_env.py$
|
||||||
| stable_baselines3/common/envs/multi_input_envs.py$
|
| stable_baselines3/common/envs/multi_input_envs.py$
|
||||||
| stable_baselines3/common/logger.py$
|
| stable_baselines3/common/logger.py$
|
||||||
| stable_baselines3/common/monitor.py$
|
|
||||||
| stable_baselines3/common/off_policy_algorithm.py$
|
| stable_baselines3/common/off_policy_algorithm.py$
|
||||||
| stable_baselines3/common/on_policy_algorithm.py$
|
| stable_baselines3/common/on_policy_algorithm.py$
|
||||||
| stable_baselines3/common/policies.py$
|
| stable_baselines3/common/policies.py$
|
||||||
|
|
@ -67,9 +66,7 @@ exclude = (?x)(
|
||||||
| stable_baselines3/td3/policies.py$
|
| stable_baselines3/td3/policies.py$
|
||||||
| stable_baselines3/td3/td3.py$
|
| stable_baselines3/td3/td3.py$
|
||||||
| tests/test_logger.py$
|
| tests/test_logger.py$
|
||||||
| tests/test_tensorboard.py$
|
|
||||||
| tests/test_train_eval_mode.py$
|
| tests/test_train_eval_mode.py$
|
||||||
| tests/test_vec_normalize.py$
|
|
||||||
)
|
)
|
||||||
|
|
||||||
[flake8]
|
[flake8]
|
||||||
|
|
|
||||||
|
|
@ -6,6 +6,8 @@ from typing import Any, Callable, Dict, List, Optional, Union
|
||||||
import gym
|
import gym
|
||||||
import numpy as np
|
import numpy as np
|
||||||
|
|
||||||
|
from stable_baselines3.common.logger import Logger
|
||||||
|
|
||||||
try:
|
try:
|
||||||
from tqdm import TqdmExperimentalWarning
|
from tqdm import TqdmExperimentalWarning
|
||||||
|
|
||||||
|
|
@ -29,10 +31,13 @@ class BaseCallback(ABC):
|
||||||
:param verbose: Verbosity level: 0 for no output, 1 for info messages, 2 for debug messages
|
:param verbose: Verbosity level: 0 for no output, 1 for info messages, 2 for debug messages
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
# The RL model
|
||||||
|
# Type hint as string to avoid circular import
|
||||||
|
model: "base_class.BaseAlgorithm"
|
||||||
|
logger: Logger
|
||||||
|
|
||||||
def __init__(self, verbose: int = 0):
|
def __init__(self, verbose: int = 0):
|
||||||
super().__init__()
|
super().__init__()
|
||||||
# The RL model
|
|
||||||
self.model = None # type: Optional[base_class.BaseAlgorithm]
|
|
||||||
# An alias for self.model.get_env(), the environment used for training
|
# An alias for self.model.get_env(), the environment used for training
|
||||||
self.training_env = None # type: Union[gym.Env, VecEnv, None]
|
self.training_env = None # type: Union[gym.Env, VecEnv, None]
|
||||||
# Number of time the callback was called
|
# Number of time the callback was called
|
||||||
|
|
@ -42,7 +47,6 @@ class BaseCallback(ABC):
|
||||||
self.verbose = verbose
|
self.verbose = verbose
|
||||||
self.locals: Dict[str, Any] = {}
|
self.locals: Dict[str, Any] = {}
|
||||||
self.globals: Dict[str, Any] = {}
|
self.globals: Dict[str, Any] = {}
|
||||||
self.logger = None
|
|
||||||
# Sometimes, for event callback, it is useful
|
# Sometimes, for event callback, it is useful
|
||||||
# to have access to the parent object
|
# to have access to the parent object
|
||||||
self.parent = None # type: Optional[BaseCallback]
|
self.parent = None # type: Optional[BaseCallback]
|
||||||
|
|
|
||||||
|
|
@ -121,7 +121,7 @@ class SimpleMultiObsEnv(gym.Env):
|
||||||
self.right_possible = [0, 1, 2, 12, 13, 14]
|
self.right_possible = [0, 1, 2, 12, 13, 14]
|
||||||
self.up_possible = [4, 8, 12, 7, 11, 15]
|
self.up_possible = [4, 8, 12, 7, 11, 15]
|
||||||
|
|
||||||
def step(self, action: Union[int, float, np.ndarray]) -> GymStepReturn:
|
def step(self, action: Union[float, np.ndarray]) -> GymStepReturn:
|
||||||
"""
|
"""
|
||||||
Run one timestep of the environment's dynamics. When end of
|
Run one timestep of the environment's dynamics. When end of
|
||||||
episode is reached, you are responsible for calling `reset()`
|
episode is reached, you are responsible for calling `reset()`
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,7 @@ import sys
|
||||||
import tempfile
|
import tempfile
|
||||||
import warnings
|
import warnings
|
||||||
from collections import defaultdict
|
from collections import defaultdict
|
||||||
from typing import Any, Dict, List, Optional, Sequence, TextIO, Tuple, Union
|
from typing import Any, Dict, List, Mapping, Optional, Sequence, TextIO, Tuple, Union
|
||||||
|
|
||||||
import numpy as np
|
import numpy as np
|
||||||
import pandas
|
import pandas
|
||||||
|
|
@ -16,7 +16,7 @@ try:
|
||||||
from torch.utils.tensorboard import SummaryWriter
|
from torch.utils.tensorboard import SummaryWriter
|
||||||
from torch.utils.tensorboard.summary import hparams
|
from torch.utils.tensorboard.summary import hparams
|
||||||
except ImportError:
|
except ImportError:
|
||||||
SummaryWriter = None
|
SummaryWriter = None # type: ignore[misc, assignment]
|
||||||
|
|
||||||
try:
|
try:
|
||||||
from tqdm import tqdm
|
from tqdm import tqdm
|
||||||
|
|
@ -38,7 +38,7 @@ class Video:
|
||||||
:param fps: frames per second
|
:param fps: frames per second
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(self, frames: th.Tensor, fps: Union[float, int]):
|
def __init__(self, frames: th.Tensor, fps: float):
|
||||||
self.frames = frames
|
self.frames = frames
|
||||||
self.fps = fps
|
self.fps = fps
|
||||||
|
|
||||||
|
|
@ -80,7 +80,7 @@ class HParam:
|
||||||
A non-empty metrics dict is required to display hyperparameters in the corresponding Tensorboard section.
|
A non-empty metrics dict is required to display hyperparameters in the corresponding Tensorboard section.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(self, hparam_dict: Dict[str, Union[bool, str, float, int, None]], metric_dict: Dict[str, Union[float, int]]):
|
def __init__(self, hparam_dict: Mapping[str, Union[bool, str, float, None]], metric_dict: Mapping[str, float]):
|
||||||
self.hparam_dict = hparam_dict
|
self.hparam_dict = hparam_dict
|
||||||
if not metric_dict:
|
if not metric_dict:
|
||||||
raise Exception("`metric_dict` must not be empty to display hyperparameters to the HPARAMS tensorboard tab.")
|
raise Exception("`metric_dict` must not be empty to display hyperparameters to the HPARAMS tensorboard tab.")
|
||||||
|
|
@ -329,7 +329,7 @@ class CSVOutputFormat(KVWriter):
|
||||||
|
|
||||||
def __init__(self, filename: str):
|
def __init__(self, filename: str):
|
||||||
self.file = open(filename, "w+t")
|
self.file = open(filename, "w+t")
|
||||||
self.keys = []
|
self.keys: List[str] = []
|
||||||
self.separator = ","
|
self.separator = ","
|
||||||
self.quotechar = '"'
|
self.quotechar = '"'
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,7 @@ import json
|
||||||
import os
|
import os
|
||||||
import time
|
import time
|
||||||
from glob import glob
|
from glob import glob
|
||||||
from typing import Dict, List, Optional, Tuple, Union
|
from typing import Any, Dict, List, Optional, Tuple, Union
|
||||||
|
|
||||||
import gym
|
import gym
|
||||||
import numpy as np
|
import numpy as np
|
||||||
|
|
@ -41,6 +41,7 @@ class Monitor(gym.Wrapper):
|
||||||
):
|
):
|
||||||
super().__init__(env=env)
|
super().__init__(env=env)
|
||||||
self.t_start = time.time()
|
self.t_start = time.time()
|
||||||
|
self.results_writer = None
|
||||||
if filename is not None:
|
if filename is not None:
|
||||||
self.results_writer = ResultsWriter(
|
self.results_writer = ResultsWriter(
|
||||||
filename,
|
filename,
|
||||||
|
|
@ -48,18 +49,18 @@ class Monitor(gym.Wrapper):
|
||||||
extra_keys=reset_keywords + info_keywords,
|
extra_keys=reset_keywords + info_keywords,
|
||||||
override_existing=override_existing,
|
override_existing=override_existing,
|
||||||
)
|
)
|
||||||
else:
|
|
||||||
self.results_writer = None
|
|
||||||
self.reset_keywords = reset_keywords
|
self.reset_keywords = reset_keywords
|
||||||
self.info_keywords = info_keywords
|
self.info_keywords = info_keywords
|
||||||
self.allow_early_resets = allow_early_resets
|
self.allow_early_resets = allow_early_resets
|
||||||
self.rewards = None
|
self.rewards: List[float] = []
|
||||||
self.needs_reset = True
|
self.needs_reset = True
|
||||||
self.episode_returns = []
|
self.episode_returns: List[float] = []
|
||||||
self.episode_lengths = []
|
self.episode_lengths: List[int] = []
|
||||||
self.episode_times = []
|
self.episode_times: List[float] = []
|
||||||
self.total_steps = 0
|
self.total_steps = 0
|
||||||
self.current_reset_info = {} # extra info about the current episode, that was passed in during reset()
|
# extra info about the current episode, that was passed in during reset()
|
||||||
|
self.current_reset_info: Dict[str, Any] = {}
|
||||||
|
|
||||||
def reset(self, **kwargs) -> GymObs:
|
def reset(self, **kwargs) -> GymObs:
|
||||||
"""
|
"""
|
||||||
|
|
@ -200,7 +201,7 @@ class ResultsWriter:
|
||||||
|
|
||||||
self.file_handler.flush()
|
self.file_handler.flush()
|
||||||
|
|
||||||
def write_row(self, epinfo: Dict[str, Union[float, int]]) -> None:
|
def write_row(self, epinfo: Dict[str, float]) -> None:
|
||||||
"""
|
"""
|
||||||
Close the file handler
|
Close the file handler
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
from typing import Tuple, Union
|
from typing import Tuple
|
||||||
|
|
||||||
import numpy as np
|
import numpy as np
|
||||||
|
|
||||||
|
|
@ -40,7 +40,7 @@ class RunningMeanStd:
|
||||||
batch_count = arr.shape[0]
|
batch_count = arr.shape[0]
|
||||||
self.update_from_moments(batch_mean, batch_var, batch_count)
|
self.update_from_moments(batch_mean, batch_var, batch_count)
|
||||||
|
|
||||||
def update_from_moments(self, batch_mean: np.ndarray, batch_var: np.ndarray, batch_count: Union[int, float]) -> None:
|
def update_from_moments(self, batch_mean: np.ndarray, batch_var: np.ndarray, batch_count: float) -> None:
|
||||||
delta = batch_mean - self.mean
|
delta = batch_mean - self.mean
|
||||||
tot_count = self.count + batch_count
|
tot_count = self.count + batch_count
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -76,7 +76,7 @@ def update_learning_rate(optimizer: th.optim.Optimizer, learning_rate: float) ->
|
||||||
param_group["lr"] = learning_rate
|
param_group["lr"] = learning_rate
|
||||||
|
|
||||||
|
|
||||||
def get_schedule_fn(value_schedule: Union[Schedule, float, int]) -> Schedule:
|
def get_schedule_fn(value_schedule: Union[Schedule, float]) -> Schedule:
|
||||||
"""
|
"""
|
||||||
Transform (if needed) learning rate and clip range (for PPO)
|
Transform (if needed) learning rate and clip range (for PPO)
|
||||||
to callable.
|
to callable.
|
||||||
|
|
|
||||||
|
|
@ -1 +1 @@
|
||||||
1.8.0a0
|
1.8.0a1
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,5 @@
|
||||||
import os
|
import os
|
||||||
|
from typing import Dict, Union
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
|
|
@ -18,21 +19,21 @@ N_STEPS = 100
|
||||||
|
|
||||||
|
|
||||||
class HParamCallback(BaseCallback):
|
class HParamCallback(BaseCallback):
|
||||||
def __init__(self):
|
"""
|
||||||
"""
|
Saves the hyperparameters and metrics at the start of the training, and logs them to TensorBoard.
|
||||||
Saves the hyperparameters and metrics at the start of the training, and logs them to TensorBoard.
|
"""
|
||||||
"""
|
|
||||||
super().__init__()
|
|
||||||
|
|
||||||
def _on_training_start(self) -> None:
|
def _on_training_start(self) -> None:
|
||||||
hparam_dict = {
|
hparam_dict: Dict[str, Union[str, float]] = {
|
||||||
"algorithm": self.model.__class__.__name__,
|
"algorithm": self.model.__class__.__name__,
|
||||||
"learning rate": self.model.learning_rate,
|
# Ignore type checking for gamma, see https://github.com/DLR-RM/stable-baselines3/pull/1194/files#r1035006458
|
||||||
"gamma": self.model.gamma,
|
"gamma": self.model.gamma, # type: ignore[attr-defined]
|
||||||
}
|
}
|
||||||
|
if isinstance(self.model.learning_rate, float): # Can also be Schedule, in that case, we don't report
|
||||||
|
hparam_dict["learning rate"] = self.model.learning_rate
|
||||||
# define the metrics that will appear in the `HPARAMS` Tensorboard tab by referencing their tag
|
# define the metrics that will appear in the `HPARAMS` Tensorboard tab by referencing their tag
|
||||||
# Tensorbaord will find & display metrics from the `SCALARS` tab
|
# Tensorbaord will find & display metrics from the `SCALARS` tab
|
||||||
metric_dict = {
|
metric_dict: Dict[str, float] = {
|
||||||
"rollout/ep_len_mean": 0,
|
"rollout/ep_len_mean": 0,
|
||||||
}
|
}
|
||||||
self.logger.record(
|
self.logger.record(
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,5 @@
|
||||||
import operator
|
import operator
|
||||||
|
from typing import Any, Dict
|
||||||
|
|
||||||
import gym
|
import gym
|
||||||
import numpy as np
|
import numpy as np
|
||||||
|
|
@ -20,7 +21,7 @@ ENV_ID = "Pendulum-v1"
|
||||||
|
|
||||||
|
|
||||||
class DummyRewardEnv(gym.Env):
|
class DummyRewardEnv(gym.Env):
|
||||||
metadata = {}
|
metadata: Dict[str, Any] = {}
|
||||||
|
|
||||||
def __init__(self, return_reward_idx=0):
|
def __init__(self, return_reward_idx=0):
|
||||||
self.action_space = spaces.Discrete(2)
|
self.action_space = spaces.Discrete(2)
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue