# Lium Documentation

> Audience-first, agent-native docs for Lium GPU rental on Bittensor SN51.

## Introduction

- [Welcome to Lium](https://docs.lium.io/intro.md): Lium is a decentralized GPU rental marketplace built on **Bittensor Subnet 51**. Providers contribute GPU resources to a global pool; renters access those resources on demand; validators keep everyone
- [Official Support and Scam Prevention](https://docs.lium.io/security/official-support-and-scams.md): Scam and impersonation attempts against Lium users are becoming more common. This page explains how those scams usually work, what information you must never share, and the safest way to contact Lium 
- [Validators](https://docs.lium.io/validators/index.md): Lium runs a single validator on Bittensor Subnet 51, operated by the Lium team.

## Providers

- [Providers](https://docs.lium.io/providers/index.md): Contribute GPU resources to the Lium network on Bittensor Subnet 51 and earn TAO rewards. As a provider, you operate a **self-hosted provider** (a lightweight CPU coordinator) that connects one or mor
- [Provider Quickstart](https://docs.lium.io/providers/quickstart.md): Three steps to a live provider on Bittensor Subnet 51. Want to know how much you'll earn? See [Rewards](rewards/index.mdx).
- [Architecture](https://docs.lium.io/providers/architecture.md): How the pieces of a Lium provider setup fit together. Read this once to build a mental model — then proceed to [Quickstart](./quickstart.md), [Self-hosted provider setup](./self-hosted-provider.md), o
- [Provider Configuration](https://docs.lium.io/providers/provider-configuration.md): Choose how your provider is run — self-host it, or let Lium operate one for you.
- [Self-Hosted Provider Setup](https://docs.lium.io/providers/self-hosted-provider.md): This page covers installing and operating the **self-hosted provider** — the lightweight CPU coordinator that connects your GPU nodes to the Lium network. Skip this entire page if you opted into the [
- [How providers earn on Subnet 51](https://docs.lium.io/providers/rewards/index.md): Two reward streams in alpha — rental fees to your coldkey daily, emission to your hotkey each tempo — the 30-second answer to "how much will I earn?
- [Rental fees](https://docs.lium.io/providers/rewards/rental-fees.md): Your share of every USD a renter pays for your GPUs, paid daily in alpha.
- [Subnet emission](https://docs.lium.io/providers/rewards/emission.md): How Bittensor's per-tempo emission flows into Subnet 51, and how the three-pool split (rented / unrented / burn) works.
- [Rewards calculator](https://docs.lium.io/providers/rewards/calculator.md): Walkthrough of every input on the live rewards calculator, plus the formula it uses.
- [Payouts](https://docs.lium.io/providers/rewards/payouts.md): Where your earnings land, in what currency, and on what schedule.
- [Penalties](https://docs.lium.io/providers/rewards/penalties.md): What causes a rental-fee deduction, how much is withheld, and how to dispute it.
- [FAQ](https://docs.lium.io/providers/rewards/faq.md): The most-asked questions from providers and prospective providers.
- [Nodes](https://docs.lium.io/providers/nodes/index.md): A **node** is a GPU machine you connect to your provider so it can be rented out by Lium customers. A provider alone earns nothing — your score, emission, and rental revenue all come from the nodes yo
- [Node Quickstart](https://docs.lium.io/providers/nodes/quickstart.md): Three commands and a portal click bring a GPU machine online as a Lium node.
- [Sysbox](https://docs.lium.io/providers/nodes/sysbox.md): [Sysbox](https://github.com/nestybox/sysbox) is a container runtime that lets customers run Docker-in-Docker securely inside pods — without `--privileged` mode. Many workloads (custom image builds, CI
- [Docker Storage Setup](https://docs.lium.io/providers/nodes/docker-storage.md): Lium expects every node's Docker daemon to use the **`overlay2`** storage driver backed by an **`xfs`** filesystem mounted with **`pquota`** and `ftype=1`. The [`lium`](https://github.com/Datura-ai/li
- [GPU Splitting](https://docs.lium.io/providers/nodes/gpu-splitting.md): GPU splitting lets a single node serve multiple customers at once — each renting an integer subset of GPUs. It increases utilization and lets you price flexibly.
- [Confidential Virtual Machine (CVM)](https://docs.lium.io/providers/nodes/cvm.md): <div style={{position: 'relative', paddingBottom: '56.25%', height: 0, overflow: 'hidden', marginBottom: '2rem'}}> <iframe src="https://drive.google.com/file/d/1JOU8BvqGNwtirnelrhI5BQxbhwSjAsLg/previe
- [Overview](https://docs.lium.io/providers/portal/overview.md): Welcome to the Lium.io [Provider Portal](https://provider.lium.io) documentation. The Provider Portal gives GPU providers a UI to register, monitor, and manage their nodes.
- [Authentication](https://docs.lium.io/providers/portal/authentication.md): This covers the signup and signin process for the [Provider Portal](https://provider.lium.io), including how to authenticate using your Bittensor provider hotkey. A provider account is created on firs
- [Connect Discord](https://docs.lium.io/providers/portal/discord.md): Connect Discord in the Provider Portal so renters can invite you into private pod support channels. Without a connected provider Discord account, renters see **Provider has not connected Discord** on 
- [Managing Nodes](https://docs.lium.io/providers/portal/managing-nodes.md): This guide covers all aspects of node management, from adding new machines to configuring settings and handling customer requests.
- [Node Tier: Secure vs Spot](https://docs.lium.io/providers/portal/node-tier.md): By default every node is **Secure** — it earns [subnet incentive](../rewards/emission.mdx) and is subject to penalties if a rental is interrupted.
- [Monitoring Nodes](https://docs.lium.io/providers/portal/monitoring.md): This guide covers monitoring your nodes, including status tracking and performance metrics.
- [Default Jobs](https://docs.lium.io/providers/portal/default-jobs.md): Default Jobs are reusable fallback workload profiles for provider nodes. Assign a profile to a node, and Lium can run that workload while the node is idle and unrented.
- [Provider Payouts](https://docs.lium.io/providers/portal/payments.md): > For total-rewards math, see the [Rewards](../rewards/index.mdx) section.
- [Machine Requests](https://docs.lium.io/providers/portal/machine-requests.md): Machine requests are rental inquiries from renters seeking specific hardware configurations.
- [Grafana Dashboards](https://docs.lium.io/providers/grafana.md): Lium runs a Grafana instance at **[grafana.lium.io](https://grafana.lium.io/dashboards/f/cfh8umv50c9oga/subnet-51)** that exposes the validator-side telemetry behind subnet 51 — the same data that dri
- [Troubleshooting](https://docs.lium.io/providers/troubleshooting.md): When a node is online but earning nothing — or a freshly-installed node is failing validator verification — start here. This page covers the two diagnostic surfaces providers reach for first:
- [GPU Profiling (ncu)](https://docs.lium.io/providers/nodes/gpu-profiling.md): GPU Profiling is an opt-in node capability: open the GPU performance counters on the host, and renters can run [NVIDIA Nsight Compute](https://developer.nvidia.com/nsight-compute) (`ncu`) inside the p

## Renters

- [Renters](https://docs.lium.io/pod-users/index.md): Rent GPUs on [lium.io](https://lium.io) — browse the marketplace, deploy a containerized pod in minutes, pay only for what you use.
- [Quickstart](https://docs.lium.io/pod-users/quickstart.md): Goal: a running GPU pod you can SSH into. All steps are in the dashboard at [lium.io](https://lium.io).
- [Create a pod](https://docs.lium.io/pod-users/create-pod.md): Walk-through of the **Create Pod** page at [lium.io](https://lium.io). You land here when you click **RENT NOW** on a row in **Browse Pods**.
- [Templates](https://docs.lium.io/pod-users/templates.md): A **template** is the recipe Lium uses to start your pod's container. It bundles a Docker image, an image tag, environment variables, port exposures, a startup command, and the volume mount path — eve
- [Volumes](https://docs.lium.io/pod-users/volumes.md): A **Volume** is persistent storage that lives outside any single pod. Attach one to a pod and the data survives pod termination, can be moved to another pod later, and never has to fit on the host's l
- [Encrypted local volumes](https://docs.lium.io/pod-users/encrypted-volumes.md): Lium can store the pod's local volume at `/root` as ciphertext on the provider's disk. Inside the running pod, it looks like a normal filesystem.
- [Backups](https://docs.lium.io/pod-users/backups.md): Lium runs a scheduled backup job for any pod you configure: it ZIPs a directory inside the pod, uploads the archive to AWS S3 in a bucket scoped to your account, and prunes archives older than the ret
- [Restores](https://docs.lium.io/pod-users/restores.md): A **restore** pulls a [backup](./backups) archive out of S3 and extracts it into a directory inside a target pod. Use it to:
- [Scheduled termination](https://docs.lium.io/pod-users/scheduled-termination.md): Schedule a pod to be deleted automatically at a future time. Cheap insurance against forgetting a `kill` overnight — billing stops the moment the pod is terminated.
- [Broken pods](https://docs.lium.io/pod-users/broken-pods.md): Sometimes a pod's status turns red and reads **BROKEN**. This means the **GPU provider force-closed your pod** — the container and your rental are already gone. Hover the status for the in-app note:
- [Discord support](https://docs.lium.io/pod-users/discord-support.md): Rented pods can open a private Discord support channel for the renter, the GPU provider, and the Lium support role when that role is configured. Use it when a running pod needs coordination with the p
- [Overview](https://docs.lium.io/pod-users/overview.md): Pods in Lium represent individual GPU rental units that users can lease for their computational needs. Each pod is a containerized environment that provides secure, isolated access to GPU resources th
- [Pod Security](https://docs.lium.io/pod-users/security.md): <!-- security-warning: private-keys-in-non-cvm-pods -->
- [API Keys](https://docs.lium.io/pod-users/api-keys.md): Most renters never need this page. Use it when:
- [Screenshots for the Renters section](https://docs.lium.io/pod-users/assets/SCREENSHOTS.md): The Renters pages reference these images. Capture each on a clean, signed-in [lium.io](https://lium.io) browser at viewport ≥ 1440×900 with the dark theme (default) and save as PNG into this directory
- [GPU profiling with ncu](https://docs.lium.io/pod-users/gpu-profiling.md): Profile CUDA kernels with [NVIDIA Nsight Compute](https://developer.nvidia.com/nsight-compute) (`ncu`) inside a Lium pod.

## Developers

- [Developers](https://docs.lium.io/developers/index.md): Build on top of Lium programmatically — whether you're a human writing a service or an AI agent driving the platform on a user's behalf. Everything Lium exposes (REST API, CLI, Python SDK, MCP, llms.t
- [AI Agents](https://docs.lium.io/developers/agents.md): One-page integration guide for AI agents — install the Lium CLI, create an account and rent a GPU headless, load the agent skill, and drop to the REST API where the CLI cannot go.
- [Developer Quickstart](https://docs.lium.io/developers/quickstart.md): This guide takes you from zero to your first authenticated API call against the Lium platform API.
- [OpenAPI Spec](https://docs.lium.io/developers/openapi.md): Live OpenAPI 3.1 schema for the Lium platform API — the single source of truth for every REST endpoint.
- [SDK](https://docs.lium.io/developers/sdk.md): The `lium.io` package ships both the [CLI](./cli/overview) and a **Python SDK** for managing GPU pods programmatically. Install it once and use whichever interface fits the job.
- [SDK Examples](https://docs.lium.io/developers/sdk/examples/index.md): These examples show runnable SDK workflows.
- [Pod Lifecycle with Lium()](https://docs.lium.io/developers/sdk/examples/pod-lifecycle.md): This example shows the core pod workflow in Python: choose a GPU, create a pod, wait for SSH readiness, run a command, move a small file, and stop the pod.
- [Train a Model on a Pod](https://docs.lium.io/developers/sdk/examples/training-workflow.md): This example runs a local training project on a Lium GPU pod. It selects a GPU, starts a pod with a PyTorch template, syncs code and data, installs dependencies, streams the training output, downloads
- [Custom Docker Template](https://docs.lium.io/developers/sdk/examples/custom-template.md): Use a template when you want pods to start from a specific Docker image with predefined ports, environment variables, volume paths, and a startup command.
- [Remote Inference with @lium.machine](https://docs.lium.io/developers/sdk/examples/machine-inference.md): This example runs a local Python function on a GPU pod. The decorator provisions the pod, uploads the function, installs Python dependencies, runs inference, returns the result, and tears the pod down
- [Run a vLLM Server](https://docs.lium.io/developers/sdk/examples/vllm.md): This example creates a reusable vLLM template, starts a GPU pod, and prints the OpenAI-compatible `/v1/models` endpoint.
- [SDK Reference](https://docs.lium.io/developers/sdk/reference/index.md): <!-- Generated by scripts/generate_sdk_reference.py. Do not edit directly. -->
- [CLI Overview](https://docs.lium.io/developers/cli/overview.md): The Lium CLI is a powerful command-line interface that allows you to manage GPU pods directly from your terminal. It provides comprehensive control over pod creation, management, and monitoring withou
- [Installation](https://docs.lium.io/developers/cli/installation.md): This guide covers the installation and initial setup of the Lium CLI.
- [Quick Start Guide](https://docs.lium.io/developers/cli/quickstart.md): This guide will walk you through your first pod creation and management workflow with the Lium CLI.
- [CLI Reference](https://docs.lium.io/developers/cli/reference/index.md): Complete reference for every `lium` command, grouped by what you're trying to do. Each command has its own page with arguments, options, and runnable examples.
- [`lium ls`](https://docs.lium.io/developers/cli/reference/ls.md): List available GPU nodes.
- [`lium up`](https://docs.lium.io/developers/cli/reference/up.md): Create a new pod.
- [`lium ps`](https://docs.lium.io/developers/cli/reference/ps.md): List your active pods.
- [`lium ssh`](https://docs.lium.io/developers/cli/reference/ssh.md): SSH into a pod.
- [`lium exec`](https://docs.lium.io/developers/cli/reference/exec.md): Execute a command on one or more pods.
- [`lium scp`](https://docs.lium.io/developers/cli/reference/scp.md): Copy files between your machine and pods. Upload is the default; add `--download` to pull files back.
- [`lium rsync`](https://docs.lium.io/developers/cli/reference/rsync.md): Synchronize directories to pods.
- [`lium rm`](https://docs.lium.io/developers/cli/reference/rm.md): Remove / stop pods.
- [`lium reboot`](https://docs.lium.io/developers/cli/reference/reboot.md): Reboot one or more pods.
- [`lium logs`](https://docs.lium.io/developers/cli/reference/logs.md): Stream or tail pod logs.
- [`lium update`](https://docs.lium.io/developers/cli/reference/update.md): Update a running pod in place. Currently handles installing Jupyter on a chosen internal port.
- [`lium port-forward`](https://docs.lium.io/developers/cli/reference/port-forward.md): Forward a port from a pod to your local machine over the SSH tunnel.
- [`lium schedules`](https://docs.lium.io/developers/cli/reference/schedules.md): List and cancel scheduled pod removals. Schedules are **created** via [`lium up --ttl`](./up.md) or `--until`; this command manages the existing ones.
- [`lium volumes`](https://docs.lium.io/developers/cli/reference/volumes.md): Manage persistent volumes that can be attached to pods.
- [`lium bk`](https://docs.lium.io/developers/cli/reference/bk.md): Pod backups and restores. Each subcommand operates on a single pod (by HUID or index from `lium ps`).
- [`lium templates`](https://docs.lium.io/developers/cli/reference/templates.md): List available Docker templates and images used to create pods.
- [`lium signup`](https://docs.lium.io/developers/cli/reference/signup.md): Create a Lium account from the terminal and store the API key it mints.
- [`lium init`](https://docs.lium.io/developers/cli/reference/init.md): Run first-time setup: authenticate in the browser, then save your API key and configure your SSH key locally.
- [`lium config`](https://docs.lium.io/developers/cli/reference/config.md): Read and write CLI configuration values.
- [`lium theme`](https://docs.lium.io/developers/cli/reference/theme.md): Change the CLI color theme.
- [`lium balance`](https://docs.lium.io/developers/cli/reference/balance.md): Show your current Lium account balance.
- [`lium fund`](https://docs.lium.io/developers/cli/reference/fund.md): Fund your account with TAO — or Subnet&nbsp;51 **alpha** — from a Bittensor wallet.
- [`lium topup`](https://docs.lium.io/developers/cli/reference/topup.md): Top up your Lium balance with a **stablecoin** (e.g. USDT). Unlike [`lium fund`](./fund.md) — which transfers TAO from a Bittensor wallet — `topup` creates a payment invoice and hands you a **deposit 
- [`lium ssh-keys`](https://docs.lium.io/developers/cli/reference/ssh-keys.md): Manage the SSH keys registered on your Lium account.
- [`lium mine`](https://docs.lium.io/developers/cli/reference/mine.md): Bootstrap a Lium provider node end-to-end: install prereqs, clone `compute-subnet`, set up the executor environment, and bring it online.
- [`lium gpu-splitting`](https://docs.lium.io/developers/cli/reference/gpu-splitting.md): Prepare Docker storage on a provider node so the host can be split across multiple renters. This is a **provider-side** command, run on the host.
- [`lium provider`](https://docs.lium.io/developers/cli/reference/provider.md): Reference for the `lium provider` CLI namespace — portal session, node lifecycle, central-miner-server config, sync, billing, and machine-request queries. Mirrors every action the provider portal fron
- [MCP Endpoint](https://docs.lium.io/developers/mcp.md): The Lium docs site exposes a [Model Context Protocol](https://modelcontextprotocol.io) endpoint at `/mcp`. AI agents and MCP-compatible clients can use this to search the documentation and read indivi
- [llms.txt](https://docs.lium.io/developers/llms-txt.md): The Lium docs site publishes `llms.txt` and `llms-full.txt` at the site root, conforming to the [llmstxt.org specification](https://llmstxt.org).
- [AlphaQuote](https://docs.lium.io/developers/sdk/reference/client/alpha-quote.md): <!-- Generated by scripts/generate_sdk_reference.py. Do not edit directly. -->
- [Lium](https://docs.lium.io/developers/sdk/reference/client/lium.md): <!-- Generated by scripts/generate_sdk_reference.py. Do not edit directly. -->
- [Config](https://docs.lium.io/developers/sdk/reference/config/config.md): <!-- Generated by scripts/generate_sdk_reference.py. Do not edit directly. -->
- [machine](https://docs.lium.io/developers/sdk/reference/decorators/machine.md): <!-- Generated by scripts/generate_sdk_reference.py. Do not edit directly. -->
- [LiumAuthError](https://docs.lium.io/developers/sdk/reference/exceptions/lium-auth-error.md): <!-- Generated by scripts/generate_sdk_reference.py. Do not edit directly. -->
- [LiumError](https://docs.lium.io/developers/sdk/reference/exceptions/lium-error.md): <!-- Generated by scripts/generate_sdk_reference.py. Do not edit directly. -->
- [LiumNotFoundError](https://docs.lium.io/developers/sdk/reference/exceptions/lium-not-found-error.md): <!-- Generated by scripts/generate_sdk_reference.py. Do not edit directly. -->
- [LiumRateLimitError](https://docs.lium.io/developers/sdk/reference/exceptions/lium-rate-limit-error.md): <!-- Generated by scripts/generate_sdk_reference.py. Do not edit directly. -->
- [LiumServerError](https://docs.lium.io/developers/sdk/reference/exceptions/lium-server-error.md): <!-- Generated by scripts/generate_sdk_reference.py. Do not edit directly. -->
- [BackupConfig](https://docs.lium.io/developers/sdk/reference/models/backup-config.md): <!-- Generated by scripts/generate_sdk_reference.py. Do not edit directly. -->
- [BackupLog](https://docs.lium.io/developers/sdk/reference/models/backup-log.md): <!-- Generated by scripts/generate_sdk_reference.py. Do not edit directly. -->
- [ExecutorInfo](https://docs.lium.io/developers/sdk/reference/models/executor-info.md): <!-- Generated by scripts/generate_sdk_reference.py. Do not edit directly. -->
- [PodInfo](https://docs.lium.io/developers/sdk/reference/models/pod-info.md): <!-- Generated by scripts/generate_sdk_reference.py. Do not edit directly. -->
- [RestoreLog](https://docs.lium.io/developers/sdk/reference/models/restore-log.md): <!-- Generated by scripts/generate_sdk_reference.py. Do not edit directly. -->
- [SSHKey](https://docs.lium.io/developers/sdk/reference/models/ssh-key.md): <!-- Generated by scripts/generate_sdk_reference.py. Do not edit directly. -->
- [Template](https://docs.lium.io/developers/sdk/reference/models/template.md): <!-- Generated by scripts/generate_sdk_reference.py. Do not edit directly. -->
- [VolumeInfo](https://docs.lium.io/developers/sdk/reference/models/volume-info.md): <!-- Generated by scripts/generate_sdk_reference.py. Do not edit directly. -->