update project1

docs/chapter3/project1.md

@@ -1,8 +1,10 @@
 # 使用Q-learning解决悬崖寻路问题
 
+强化学习在运动规划方面也有很大的应用前景，具体包括路径规划与决策，群体派单等等，本次项目就将单体运动规划抽象并简化，让大家初步认识到强化学习在这方面的应用。在运动规划方面，其实已有很多适用于强化学习的仿真环境，小到迷宫，大到贴近真实的自动驾驶环境[CARLA](http://carla.org/)，对这块感兴趣的童鞋可以再多搜集一点。本项目采用gym开发的```CliffWalking-v0```环境，在上面实现一个简单的Q-learning入门demo。
+
 ## CliffWalking-v0环境简介
 
-悬崖寻路问题（CliffWalking）是指在一个4 x 12的网格中，智能体以网格的左下角位置为起点，以网格的下角位置为终点，目标是移动智能体到达终点位置，智能体每次可以在上、下、左、右这4个方向中移动一步，每移动一步会得到-1单位的奖励。
+首先对该环境做一个简介，该环境中文名称叫悬崖寻路问题（CliffWalking），是指在一个4 x 12的网格中，智能体以网格的左下角位置为起点，以网格的下角位置为终点，目标是移动智能体到达终点位置，智能体每次可以在上、下、左、右这4个方向中移动一步，每移动一步会得到-1单位的奖励。
 
 ![](assets/cliffwalking_1.png)
 
@@ -18,67 +20,64 @@
 
 ![](assets/cliffwalking_2.png)
 
-**由于从起点到终点最少需要13步，每步得到-1的reward，因此最佳训练算法下，每个episode下reward总和应该为-13**。
+**由于从起点到终点最少需要13步，每步得到-1的reward，因此最佳训练算法下，每个episode下reward总和应该为-13**。所以我们的目标也是要通过RL训练出一个模型，使得该模型能在测试中一个episode的reward能够接近于-13左右。
 
 ## RL基本训练接口
 
-```python
-    env = gym.make("CliffWalking-v0")  # 0 up, 1 right, 2 down, 3 left
-    env = CliffWalkingWapper(env)
-    agent = QLearning(
-        obs_dim=env.observation_space.n,
-        action_dim=env.action_space.n,
-        learning_rate=cfg.policy_lr,
-        gamma=cfg.gamma,
-        epsilon_start=cfg.epsilon_start,epsilon_end=cfg.epsilon_end,epsilon_decay=cfg.epsilon_decay)
-    render = False # 是否打开GUI画面
-    rewards = [] # 记录所有episode的reward
-    MA_rewards = []  # 记录滑动平均的reward
-    steps = []# 记录所有episode的steps
-    for i_episode in range(1,cfg.max_episodes+1):
-        ep_reward = 0 # 记录每个episode的reward
-        ep_steps = 0 # 记录每个episode走了多少step
-        obs = env.reset()  # 重置环境, 重新开一局（即开始新的一个episode）
-        while True:
-            action = agent.sample(obs)  # 根据算法选择一个动作
-            next_obs, reward, done, _ = env.step(action)  # 与环境进行一个交互
-            # 训练 Q-learning算法
-            agent.learn(obs, action, reward, next_obs, done)  # 不需要下一步的action
+以下是强化学习算法的基本接口，也就是一个完整的上层训练模式，首先是初始化环境和智能体，然后每个episode中，首先agent选择action给到环境，然后环境反馈出下一个状态和reward，然后agent开始更新或者学习，如此多个episode之后agent开始收敛并保存模型。其中可以通过可视化reward随每个episode的变化来查看训练的效果。另外由于强化学习的不稳定性，在收敛的状态下也可能会有起伏的情况，此时可以使用滑动平均的reward让曲线更加平滑便于分析。
 
-            obs = next_obs  # 存储上一个观察值
-            ep_reward += reward
-            ep_steps += 1  # 计算step数
-            if render:
-                env.render()  #渲染新的一帧图形
-            if done:
-                break
-        steps.append(ep_steps)
-        rewards.append(ep_reward)
-        # 计算滑动平均的reward
-        if i_episode == 1:
-            MA_rewards.append(ep_reward)
-        else:
-            MA_rewards.append(
-                0.9*MA_rewards[-1]+0.1*ep_reward) 
-        print('Episode %s: steps = %s , reward = %.1f, explore = %.2f' % (i_episode, ep_steps,
-                                                          ep_reward,agent.epsilon))                                 
-        # 每隔20个episode渲染一下看看效果
-        if i_episode % 20 == 0:
-            render = True
-        else:
-            render = False
+```python
+  '''初始化环境'''  
+  env = gym.make("CliffWalking-v0")  # 0 up, 1 right, 2 down, 3 left
+  env = CliffWalkingWapper(env)
+  agent = QLearning(
+      obs_dim=env.observation_space.n,
+      action_dim=env.action_space.n,
+      learning_rate=cfg.policy_lr,
+      gamma=cfg.gamma,
+      epsilon_start=cfg.epsilon_start,epsilon_end=cfg.epsilon_end,epsilon_decay=cfg.epsilon_decay)
+  render = False # 是否打开GUI画面
+  rewards = [] # 记录所有episode的reward
+  MA_rewards = []  # 记录滑动平均的reward
+  steps = []# 记录所有episode的steps
+  for i_episode in range(1,cfg.max_episodes+1):
+      ep_reward = 0 # 记录每个episode的reward
+      ep_steps = 0 # 记录每个episode走了多少step
+      obs = env.reset()  # 重置环境, 重新开一局（即开始新的一个episode）
+      while True:
+          action = agent.sample(obs)  # 根据算法选择一个动作
+          next_obs, reward, done, _ = env.step(action)  # 与环境进行一个交互
+          # 训练 Q-learning算法
+          agent.learn(obs, action, reward, next_obs, done)  # 不需要下一步的action
+          obs = next_obs  # 存储上一个观察值
+          ep_reward += reward
+          ep_steps += 1  # 计算step数
+          if render:
+              env.render()  #渲染新的一帧图形
+          if done:
+              break
+      steps.append(ep_steps)
+      rewards.append(ep_reward)
+      # 计算滑动平均的reward
+      if i_episode == 1:
+          MA_rewards.append(ep_reward)
+      else:
+          MA_rewards.append(
+              0.9*MA_rewards[-1]+0.1*ep_reward) 
+      print('Episode %s: steps = %s , reward = %.1f, explore = %.2f' % (i_episode, ep_steps,
+                                                        ep_reward,agent.epsilon))                                 
     agent.save() # 训练结束，保存模型
 ```
 
 ## 任务要求
 
-训练并绘制reward以及滑动平均后的reward随episode的变化曲线图并记录超参数写成报告，图示如下：
+基于以上的目标，本次任务即使训练并绘制reward以及滑动平均后的reward随episode的变化曲线图并记录超参数写成报告，示例如下：
 
 ![rewards](assets/rewards.png)
 
 ![moving_average_rewards](assets/moving_average_rewards.png)
 
-### 代码清单
+### 主要代码清单
 
 **main.py**：保存强化学习基本接口，以及相应的超参数，可使用argparse
 
@@ -86,6 +85,8 @@
 
 **agent.py**: 保存算法模型，主要包含predict(预测动作)和learn两个函数
 
+**params.py**：保存一些参数，比如训练参数等
+
 **plot.py**：保存相关绘制函数
 
 [参考代码](https://github.com/datawhalechina/leedeeprl-notes/tree/master/codes/Q-learning)