Skip to content

Time Series Forecast API Documentation - #507

Merged
sivanantha321 merged 3 commits into
kserve:mainfrom
jinan-zhou:timeseries
Nov 10, 2025
Merged

Time Series Forecast API Documentation#507
sivanantha321 merged 3 commits into
kserve:mainfrom
jinan-zhou:timeseries

Conversation

@jinan-zhou

@jinan-zhou jinan-zhou commented Jul 24, 2025

Copy link
Copy Markdown
Contributor

Fixes

This PR adds the documentation for the Time Series LLM Forecast API. This API specification defines a consistent, extensible format for time series forecasting requests and responses and set the best practices for interoperability and clarity in the field. It describes request and response schemas, enumerations, usage examples, and best practices, supporting both univariate and multivariate time series forecasting with quantile support.

Proposed Changes

  • Introduces the first version of API documentation for /v1/timeseries/forecast, detailing request/response fields, enumerations, and usage examples.
  • Documents usage patterns for both minimal and advanced time series forecasting scenarios.
  • Clarifies extensibility through support for arbitrary metadata and additional fields.
  • Provides FAQ and best practices for robust client and server implementations.
  • Adds a changelog and table of contents for discoverability and maintainability.

Why

This documentation aims to:

  • Standardize the time series API to make integration easier for vendors, open source projects, and researchers.
  • Help users and contributors understand every request/response field and common patterns for the new forecasting API.
  • Promote best practices for extensibility, error handling, and forward compatibility.
  • Enable rapid onboarding and clear guidance for all users of time series LLMs and related services.

Implementation

This standard is implemented inside the KServe HuggingFace Server at this PR.

@netlify

netlify Bot commented Jul 24, 2025

Copy link
Copy Markdown

Deploy Preview for elastic-nobel-0aef7a ready!

Name Link
🔨 Latest commit 092f7bb
🔍 Latest deploy log https://app.netlify.com/projects/elastic-nobel-0aef7a/deploys/6901510cf6b6470008ffa104
😎 Deploy Preview https://deploy-preview-507--elastic-nobel-0aef7a.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@jinan-zhou jinan-zhou changed the title The First Time Series Forecast API Industry Standard Time Series Forecast API Documentation Jul 30, 2025
Signed-off-by: jinan.zhou <jinan.zhou@nutanix.com>
Signed-off-by: jinan.zhou <jinan.zhou@nutanix.com>
Comment thread docs/reference/time_series/api.md Outdated
Comment thread docs/reference/time_series/api.md Outdated
Comment thread docs/reference/time_series/api.md Outdated
Comment thread docs/reference/time_series/api.md Outdated
Comment thread docs/reference/time_series/api.md Outdated
Comment thread docs/reference/time_series/api.md Outdated
Comment thread docs/reference/time_series/api.md
Signed-off-by: jinan.zhou <jinan.zhou@nutanix.com>
@jinan-zhou
jinan-zhou requested review from spolti and yuzisun October 28, 2025 23:39
@sivanantha321
sivanantha321 merged commit c7fdea8 into kserve:main Nov 10, 2025
5 checks passed
alexagriffith pushed a commit to alexagriffith/website that referenced this pull request Apr 22, 2026
* add time series API doc

Signed-off-by: jinan.zhou <jinan.zhou@nutanix.com>

* add sample usage

Signed-off-by: jinan.zhou <jinan.zhou@nutanix.com>

* add k8x deployment example

Signed-off-by: jinan.zhou <jinan.zhou@nutanix.com>

---------

Signed-off-by: jinan.zhou <jinan.zhou@nutanix.com>
Signed-off-by: alexagriffith <agriffith96@gmail.com>
alexagriffith pushed a commit to alexagriffith/website that referenced this pull request Apr 29, 2026
* add time series API doc

Signed-off-by: jinan.zhou <jinan.zhou@nutanix.com>

* add sample usage

Signed-off-by: jinan.zhou <jinan.zhou@nutanix.com>

* add k8x deployment example

Signed-off-by: jinan.zhou <jinan.zhou@nutanix.com>

---------

Signed-off-by: jinan.zhou <jinan.zhou@nutanix.com>
Signed-off-by: alexagriffith <agriffith96@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants