Warning

This package is in maintenance mode, please use Stable-Baselines3 (SB3) for an up-to-date version. You can find a migration guide in SB3 documentation.

# Base RL Class¶

Common interface for all the RL algorithms

class stable_baselines.common.base_class.BaseRLModel(policy, env, verbose=0, *, requires_vec_env, policy_base, policy_kwargs=None, seed=None, n_cpu_tf_sess=None)[source]

The base RL model

Parameters: policy – (BasePolicy) Policy object env – (Gym environment) The environment to learn from (if registered in Gym, can be str. Can be None for loading trained models) verbose – (int) the verbosity level: 0 none, 1 training information, 2 tensorflow debug requires_vec_env – (bool) Does this model require a vectorized environment policy_base – (BasePolicy) the base policy used by this method policy_kwargs – (dict) additional arguments to be passed to the policy on creation seed – (int) Seed for the pseudo-random generators (python, numpy, tensorflow). If None (default), use random seed. Note that if you want completely deterministic results, you must set n_cpu_tf_sess to 1. n_cpu_tf_sess – (int) The number of threads for TensorFlow operations If None, the number of cpu of the current machine will be used.
action_probability(observation, state=None, mask=None, actions=None, logp=False)[source]

If actions is None, then get the model’s action probability distribution from a given observation.

Depending on the action space the output is:
• Discrete: probability for each possible action
• Box: mean and standard deviation of the action output

However if actions is not None, this function will return the probability that the given actions are taken with the given parameters (observation, state, …) on this model. For discrete action spaces, it returns the probability mass; for continuous action spaces, the probability density. This is since the probability mass will always be zero in continuous spaces, see http://blog.christianperone.com/2019/01/ for a good explanation

Parameters: observation – (np.ndarray) the input observation state – (np.ndarray) The last states (can be None, used in recurrent policies) mask – (np.ndarray) The last masks (can be None, used in recurrent policies) actions – (np.ndarray) (OPTIONAL) For calculating the likelihood that the given actions are chosen by the model for each of the given parameters. Must have the same number of actions and observations. (set to None to return the complete action probability distribution) logp – (bool) (OPTIONAL) When specified with actions, returns probability in log-space. This has no effect if actions is None. (np.ndarray) the model’s (log) action probability
get_env()[source]

returns the current environment (can be None if not defined)

Returns: (Gym Environment) The current environment
get_parameter_list()[source]

Get tensorflow Variables of model’s parameters

Returns: (list) List of tensorflow Variables
get_parameters()[source]

Get current model parameters as dictionary of variable name -> ndarray.

Returns: (OrderedDict) Dictionary of variable name -> ndarray of model’s parameters.
get_vec_normalize_env() → Optional[stable_baselines.common.vec_env.vec_normalize.VecNormalize][source]

Return the VecNormalize wrapper of the training env if it exists.

Returns: Optional[VecNormalize] The VecNormalize env.
learn(total_timesteps, callback=None, log_interval=100, tb_log_name='run', reset_num_timesteps=True)[source]

Return a trained model.

Parameters: total_timesteps – (int) The total number of samples to train on callback – (Union[callable, [callable], BaseCallback]) function called at every steps with state of the algorithm. It takes the local and global variables. If it returns False, training is aborted. When the callback inherits from BaseCallback, you will have access to additional stages of the training (training start/end), please read the documentation for more details. log_interval – (int) The number of timesteps before logging. tb_log_name – (str) the name of the run for tensorboard log reset_num_timesteps – (bool) whether or not to reset the current timestep number (used in logging) (BaseRLModel) the trained model
classmethod load(load_path, env=None, custom_objects=None, **kwargs)[source]

Parameters: load_path – (str or file-like) the saved parameter location env – (Gym Environment) the new environment to run the loaded model on (can be None if you only need prediction from a trained model) custom_objects – (dict) Dictionary of objects to replace upon loading. If a variable is present in this dictionary as a key, it will not be deserialized and the corresponding item will be used instead. Similar to custom_objects in keras.models.load_model. Useful when you have an object in file that can not be deserialized. kwargs – extra arguments to change the model when loading
load_parameters(load_path_or_dict, exact_match=True)[source]

Load model parameters from a file or a dictionary

Dictionary keys should be tensorflow variable names, which can be obtained with get_parameters function. If exact_match is True, dictionary should contain keys for all model’s parameters, otherwise RunTimeError is raised. If False, only variables included in the dictionary will be updated.

This does not load agent’s hyper-parameters.

Warning

This function does not update trainer/optimizer variables (e.g. momentum). As such training after using this function may lead to less-than-optimal results.

Parameters: load_path_or_dict – (str or file-like or dict) Save parameter location or dict of parameters as variable.name -> ndarrays to be loaded. exact_match – (bool) If True, expects load dictionary to contain keys for all variables in the model. If False, loads parameters only for variables mentioned in the dictionary. Defaults to True.
predict(observation, state=None, mask=None, deterministic=False)[source]

Get the model’s action from an observation

Parameters: observation – (np.ndarray) the input observation state – (np.ndarray) The last states (can be None, used in recurrent policies) mask – (np.ndarray) The last masks (can be None, used in recurrent policies) deterministic – (bool) Whether or not to return deterministic actions. (np.ndarray, np.ndarray) the model’s action and the next state (used in recurrent policies)
pretrain(dataset, n_epochs=10, learning_rate=0.0001, adam_epsilon=1e-08, val_interval=None)[source]

Pretrain a model using behavior cloning: supervised learning given an expert dataset.

NOTE: only Box and Discrete spaces are supported for now.

Parameters: dataset – (ExpertDataset) Dataset manager n_epochs – (int) Number of iterations on the training set learning_rate – (float) Learning rate adam_epsilon – (float) the epsilon value for the adam optimizer val_interval – (int) Report training and validation losses every n epochs. By default, every 10th of the maximum number of epochs. (BaseRLModel) the pretrained model
save(save_path, cloudpickle=False)[source]

Save the current parameters to file

Parameters: save_path – (str or file-like) The save location cloudpickle – (bool) Use older cloudpickle format instead of zip-archives.
set_env(env)[source]

Checks the validity of the environment, and if it is coherent, set it as the current environment.

Parameters: env – (Gym Environment) The environment for learning a policy
set_random_seed(seed: Optional[int]) → None[source]
Parameters: seed – (Optional[int]) Seed for the pseudo-random generators. If None, do not change the seeds.
setup_model()[source]

Create all the functions and tensorflow graphs necessary to train the model