Skip to content

Commit

Permalink
final changes
Browse files Browse the repository at this point in the history
  • Loading branch information
ewgenius committed Feb 23, 2024
1 parent 17e7b6d commit f56d15b
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 116 deletions.
2 changes: 1 addition & 1 deletion spiceaidocs/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ anchor = "smart"
[[menu.main]]
name = "GitHub"
weight = 50
url = "https://github.com/spiceai"
url = "https://github.com/spiceai/spiceai"
[[menu.main]]
name = "Blog"
weight = 60
Expand Down
18 changes: 7 additions & 11 deletions spiceaidocs/content/en/cli/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,15 @@ A typical command-line workflow might be as follows:
spice run
```

In another terminal:
Run new shell in the same folder:

```bash
# Add a pod
spice add samples/gardener
# Re-train
spice train gardener
# Init new app
spice init spice_app

# Add the Quickstart Spicepod
spice add spiceai/quickstart

```

Common commands are:
Expand Down Expand Up @@ -75,9 +77,3 @@ spice upgrade
The Spice.ai CLI is installed by default to `$HOME/.spice/bin/spice` and a line added to the shell config, such as `.zshrc`

It can be uninstalled by deleting the `spice` binary and removing the PATH addition from the rc file.

Find all of the Docker images that were installed by running:

```bash
docker image ls -f reference="ghcr.io/spiceai/*"
```
43 changes: 0 additions & 43 deletions spiceaidocs/content/en/cli/reference/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ spice [command] [--help]
| help | Help about any command |
| init | Initialize Pod - initializes a new pod in the project |
| login | Login to Spice.ai |
| pods | Retrieve pods |
| run | Run Spice.ai - starts the Spice.ai runtime, installing if necessary |
| sql | Start an interactive SQL query session against the Spice.ai runtime |
| upgrade | Upgrades the Spice CLI to the latest release |
Expand All @@ -35,45 +34,3 @@ spice [command] [--help]
All commands have a help flag **--help** or **-h** to print its usage documentation:

- **--help** | **-h** : Print the help message

### Export

```bash
spice export <podname> [--tag <tag>] [--overwrite] [--output <directory>]
```

- **--tag <tag>** : The tag to export the model from (default: "latest")
- **--overwrite** : Overwrite a file that already exists
- **--output <directory>** | **-o <directory>** : The output directory (default: ".")

### Import

```bash
spice import <podname> [--tag <tag>]
```

- **--tag <tag>** : Specify which tag to import the model to (default: "latest")

### Run

```bash
spice run [--context <context>]
```

- **--context <context>** : Runs Spice.ai in the given context, either 'docker' or 'metal' (default: "docker")

### Train

```bash
spice train [--context <context>] [--learning-algorithm <algorithm>]
```

- **--context <context>** : Runs Spice.ai in the given context, either 'docker' or 'metal' (default: "docker")
- **--learning-algorithm <algorithm>** : Train the pod with specified algorithm (default: "dql" or inherited from pod)
- **--loggers <loggers>**: Train the pod with the specified comma-seperated list of loggers

### Pods

```bash
spice pods list
```
2 changes: 1 addition & 1 deletion spiceaidocs/content/en/concepts/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The `spice` command line tool for interacting with the Spice.ai runtime during d

## Spice Runtime

The Spice core runtime which runs as the daemon `spiced` and includes the AI and Data engines.
The Spice core runtime which runs as the daemon `spiced` and includes the ML and Data engines.

## [spicerack.org](https://spicerack.org)

Expand Down
25 changes: 2 additions & 23 deletions spiceaidocs/content/en/reference/Spicepod/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,27 +72,6 @@ datasets:
refresh: 1h
```

## `functions`

A Spicepod can contain one or more [functions](https://docs.spice.ai/reference/specifications/spice-functions-yaml-specification) referenced by relative path.

**Example**

A function referenced by path.

```yaml
functions:
- from: functions/nft_mint_counter
```

A function with a dependency on a dataset.

```yaml
functions:
- from: functions/nft_mint_counter
dependsOn: datasets/uniswap_v2_eth_usdc
```

## `models`

A Spicepod can contain one or more [models](https://docs.spice.ai/reference/specifications/models-yaml-specification) referenced by relative path.
Expand All @@ -102,7 +81,7 @@ A Spicepod can contain one or more [models](https://docs.spice.ai/reference/spec
A model referenced by path.

```yaml
functions:
models:
- from: models/gas_fees
```

Expand All @@ -112,6 +91,6 @@ A list of dependent Spicepods.

```yaml
dependencies:
- lukekim/demo:0.1
- lukekim/demo
- spicehq/nfts
```
4 changes: 2 additions & 2 deletions spiceaidocs/content/en/reference/Spicepod/datasets.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,14 +112,14 @@ Optional. Enable or disable acceleration.

## `acceleration.refresh`

Optional. The interval to refresh the data for the dataset if the dataset type is overwrite. Specified as a [duration literal]({{<ref "reference/duration">}}).
Optional. The interval to refresh the data for the dataset if the dataset type is overwrite.

For `append` datasets, the refresh interval not used.

i.e. `1h` for 1 hour, `1m` for 1 minute, `1s` for 1 second, etc.

## `acceleration.retention`

Optional. Only supported for `append` datasets. Specifies how long to retain data updates from the data source before they are deleted. Specified as a [duration literal]({{<ref "reference/duration">}}).
Optional. Only supported for `append` datasets. Specifies how long to retain data updates from the data source before they are deleted.

If not specified, the default retention is to keep all data.
35 changes: 0 additions & 35 deletions spiceaidocs/content/en/reference/duration.md

This file was deleted.

0 comments on commit f56d15b

Please sign in to comment.