Skip to content

Commit

Permalink
Clarify Arrow engine usage (#445)
Browse files Browse the repository at this point in the history
* Clarify Arrow engine usage

* Update spiceaidocs/docs/components/data-accelerators/arrow.md
  • Loading branch information
lukekim authored Oct 7, 2024
1 parent 1b82e22 commit 1dbb75c
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion spiceaidocs/docs/components/data-accelerators/arrow.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,26 @@ The In-Memory Arrow Data Accelerator is the default data accelerator in Spice. I

## Configuration

To use the In-Memory Arrow Data Accelerator, specify `arrow` as the `engine` for acceleration.
To use the In-Memory Arrow Data Accelerator, no additional configuration is required beyond enabling acceleration.

Example:

```yaml
datasets:
- from: spice.ai:path.to.my_dataset
name: my_dataset
acceleration:
enabled: true
```
However Arrow can be specified explicitly using `arrow` as the `engine` for acceleration.

```yaml
datasets:
- from: spice.ai:path.to.my_dataset
name: my_dataset
acceleration:
enabled: true
engine: arrow
```

Expand Down

0 comments on commit 1dbb75c

Please sign in to comment.