stable_learning_control.user_config

File used for storing several configuration values for the SLC package.

 1
 2import os.path as osp
 3
 4# Default neural network backend for each algo (Must be either 'tf2' or 'pytorch').
 5DEFAULT_BACKEND = {
 6    "lac": "pytorch",
 7    "latc": "pytorch",
 8    "sac": "pytorch",
 9}
10
11# Where experiment outputs are saved by default:
12DEFAULT_DATA_DIR = osp.join(osp.abspath(osp.dirname(osp.dirname(__file__))), "data")
13
14# Whether to automatically insert a date and time stamp into the names of save
15# directories:
16FORCE_DATESTAMP = False
17
18# Whether GridSearch provides automatically-generated default shorthands:
19DEFAULT_SHORTHAND = True
20
21# Tells the GridSearch how many seconds to pause for before launching experiments.
22WAIT_BEFORE_LAUNCH = 5
23
24# Print experiment config to terminal.
25PRINT_CONFIG = False
26
27# Logger stdout output type.
28# NOTE:The format in which the training diagnostics are displayed to the terminal.
29# Options are "table"  which supplies them as a table and "line" which prints them in
30# one line.
31DEFAULT_STD_OUT_TYPE = "line"
32
33# Weights & Biases default job type and project.
34DEFAULT_WANDB_JOB_TYPE = "train"
35DEFAULT_WANDB_PROJECT = "stable-learning-control"
36
37# TensorBoard parameters.
38TB_HPARAMS_FILTER = [
39    "epochs",
40    "num_of_test_episodes",
41    "seed",
42    "device",
43    "save_freq",
44    "start_policy",
45    "export",
46]  # Config keys to filter out when writing hyperparameters to TensorBoard.
47TB_HPARAMS_METRICS = [
48    "AverageEpRet",
49    "AverageTestEpRet",
50]  # The metrics to be tracked in TensorBoard.

Attributes

DEFAULT_BACKEND

DEFAULT_DATA_DIR

FORCE_DATESTAMP

DEFAULT_SHORTHAND

WAIT_BEFORE_LAUNCH

PRINT_CONFIG

DEFAULT_STD_OUT_TYPE

DEFAULT_WANDB_JOB_TYPE

DEFAULT_WANDB_PROJECT

TB_HPARAMS_FILTER

TB_HPARAMS_METRICS

Module Contents

stable_learning_control.user_config.DEFAULT_BACKEND[source]
stable_learning_control.user_config.DEFAULT_DATA_DIR[source]
stable_learning_control.user_config.FORCE_DATESTAMP = False[source]
stable_learning_control.user_config.DEFAULT_SHORTHAND = True[source]
stable_learning_control.user_config.WAIT_BEFORE_LAUNCH = 5[source]
stable_learning_control.user_config.PRINT_CONFIG = False[source]
stable_learning_control.user_config.DEFAULT_STD_OUT_TYPE = 'line'[source]
stable_learning_control.user_config.DEFAULT_WANDB_JOB_TYPE = 'train'[source]
stable_learning_control.user_config.DEFAULT_WANDB_PROJECT = 'stable-learning-control'[source]
stable_learning_control.user_config.TB_HPARAMS_FILTER = ['epochs', 'num_of_test_episodes', 'seed', 'device', 'save_freq', 'start_policy', 'export'][source]
stable_learning_control.user_config.TB_HPARAMS_METRICS = ['AverageEpRet', 'AverageTestEpRet'][source]