Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Changelog

All notable changes to TServe are recorded here. The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and versions follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html). Until 1.0, a minor release may change the HTTP API, the Python client, or the CLI.

## [0.1.0] - 2026-09-24

First release on PyPI and Docker Hub.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Each model family ships its own package, input format, and loading code. [sktime
- **A dashboard in the browser.** `GET /` plots a forecast from a sample series or your own CSV. [What you can do](https://tserve.readthedocs.io/en/latest/server/dashboard/#what-you-can-do)
- **Your own sktime models.** Serve a [configured forecaster](https://tserve.readthedocs.io/en/latest/server/live-objects/), a [saved `.zip`](https://tserve.readthedocs.io/en/latest/server/models-dir/), or a [craft spec](https://tserve.readthedocs.io/en/latest/server/craft-specs/) next to the catalog models.

![TServe demo: start the server, query /models and /predict, then forecast in the dashboard](docs/assets/demo.svg)
![TServe demo: start the server, query /models and /predict, then forecast in the dashboard](https://raw.githubusercontent.com/sktime/tserve/main/docs/assets/demo.svg)

TServe is a server you run on your own hardware, not a hosted API. [How it works](https://tserve.readthedocs.io/en/latest/overview/) · [Docker Hub](https://hub.docker.com/r/sktime/tserve)

Expand Down Expand Up @@ -83,7 +83,7 @@ The running server serves a browser console at `GET /`. The model list is whatev

Below, [`timesfm_3`](https://tserve.readthedocs.io/en/latest/models/timesfm3/) forecasts retail sales with 90% prediction interval.

![TServe dashboard: timesfm_3 with a 90% prediction interval](docs/assets/dashboard.png)
![TServe dashboard: timesfm_3 with a 90% prediction interval](https://raw.githubusercontent.com/sktime/tserve/main/docs/assets/dashboard.png)

## Models

Expand Down Expand Up @@ -164,7 +164,7 @@ The generated reference for the same surface: [HTTP API](https://tserve.readthed

## License

BSD 3-Clause. See [LICENSE](LICENSE).
BSD 3-Clause. See [LICENSE](https://github.com/sktime/tserve/blob/main/LICENSE).

License covers only the model server, not the models themselves or distributions pathways such as Hugging Face. Third party model weights, model code, or distribution pathways may create their own implications via licenses or T&C. While we try to make it easy for users to gain a transparent picture of legal implications, we do not assume any liability or guarantee correctness of metadata related to third party licenses or T&C.

Expand Down
1 change: 1 addition & 0 deletions docs/reference/changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
--8<-- "CHANGELOG.md"
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -198,3 +198,4 @@ nav:
- Python API: reference/api.md
- Errors: reference/errors.md
- Development: reference/development.md
- Changelog: reference/changelog.md
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ Homepage = "https://tserve.readthedocs.io"
Documentation = "https://tserve.readthedocs.io"
Repository = "https://github.com/sktime/tserve"
Issues = "https://github.com/sktime/tserve/issues"
Changelog = "https://tserve.readthedocs.io/en/latest/reference/changelog/"

[dependency-groups]
# same packages as the extras, so `uv sync --group dev` stays valid
Expand Down
Loading