Skip to content

Commit

Permalink
Update training loggers with format change (#91)
Browse files Browse the repository at this point in the history
  • Loading branch information
lukekim authored Dec 29, 2021
1 parent 6985bb6 commit 30630ff
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 21 deletions.
4 changes: 2 additions & 2 deletions spiceaidocs/content/en/concepts/dataspaces/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ Each dataspace encapsulates definitions for its core data primitives, such as [m

While measurements and categories are scoped to the dataspace namespace, tags are aggregated with tags from other dataspaces to the pod scope.

Dataspaces may load data through a [data connector](https://docs.spiceai.org/concepts/#data-connector) and [processor](https://docs.spiceai.org/concepts/#data-processor) or through the POST [/pods/{pod}/observations]({{<ref api>}}) API. The API accepts JSON or CSV data and uses the appropriate [JSON](https://github.com/spiceai/data-components-contrib/blob/trunk/dataprocessors/json/README.md) or [CSV](https://github.com/spiceai/data-components-contrib/tree/trunk/dataprocessors/csv) data processor.
Dataspaces may load data through a [data connector](https://docs.spiceai.org/concepts/#data-connector) and [processor](https://docs.spiceai.org/concepts/#data-processor) or through the POST [/pods/{pod}/observations]({{<ref api>}}) API. The API accepts JSON or CSV data and uses the appropriate [JSON](https://github.com/spiceai/data-components-contrib/blob/trunk/dataprocessors/json/README.md) or [CSV](https://github.com/spiceai/data-components-contrib/tree/trunk/dataprocessors/csv) data processor.

Data connectors and processors are community-maintained components for streaming and processing time-series data. More information can be found in the [data-components-contrib](https://github.com/spiceai/data-components-contrib) repository.

### Reference

- List of [supported data connectors](https://github.com/spiceai/data-components-contrib/tree/trunk/dataconnectors/README.md)
- List of [supported data processors](https://github.com/spiceai/data-components-contrib/blob/trunk/dataprocessors/README.md)
- [API Reference]({{<ref "api">}})
- [API Reference]({{<ref "api">}})
35 changes: 18 additions & 17 deletions spiceaidocs/content/en/reference/pod/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,23 +114,6 @@ params:
episodes: 10
```

### `params.training_loggers`

A comma-seperated list of training loggers to enable for each pod training run.

Supported loggers and their values are:

| Logger | Value |
| ------------------------------------------------------ | ------------- |
| [TensorBoard](https://www.tensorflow.org/tensorboard/) | `tensorboard` |

**_Example_**

```yaml
params:
training_loggers: tensorboard
```

## `time`

Pod time, time-series and time-data related configuration is defined in the `time` section.
Expand Down Expand Up @@ -771,6 +754,24 @@ training:
goal: score >= 100
```

### `training.loggers`

A list of training loggers to enable for each pod training run.

Supported loggers and their values are:

| Logger | Value |
| ------------------------------------------------------ | ------------- |
| [TensorBoard](https://www.tensorflow.org/tensorboard/) | `tensorboard` |

**_Example_**

```yaml
training:
loggers:
- tensorboard
```

### `training.reward_init`

A python code block that will be run before an action specific reward code block runs. Use this to define common variables that will be useful to reference in the specific reward code blocks.
Expand Down
4 changes: 2 additions & 2 deletions spiceaidocs/content/en/training/monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Training run progress can also be visualized in the dashboard [http://localhost:

Spice.ai supports logging to monitoring tools like [TensorBoard](https://www.tensorflow.org/tensorboard/).

This logging can either be enabled at the pod level using the `training_loggers` Spicepod parameter or as a parameter to the `spice train` command. Once enabled, the runtime will log training metrics for that tool.
This logging can either be enabled at the pod level using the `training.loggers` Spicepod section or as a parameter to the `spice train` command. Once enabled, the runtime will log training metrics for that tool.

A button to open the tool will appear on the training run in the dashboard. Clicking the button will open the relevant monitoring tool.

Expand All @@ -65,5 +65,5 @@ A button to open the tool will appear on the training run in the dashboard. Clic

See documentation for:

- The Spicepod [training_loggers param]({{<ref "reference/pod#paramstraining_loggers">}}).
- The Spicepod [training.loggers section]({{<ref "reference/pod#trainingloggers">}}).
- The [spice train]({{<ref "cli/reference/#train">}}) CLI command.

0 comments on commit 30630ff

Please sign in to comment.