Skip to content

Commit

Permalink
Remove references to extras_spec in tasks_guide.md.
Browse files Browse the repository at this point in the history
`Task.extras_spec` is not a reliable mechanism since tasks can "lie" about
their extras (or it can also be incomplete and/or just wrong). It also doesn't
play well with dynamic tasks that change shape and/or data types during their
lifetime, which is especially common in continual learning settings. The field
will eventually be removed from the `Task` protobuf message.

PiperOrigin-RevId: 547189863
  • Loading branch information
kenjitoyama authored and copybara-github committed Jul 11, 2023
1 parent 2da16b2 commit 5220c8b
Showing 1 changed file with 0 additions and 13 deletions.
13 changes: 0 additions & 13 deletions docs/tasks_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,6 @@ how to put these into code.
of the form `reward: 1.0`, then the task will capture this info using
the regexp `^[Rr]eward: ([-+]?[0-9]*\\.?[0-9]*)$`.

* `extras_spec`: Determines the type and shape of extras exposed by the task.
Extras are usually parsed from logcat messages.

</details>

<details>
Expand Down Expand Up @@ -169,16 +166,6 @@ log_parsing_config: {
json_extra: "^json_extra: (?P<json_extra>.*)$"
}
}

# Capture expected shape and type of extras
extras_spec: [
# Grid representing the state of the board.
{ name: "grid" shape: [4, 4], dtype: INT32},
# Direction of the last swipe action that prompted that change in the state.
# 0: up, 1: right, 2: down, 3: left
{ name: "direction" shape: [1], dtype: INT32 }
]

```

</details>
Expand Down

0 comments on commit 5220c8b

Please sign in to comment.