Skip to content

Commit f71ae84

Browse files
author
Marwan Mattar
authored
Merge pull request #488 from Unity-Technologies/docs/random-fixes
Fixed code formating and links.
2 parents 8e0014c + 8ac16c5 commit f71ae84

15 files changed

+318
-272
lines changed

docs/Background-Unity.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ with ML-Agents:
1010
* [Editor](https://docs.unity3d.com/Manual/UsingTheEditor.html)
1111
* [Interface](https://docs.unity3d.com/Manual/LearningtheInterface.html)
1212
* [Scene](https://docs.unity3d.com/Manual/CreatingScenes.html)
13-
* [GameObjects](https://docs.unity3d.com/Manual/GameObjects.html)
13+
* [GameObject](https://docs.unity3d.com/Manual/GameObjects.html)
1414
* [Rigidbody](https://docs.unity3d.com/ScriptReference/Rigidbody.html)
1515
* [Camera](https://docs.unity3d.com/Manual/Cameras.html)
1616
* [Scripting](https://docs.unity3d.com/Manual/ScriptingSection.html)
17+
* [Physics](https://docs.unity3d.com/Manual/PhysicsSection.html)
1718
* [Ordering of event functions](https://docs.unity3d.com/Manual/ExecutionOrder.html)
1819
(e.g. FixedUpdate, Update)

docs/Feature-Memory.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Using Recurrent Neural Networks in ML-Agents
1+
# Memory-enhanced Agents using Recurrent Neural Networks
22

33
## What are memories for?
44
Have you ever entered a room to get something and immediately forgot
@@ -19,10 +19,10 @@ track of what is important to remember with [LSTM](https://en.wikipedia.org/wiki
1919
When configuring the trainer parameters in the `trainer_config.yaml`
2020
file, add the following parameters to the Brain you want to use.
2121

22-
```
23-
use_recurrent: true
24-
sequence_length: 64
25-
memory_size: 256
22+
```json
23+
use_recurrent: true
24+
sequence_length: 64
25+
memory_size: 256
2626
```
2727

2828
* `use_recurrent` is a flag that notifies the trainer that you want
@@ -43,5 +43,3 @@ and Unity, using too large `memory_size` will slow down training.
4343
* Adding a recurrent layer increases the complexity of the neural
4444
network, it is recommended to decrease `num_layers` when using recurrent.
4545
* It is required that `memory_size` be divisible by 4.
46-
47-

docs/Feature-Monitor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The monitor allows visualizing information related to the agents or training pro
66

77
You can track many different things both related and unrelated to the agents themselves. To use the Monitor, call the Log function anywhere in your code :
88
```csharp
9-
Monitor.Log(key, value, displayType , target)
9+
Monitor.Log(key, value, displayType , target)
1010
```
1111
* *`key`* is the name of the information you want to display.
1212
* *`value`* is the information you want to display.

docs/Getting-Started-with-Balance-Ball.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -269,10 +269,8 @@ on the same graph.
269269

270270
To summarize, go to your command line, enter the `ml-agents` directory and type:
271271

272-
```
273-
272+
```python
274273
python3 python/learn.py <env_file_path> --run-id=<run-identifier> --train
275-
276274
```
277275

278276
The `--train` flag tells ML-Agents to run in training mode. `env_file_path` should be the path to the Unity executable that was just created.
@@ -282,7 +280,7 @@ The `--train` flag tells ML-Agents to run in training mode. `env_file_path` shou
282280

283281
Once you start training using `learn.py` in the way described in the previous section, the `ml-agents` folder will
284282
contain a `summaries` directory. In order to observe the training process
285-
in more detail, you can use TensorBoard. From the command line run :
283+
in more detail, you can use TensorBoard. From the command line run:
286284

287285
`tensorboard --logdir=summaries`
288286

docs/Installation-Windows.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -174,9 +174,7 @@ pip install tensorflow-gpu
174174

175175
Lastly, you should test to see if everything installed properly and that TensorFlow can identify your GPU. In the same Anaconda Prompt, type in the following command:
176176

177-
```
178-
python
179-
177+
```python
180178
import tensorflow as tf
181179

182180
sess = tf.Session(config=tf.ConfigProto(log_device_placement=True))

0 commit comments

Comments
 (0)