diff --git a/.gitignore b/.gitignore index b4b3b13..45b9404 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,8 @@ rl_lib/tests/models/ #jupiter notebooks *.ipynb + + +.vscode +requirements.txt +dist \ No newline at end of file diff --git a/README.md b/README.md index 50af15b..cb719e4 100644 --- a/README.md +++ b/README.md @@ -28,12 +28,13 @@ RL_Lib - это мощный и гибкий инструмент для обу
  • DQN и его модификации
  • DRQN
  • DDPG
  • +
  • QR_DQN
  • ## Базовое использование #### Создание алгоритма по умолчанию (конфиг можно посмотреть в папке алгоритма): ``` -from rl_lib.src.algoritms.dqn.dqn import DQN +from rl_lib import DQN config = {'model_config':{}} config['model_config']['input_shape'] = env.observation_space.shape @@ -42,25 +43,40 @@ config['model_config']['action_space'] = env.action_space.n algo = DQN(config) ``` -#### Создание алгоритма пользовательского алгоритма: +#### Загрузка пользовательской конфигурации алгоритма: ``` -from rl_lib.src.algoritms.dqn.dqn import DQN -from yaml import safe_load +from rl_lib import DQN +from rl_lib import load_default_config -path = #путь к файлу конфигурации +path = #путь к файлу конфигурации, должен оканчиваться на .yaml -config = safe_load( - open( - os_path.join( - os_path.dirname(path),"./config.yaml" - ), - "rb") - ) +config = load_default_config(path) config['model_config']['input_shape'] = env.observation_space.shape config['model_config']['action_space'] = env.action_space.n algo = DQN(config) ``` + +#### Верхнеуровневое API для обучения алгоритма: +``` +from rl_lib import DQN +from rl_lib import load_default_config +from rl_lib import Base_Env_Runner + +path = #путь к файлу конфигурации, должен оканчиваться на .yaml + +config = load_default_config(path) +config['model_config']['input_shape'] = env.observation_space.shape +config['model_config']['action_space'] = env.action_space.n +algo = DQN(config) + +runner = Base_Env_Runner(env=env, + algo=algo, + ...) + +runner.run() +``` + ## Основные методы алгоритма #### Сохранение и загрузка сохраненного алгоритма: ``` @@ -110,7 +126,6 @@ algo.initial_state()