[docs] Link to Imitation Learning docs in Readme, cleanup #3582
Conversation
| @@ -8,7 +8,7 @@ of training a medic NPC. Instead of indirectly training a medic with the help | |||
| of a reward function, we can give the medic real world examples of observations | |||
| from the game and actions from a game controller to guide the medic's behavior. | |||
| Imitation Learning uses pairs of observations and actions from | |||
| a demonstration to learn a policy. [Video Link](https://youtu.be/kpb8ZkMBFYs). | |||
There was a problem hiding this comment.
This video shows online BC, which isn't possible anymore given our current toolkit.
README.md
Outdated
| @@ -36,7 +36,7 @@ developer communities. | |||
| * Self-play mechanism for training agents in adversarial scenarios | |||
| * Train memory-enhanced agents using deep reinforcement learning | |||
| * Easily definable Curriculum Learning and Generalization scenarios | |||
| * Built-in support for Imitation Learning | |||
| * Built-in support for [Imitation Learning](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Training-Imitation-Learning.md) through Behavioral Cloning or Generative Adversarial Imitation Learning | |||
There was a problem hiding this comment.
Not sure it is recommended to use the full URL. Maybe just do
| * Built-in support for [Imitation Learning](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Training-Imitation-Learning.md) through Behavioral Cloning or Generative Adversarial Imitation Learning | |
| * Built-in support for [Imitation Learning](docs/Training-Imitation-Learning.md) through Behavioral Cloning or Generative Adversarial Imitation Learning |
There was a problem hiding this comment.
For the README it has to link to the latest_release files (and use the full path)... but you're right it was wrong. Updated.
docs/Training-Imitation-Learning.md
Outdated
| @@ -85,3 +86,6 @@ inspector. | |||
| alt="BC Teacher Helper" | |||
| width="375" border="10" /> | |||
| </p> | |||
|
|
|||
| You can then specify the path to this file in your `trainer_config.yaml` file | |||
| when using BC or GAIL. | |||
There was a problem hiding this comment.
Maybe give the name of the argument?
behavioral_cloning:
demo_path: <demo>There was a problem hiding this comment.
Added examples for GAIL and BC
| @@ -36,7 +36,7 @@ developer communities. | |||
| * Self-play mechanism for training agents in adversarial scenarios | |||
| * Train memory-enhanced agents using deep reinforcement learning | |||
| * Easily definable Curriculum Learning and Generalization scenarios | |||
| * Built-in support for Imitation Learning | |||
| * Built-in support for [Imitation Learning](https://github.com/Unity-Technologies/ml-agents/tree/latest_release/docs/Training-Imitation-Learning.md) through Behavioral Cloning or Generative Adversarial Imitation Learning | |||
There was a problem hiding this comment.
why is it linking to latest_release? (similarly for PPO/SAC)
There was a problem hiding this comment.
I believe this was discussed at a prior meeting, but it's so users who hit the Readme.md page from Github will access the latest_release docs and not the master docs.
There was a problem hiding this comment.
Yeah, that was the reason.
There was a problem hiding this comment.
The issue is that if we rename/move these files then it will result in broken links for older branches. Not a major issue, but calling it out.
Proposed change(s)
Link to the Imitation Learning docs in the Readme, and mention GAIL/BC as features. Also a bit of minor cleanup on the IL page.
Types of change(s)
Checklist