Skip to content

Commit 541a58b

Browse files
committed
Add docs for evaluation
1 parent 9147627 commit 541a58b

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ and how to implement new MDPs and new algorithms.
7171
user/environment_libraries
7272
user/concept_experiment
7373
user/sampling
74+
user/evaluation
7475
7576
.. toctree::
7677
:maxdepth: 2

docs/user/evaluation.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Evaluation
2+
3+
garage provides two useful function to evaluate the performance of an
4+
algorithm, [log_performance](../_autoapi/garage/index.html#garage.log_performance)
5+
and [log_multitask_performance](../_autoapi/garage/index.html#garage.log_multitask_performance).
6+
`log_performance` is used for generous algorithms, while
7+
`log_multitask_performance` is used for multiple tasks algorithms.
8+
9+
The input of the both functions is [EpisodeBatch](../_autoapi/garage/index.html#garage.EpisodeBatch),
10+
which is a batch of episodes.
11+
12+
These functions will evaluate algorithms in from the following aspects:
13+
14+
- `AverageReturn`: The average return (sum of rewards in an episode) of all
15+
episodes.
16+
17+
- `AverageDiscountedReturn`: The average discounted return of all episodes.
18+
19+
- `StdReturn`: The standard deviation of undiscounted returns.
20+
21+
- `MaxReturn`: The maximum undiscounted return.
22+
23+
- `MinReturn`: The minimum undiscounted return.
24+
25+
- `TerminationRate`: Terminated episodes / all episodes.
26+
27+
- `SuccessRate` (if applicable): The rate of success among all episodes.
28+
29+
----
30+
31+
*This page was authored by Ruofu Wang ([@yeukfu](https://github.com/yeukfu)).*

0 commit comments

Comments
 (0)