Skip to main content
Version: 0.6.12

Getting started

Each deployment of Starwhale is called an instance. All instances can be managed by the Starwhale Client (swcli).

You can start using Starwhale with one of the following instance types:

  • Starwhale Standalone - Rather than a running service, Starwhale Standalone is actually a repository that resides in your local file system. It is created and managed by the Starwhale Client (swcli). You only need to install swcli to use it. Currently, each user on a single machine can have only ONE Starwhale Standalone instance. We recommend you use the Starwhale Standalone to build and test your datasets, runtime, and models before pushing them to Starwhale Server/Cloud instances.
  • Starwhale Server - Starwhale Server is a service deployed on your local server. Besides text-only results from the Starwhale Client (swcli), Starwhale Server provides Web UI for you to manage your datasets and models, evaluate your models in your local Kubernetes cluster, and review the evaluation results.
  • Starwhale Cloud - Starwhale Cloud is a managed service hosted on public clouds. By registering an account on, you are ready to use Starwhale without needing to install, operate, and maintain your own instances. Starwhale Cloud also provides public resources for you to download, like datasets, runtimes, and models. Check the "starwhale/public" project on Starwhale Cloud for more details.

When choosing which instance type to use, consider the following:

Instance TypeDeployment locationMaintained byUser InterfaceScalability
Starwhale StandaloneYour laptop or any server in your data centerNot requiredCommand lineNot scalable
Starwhale ServerYour data centerYourselfWeb UI and command lineScalable, depends on your Kubernetes cluster
Starwhale CloudPublic cloud, like AWS or Aliyunthe Starwhale TeamWeb UI and command lineScalable, but currently limited by the freely available resource on the cloud

Depending on your instance type, there are three getting-started guides available for you:

  • Getting started with Starwhale Standalone - This guide helps you run an MNIST evaluation on your desktop PC/laptop. It is the fastest and simplest way to get started with Starwhale.
  • Getting started with Starwhale Server - This guide helps you install Starwhale Server in your private data center and run an MNIST evaluation. At the end of the tutorial, you will have a Starwhale Server instance where you can run model evaluations on and manage your datasets and models.
  • Getting started with Starwhale Cloud - This guide helps you create an account on Starwhale Cloud and run an MNIST evaluation. It is the easiest way to experience all Starwhale features.