You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update CSV logger guide for change in goal count reporting
Related to Kinds-of-Intelligence-CFI/animal-ai-unity@8028d83
Also, fix a typo, add a limitation re not being able to not write CSV files, and remove the conclusion (which I don't think was adding any value)
Copy file name to clipboardExpand all lines: docs/CSVLoggerGuide.md
+6-8Lines changed: 6 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,6 @@
6
6
*[How does the CSV Logger feature work?](#how-does-the-csv-logger-work)
7
7
*[What data is logged?](#what-data-is-logged)
8
8
*[Notes/Limitations](#notes-limitations)
9
-
*[Conclusion](#conclusion)
10
9
11
10
## Introduction
12
11
@@ -29,7 +28,7 @@ To access the .`csv file`, navigate to the `AnimalAI/ObservationLogs` directory
29
28
Currently, the CSV Logger records the following data:
30
29
31
30
***Episode**
32
-
***Ste** (the below data is logged at each step)
31
+
***Step** (the below data is logged at each step)
33
32
***Health**
34
33
***Reward**
35
34
***Velocity** (x, y, z)
@@ -45,17 +44,16 @@ Currently, the CSV Logger records the following data:
45
44
***Was Agent In DataZone?** (i.e. was the Agent in the DataZone at step n)
46
45
***Active Camera** (i.e. which camera was active at step n)
47
46
***Combined Raycast Data** (i.e. what was the raycast data at step n)
48
-
***Goals Collected (Count)** (i.e. how many goals were collected at every 101 steps). This data is presented in a row, not a column.
49
47
50
48
The above data is logged at each step, providing a detailed record of the experiment. This data can be used to analyze agent behavior, track progress, and compare results across different experiments.
51
49
50
+
Additionally, the following summaries are added to the CSV file after each episode
51
+
***Positive Goals Collected** This is the count of positive goals collected during the episode
52
+
52
53
### Notes/Limitations
53
54
55
+
* There is no way to disable writing the CSV file currently. A feature for this will be added, but please get in touch if it is causing you issues and we can prioritise adding this feature.
54
56
* Due to a bug during training, the first and second episodes are not logged. This issue is to be being addressed in a future release. However, this is only a problem during training, and the CSV Logger works as expected in Play mode.
55
57
* The .csv file can't be saved anywhere else. It is saved in the `AnimalAI/ObservationLogs` directory by default.
56
58
* Multiple `.csv files` can't be generated at the same time. The CSV Logger generates a single .csv file for each Animal-AI session. This is to prevent data from being overwritten or lost.
57
-
* The name of the .csv file is based on the date and time when Animal-AI was launched. This naming convention helps to identify the file easily. It is recommended to rename the file if you want to keep multiple files for comparison.
58
-
59
-
### Conclusion
60
-
61
-
The CSV Logger feature is a powerful tool for tracking and analyzing experiment outcomes. It automatically records detailed data to a CSV file, eliminating the need for manual logging. This feature is enabled by default in both Play and Train modes, making it easy to track and compare results.
59
+
* The name of the .csv file is based on the date and time when Animal-AI was launched. This naming convention helps to identify the file easily. It is recommended to rename the file if you want to keep multiple files for comparison.
0 commit comments