From f8030a81fbfad72808ac1c9c178751610e61d988 Mon Sep 17 00:00:00 2001 From: Jack Eadie Date: Fri, 8 Mar 2024 11:50:58 +1000 Subject: [PATCH] Update docs main page (#105) * rewrite '/' route to have new details * Move core concepts as a main page --------- Co-authored-by: Evgenii Khramkov --- spiceaidocs/config.toml | 2 +- spiceaidocs/content/en/_index.md | 52 ++++++------------- spiceaidocs/content/en/concepts/_index.md | 45 ---------------- .../content/en/getting-started/_index.md | 2 +- 4 files changed, 18 insertions(+), 83 deletions(-) delete mode 100644 spiceaidocs/content/en/concepts/_index.md diff --git a/spiceaidocs/config.toml b/spiceaidocs/config.toml index 86f3df16..d261e5a2 100644 --- a/spiceaidocs/config.toml +++ b/spiceaidocs/config.toml @@ -1,5 +1,5 @@ languageCode = 'en-us' -baseURL = "/concepts" +baseURL = "/" enableRobotsTXT = true diff --git a/spiceaidocs/content/en/_index.md b/spiceaidocs/content/en/_index.md index 94674fd9..848dc650 100644 --- a/spiceaidocs/content/en/_index.md +++ b/spiceaidocs/content/en/_index.md @@ -4,55 +4,35 @@ no_list: true --- # Spice +## What is Spice? -**Spice** makes it easy for developers to build apps that learn and adapt by streamlining the use of machine learning (ML) in software. Combined with time-series data, developers can create applications that continuously improve using ML recommendations. +**Spice** is a portable runtime that provides developers with a unified SQL query interface to locally accelerate and query data tables sourced from any database, data warehouse, or data lake. -Spice takes a developer-first approach, and is focused on a fast, iterative, inner development loop, enabling developers to get started with ML in minutes instead of months. +Spice makes it easy to build data-driven and data-intensive applications by streamlining the use of data and machine learning (ML) in software. -πŸ“’ Read the Spice announcement blog post at [blog.spiceai.org](https://blog.spiceai.org/posts/2021/09/07/introducing-spice.ai-open-source-time-series-ai-for-developers/). +The Spice runtime is written in Rust and leverages industry leading technologies like Apache DataFusion, Apache Arrow, Apache Arrow Flight, and DuckDB. -πŸ“Ί View a getting started walkthrough of Spice in action [here](https://www.youtube.com/watch?v=DKBLjuAz_lI). +## Why Spice? -## Features +Spice makes querying data by SQL across one or more data sources simple and fast. Easily co-locate a managed working set of your data with your application or ML, locally accelerated in-memory, with DuckDB, or with an attached database like PostgreSQL for high-performance, low-latency queries. -The Spice runtime is written in Golang and Python and runs as a container or microservice. It's deployable to any public cloud, on-premises, and edge. It is configured with a simple manifest and accessed by HTTP APIs. +### Before Spice -Spice includes: +old -- A lightweight, portable ML runtime accessible by simple HTTP APIs, allowing developers to use their preferred languages and frameworks -- A dashboard to visualize data and learning -- A developer-friendly CLI -- Simple, git-committable, configuration and code +### With Spice -### Community-Driven Data Components +new -Spice also includes a library of community-driven [data components](https://github.com/spiceai/data-components-contrib) for streaming and processing time series data, enabling developers to quickly and easily combine data with learning to create intelligent models. +### Example Use-Cases -### Spicepod registry +**1. Faster frontends.** Accelerate and co-locate data views with your frontend application, to serve more concurrent users with faster page loads and data updates. -Modern developers build with the community by leveraging registries such as npm, NuGet, and pip. The Spice platform includes [spicerack.org](https://spicerack.org), the registry for ML building blocks. +**2. Faster analytics and BI.** -As the community shares their ML building blocks (aka Spicepods, or pods for short), developers can quickly add them to their Spice.ai applications enabling them to stream data and build learning into their applications quickly and easily. Initially, Spicepods contain simple definitions of how the app should learn, and eventually will enable the sharing and use of fully-trained models. +**3. Faster machine learning training and inferencing.** -

- -

- -## Why Spice.ai? - -Spice.ai is for developers who want to build intelligent applications but don't have the time or resources to learn, build and integrate the required ML to do so. - -Imagine you have timestamped measurements of the room temperature and access to air-conditioning controls. If you had a time-series ML engine, your application could optimize when the A/C activates. You could reduce energy usage by not overcooling the room as the temperature drops. - -Now imagine learning Python or R, neural networks, deep-learning algorithms and building a system that streams and processes time-series data to do that. With Spice.ai β€” which includes a time-series ML engine accessible over HTTP APIs, a library of community-driven components for data streaming and processing, and an ecosystem of pre-created ML configurations β€” you can build upon the experience of the community instead of doing it all yourself. You can focus on business logic and building your application instead of the ML. - -### Pre-release software - -⚠️ The vision to make it easy to build intelligent applications that learn is a vast undertaking. We haven't figured it all out or solved all the problems yet, so we’re inviting you on this journey and are looking for feedback the direction. - -Spice.ai and spicerack.org are both pre-release, early, alpha software. Until v1.0, Spice.ai may have gaps, including limited deep learning algorithms, training-at-scale, and simulated environments. Also, Spicepods aren't searchable or listed on spicerack.org yet. - -Our intention with this preview is to work with developers early to define and create the developer experience together. πŸš€ See the [Roadmap to v1.0-stable](https://github.com/spiceai/spiceai/blob/trunk/docs/ROADMAP.md#spice-ai-v10-stable-roadmap) for upcoming features. +⚠️ **DEVELOPER PREVIEW** Spice is under active **alpha** stage development and is not intended to be used in production until its **1.0-stable** release. ### Join us! @@ -76,7 +56,7 @@ Thank you for sharing this journey with us. πŸ™
Concepts

Learn about Spice.ai concepts and terminology.

- +
diff --git a/spiceaidocs/content/en/concepts/_index.md b/spiceaidocs/content/en/concepts/_index.md deleted file mode 100644 index 2f3c4d3d..00000000 --- a/spiceaidocs/content/en/concepts/_index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -type: docs -title: "Spice.ai Core Concepts" -linkTitle: "Core Concepts" -weight: 10 -no_list: true ---- - -## What is Spice? - -**Spice** is a portable runtime that provides developers with a unified SQL query interface to locally accelerate and query data tables sourced from any database, data warehouse, or data lake. - -Spice makes it easy to build data-driven and data-intensive applications by streamlining the use of data and machine learning (ML) in software. - -The Spice runtime is written in Rust and leverages industry leading technologies like Apache DataFusion, Apache Arrow, Apache Arrow Flight, and DuckDB. - -## Why Spice? - -Spice makes querying data by SQL across one or more data sources simple and fast. Easily co-locate a managed working set of your data with your application or ML, locally accelerated in-memory, with DuckDB, or with an attached database like PostgreSQL for high-performance, low-latency queries. - -### Before Spice - -old - -### With Spice - -new - -## Spice CLI - -The `spice` command line tool for interacting with the Spice.ai runtime during development. View the [CLI reference]({{}}) to learn more. - -## Spice Runtime - -The Spice core runtime which runs as the daemon `spiced` and includes the ML and Data engines. - -## [spicerack.org](https://spicerack.org) - -The registry [spicerack.org](https://spicerack.org) of Spice.ai pods that can be fetched with the Spice.ai CLI. - -## Spicepod - -A `Spicepod` is a package of configuration and data used to train and deploy Spice.ai with an application. - -A `Spicepod manifest` is a YAML file that describes how to connect data with a learning environment. diff --git a/spiceaidocs/content/en/getting-started/_index.md b/spiceaidocs/content/en/getting-started/_index.md index c594459d..6b3e7754 100644 --- a/spiceaidocs/content/en/getting-started/_index.md +++ b/spiceaidocs/content/en/getting-started/_index.md @@ -8,7 +8,7 @@ no_list: true --- {{% alert title="Spice.ai Concepts" color="primary" %}} -Before following this guide it is first recommended to review the Spice.ai [core concepts]({{}}). +Before following this guide it is first recommended to review the Spice.ai [core concepts](/). {{% /alert %}} ### Follow these steps to get started with Spice.ai.