Gradient Docs
Gradient HomeHelp DeskCommunitySign up free
Gradient Next
Gradient Next
  • About Gradient
  • Get Started
    • Quick Start
      • Install the Gradient CLI
    • Core Concepts
    • Organizing Projects
      • Secrets
      • Storing an API key as a Secret
    • Tutorials
      • Gradient Notebooks Tutorial
      • Gradient Workflows Tutorial
      • Gradient Deployments Tutorial
    • FAQ
    • Common Errors
  • Gradient Platform
    • Gradient Notebooks
      • Runtimes
      • Files and storage
      • Machines
      • Terminal
      • Shortcuts
      • Sharing
      • TensorBoard
      • Run on Gradient
    • Gradient Workflows
      • Basic operations
      • Understanding Inputs & Outputs
      • Workflow Spec
      • Gradient Actions
      • Environment Variables
      • Using YAML for Data Science
    • Gradient Deployments
      • Basic operations
      • Deployment Spec
  • Artifacts
    • Container Management
      • Custom Containers
    • Data
      • Versioned Data
        • Public Datasets Repository
        • Storage Providers
      • Persistent Storage
    • Models
      • Managing Models
        • Model Types & Metadata
        • Public Models
    • Code
    • Metrics
      • Push Metrics
      • View & Query Metrics
  • Gradient Cluster
    • Overview
      • Setup
        • Managed Private Clusters
        • Self-Hosted Clusters
          • Pre-installation steps
          • Gradient Installer CLI
          • Terraform
            • Pre-installation steps
            • Install on AWS
            • Install on bare metal / VMs
            • Install on NVIDIA DGX
          • Let's Encrypt DNS Providers
          • Updating your cluster
      • Usage
  • More
    • SDK
      • Projects Client
      • Models Client
      • Deployments Client
      • Workflows Client
      • SDK Examples
      • Full SDK Reference
    • Machine Types
      • Machine Tiers
      • Free Machines (Free Tier)
    • Your Account
      • Teams
        • Creating a Team
        • Upgrading to a Team Plan
      • Hotkeys
      • Billing & Subscriptions
        • Storage Billing
      • Public Profiles
    • Release notes
    • Roadmap
Powered by GitBook
On this page
  • Finding your Cluster ID
  • Using Gradient private clusters via the Gradient CLI
  • Using Gradient clusters via the Web UI
  1. Gradient Cluster
  2. Overview

Usage

PreviousUpdating your clusterNextSDK

Last updated 4 years ago

Finding your Cluster ID

Your clusters are available under the Clusters tab. Here you can find information about your cluster, including your cluster ID – you will need to specify this ID in order to designate your private cluster as the place to run Workflows, Deployments, etc.

Using Gradient private clusters via the Gradient CLI

gradient <command> ... --clusterId <your-cluster-ID>

--clusterId string Cluster ID for this processing site, e.g. "clxxxxxxx".

A complete example of utilizing Gradient features on a cluster might look like this:

gradient workflows run \
--id 01f00ea6-6f78-4ad9-b5ca-f56006e64193 \
--clusterId cl8pwu9qn \ 
--path ./workflow.yaml 

In order to run workloads on your Gradient cluster, you must specify the clusterId parameter on most Gradient commands, including:

  • workflows

  • deployments

  • models

  • notebooks

If you don't supply the clusterId parameter, then your command will default to run on Paperspace instances, which are not part of your private cluster environment.

Using Gradient clusters via the Web UI

When creating a notebook, an experiment, or a model deployment, select your private cluster in the console, then select an instance type that's available in your cluster.

You will need to provide your API key to authenticate your requests. Learn how to obtain and set your API key .

here