Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v0.7-alpha updates #100

Merged
merged 12 commits into from
Feb 23, 2024
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]
Copyright 2023 Spice AI, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
105 changes: 105 additions & 0 deletions spiceaidocs/content/en/reference/Spicepod/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
---
type: docs
title: 'Manifest syntax for Spicepods'
linkTitle: 'Spicepod specification'
weight: 60
description: 'Detailed documentation on the Spicepod manifest syntax (spicepod.yaml)'
---

## About YAML syntax for Spicepod manifests (spicepod.yaml)

Spicepod manifests use YAML syntax and must be named `spicepod.yaml` or `spicepod.yml`. If you're new to YAML and want to learn more, see "[Learn YAML in Y minutes](https://learnxinyminutes.com/docs/yaml/)."

Spicepod manifest files are stored in the root directory of your application code.

## `version`

The version of the Spicepod manifest. The current version is `v1beta1`.

## `kind`

The kind of Spicepod manifest. The kind is `Spicepod`.

## `name`

The name of the Spicepod.

## `metadata`

An optional `map` of metadata.

**Example**

```yaml
metadata:
epoch_time: 1605312000
period: 72h
interval: 1m
granularity: 10s
episodes: 10
```

## `datasets`

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

**Example**

A datasets referenced by relative path.

```yaml
datasets:
- from: datasets/uniswap_v2_eth_usdc
```

A datasets with a dependency on another dataset.

```yaml
datasets:
- from: datasets/uniswap_v2_eth_usdc
dependsOn: datasets/uniswap_eth_usdc
```

## `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
ewgenius marked this conversation as resolved.
Show resolved Hide resolved
```

## `models`

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

**Example**

A model referenced by path.

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

## `dependencies`

A list of dependent Spicepods.

```yaml
dependencies:
- lukekim/demo:0.1
ewgenius marked this conversation as resolved.
Show resolved Hide resolved
- spicehq/nfts
ewgenius marked this conversation as resolved.
Show resolved Hide resolved
```
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
---
type: docs
title: "Trader"
linkTitle: "Example - Trader"
title: 'Trader'
linkTitle: 'Example - Trader'
weight: 70
---

From: https://github.com/spiceai/quickstarts/tree/trunk/trader

```yaml
version: v1beta1
kind: Spicepod
name: trader
params:
epoch_time: 1605312000
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
---
type: docs
title: "Gardener"
linkTitle: "Example - Gardener"
title: 'Gardener'
linkTitle: 'Example - Gardener'
weight: 60
---

From: https://github.com/spiceai/samples/blob/trunk/gardener/README.md

```yaml
version: v1beta1
kind: Spicepod
name: gardener
params:
epoch_time: 1612557000
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
---
type: docs
title: "Server Ops"
linkTitle: "Example - Server Ops"
title: 'Server Ops'
linkTitle: 'Example - Server Ops'
weight: 80
---

From: https://github.com/spiceai/samples/tree/trunk/serverops

```yaml
version: v1beta1
kind: Spicepod
name: serverops
params:
period: 24h
Expand Down
Loading
Loading