Skip to content
Open
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
1 change: 1 addition & 0 deletions containers.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Containers"
description: "Learn how to build, package, and deploy containerized applications on Runpod."
---

<Card href="/tutorials/introduction/containers" horizontal>
Expand Down
1 change: 1 addition & 0 deletions flash/cli/app.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "app"
sidebarTitle: "app"
description: "Create, inspect, list, and delete Runpod Flash applications and their deployment environments."
---

Manage Flash applications. An app is the top-level container that groups your deployment environments, build artifacts, and configuration.
Expand Down
1 change: 1 addition & 0 deletions flash/cli/build.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "build"
sidebarTitle: "build"
description: "Build a deployment-ready Runpod Flash artifact without deploying it."
---

Build a deployment-ready artifact for your Flash application without deploying. Use this for more control over the build process or to inspect the artifact before deploying.
Expand Down
1 change: 1 addition & 0 deletions flash/cli/deploy.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "deploy"
sidebarTitle: "deploy"
description: "Build and deploy a Runpod Flash application to Serverless with configurable environments and build options."
---

Build and deploy your Flash application to Runpod Serverless endpoints in one step. This is the primary command for getting your application running in the cloud.
Expand Down
1 change: 1 addition & 0 deletions flash/cli/dev.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "dev"
sidebarTitle: "dev"
description: "Start the Runpod Flash local development server and test endpoint functions on Serverless."
---

Start the Flash development server for local testing with automatic updates. A local development server provides a unified interface for testing while `@Endpoint` functions execute on Runpod Serverless.
Expand Down
1 change: 1 addition & 0 deletions flash/cli/env.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "env"
sidebarTitle: "env"
description: "Create, inspect, list, and delete deployment environments for Runpod Flash applications."
---

Manage deployment environments for Flash applications. Environments are isolated deployment contexts (like `dev`, `staging`, `production`) within a Flash app.
Expand Down
1 change: 1 addition & 0 deletions flash/cli/init.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "init"
sidebarTitle: "init"
description: "Create a Runpod Flash project with a FastAPI server, example workers, and deployment configuration."
---

Create a new Flash project with a ready-to-use template structure including a FastAPI server, example GPU and CPU workers, and configuration files.
Expand Down
1 change: 1 addition & 0 deletions flash/cli/login.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "login"
sidebarTitle: "login"
description: "Authenticate the Runpod Flash CLI and save your API key for future Flash operations."
---

Authenticate with Runpod and save your API key for all Flash operations, including CLI commands and standalone `@Endpoint` functions.
Expand Down
1 change: 1 addition & 0 deletions flash/cli/undeploy.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "undeploy"
sidebarTitle: "undeploy"
description: "List and remove Runpod Serverless endpoints created by Flash development and deployment workflows."
---

Manage and delete Runpod Serverless endpoints deployed via Flash. Use this command to clean up endpoints created during local development with `flash dev`.
Expand Down
1 change: 1 addition & 0 deletions flash/cli/update.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "update"
sidebarTitle: "update"
description: "Update the Runpod Flash CLI to the latest release or install a specific version."
---

Update the Flash CLI to the latest version or a specific version. The command fetches version information from PyPI and installs using uv (when available) or pip.
Expand Down
1 change: 1 addition & 0 deletions instant-clusters/axolotl.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Deploy an Instant Cluster with Axolotl"
sidebarTitle: "Axolotl"
description: "Deploy Axolotl across multiple nodes on Runpod Clusters to fine-tune large language models."
---
import { TrainingTooltip, InferenceTooltip } from "/snippets/tooltips.jsx";

Expand Down
1 change: 1 addition & 0 deletions instant-clusters/pytorch.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Deploy an Instant Cluster with PyTorch"
sidebarTitle: "PyTorch"
description: "Run distributed PyTorch workloads across multiple nodes on Runpod Clusters."
---

import { PyTorchTooltip } from "/snippets/tooltips.jsx";
Expand Down
3 changes: 2 additions & 1 deletion instant-clusters/slurm.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Deploy an Instant Cluster with Slurm (unmanaged)"
title: "Deploy Slurm on a Cluster (unmanaged)"
sidebarTitle: "Slurm (unmanaged)"
description: "Configure and manage an unmanaged Slurm deployment across multiple nodes on Runpod Clusters."
---

import { SlurmTooltip } from "/snippets/tooltips.jsx";
Expand Down
2 changes: 1 addition & 1 deletion integrations/transformer-lab.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Run ML experiments on Runpod with Transformer Lab"
title: "Run Transformer Lab experiments on Runpod"
sidebarTitle: "Transformer Lab"
description: "Configure Transformer Lab to run ML training and inference workloads on Runpod GPUs. Review configuration and usage guidance for this Runpod integration."
---
Expand Down
3 changes: 2 additions & 1 deletion pods/troubleshooting/jupyterlab-checkpoints-folder.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "JupyterLab checkpoints folder access"
sidebarTitle: "JupyterLab checkpoints folder"
description: "Access folders named checkpoints in JupyterLab by temporarily renaming the directory on a Runpod Pod."
---

If you're unable to open a folder named "checkpoints" in JupyterLab, this is a known issue where JupyterLab treats "checkpoints" as a reserved keyword.
Expand Down Expand Up @@ -46,4 +47,4 @@ mv ~/downloaded-model.ckpt checkpoints/

## Related information

This issue has been reported in multiple GitHub issues and affects both JupyterLab and classic Jupyter Notebook. The folder name "checkpoints" conflicts with Jupyter's internal checkpoint system for notebook files.
This issue has been reported in multiple GitHub issues and affects both JupyterLab and classic Jupyter Notebook. The folder name "checkpoints" conflicts with Jupyter's internal checkpoint system for notebook files.
3 changes: 2 additions & 1 deletion pods/troubleshooting/storage-full.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Storage full"
description: "Diagnose full container or volume storage and recover disk space on a Runpod Pod."
---

Storage full errors can occur when users generate many files, transfer files, or perform other storage-intensive tasks. This document provides guidance to help you troubleshoot this.
Expand Down Expand Up @@ -101,4 +102,4 @@ ls -d /workspace/.Trash* 2>/dev/null && rm -rf /workspace/.Trash* && echo "✓ C

## Additional storage

If your Pod needs more than 20GB of storage, consider using a network volume. For more information, see [Network volumes](/storage/network-volumes), or refer to [this blog post](https://www.runpod.io/blog/network-volumes-on-runpod-secure-cloud).
If your Pod needs more than 20GB of storage, consider using a network volume. For more information, see [Network volumes](/storage/network-volumes), or refer to [this blog post](https://www.runpod.io/blog/network-volumes-on-runpod-secure-cloud).
1 change: 1 addition & 0 deletions pods/troubleshooting/token-authentication-enabled.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "JupyterLab server token authentication"
description: "Find your JupyterLab server token and sign in when token authentication is enabled on a Runpod Pod."
---

If you see a "Token authentication is enabled" screen when trying to access your Pod's JupyterLab server, follow the steps below to log in.
Expand Down
1 change: 1 addition & 0 deletions pods/troubleshooting/troubleshooting-502-errors.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "502 errors"
description: "Diagnose and resolve 502 errors when accessing applications running on a Runpod Pod."
---

502 errors can occur when users attempt to access a program running on a specific port of a deployed Pod and the program isn't running or has encountered an error. This document provides guidance to help you troubleshoot this error.
Expand Down
1 change: 1 addition & 0 deletions references/cpu-types.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: CPU types
description: "Compare the CPU types available on Runpod, including core counts and thread configurations."
---

The following list contains all CPU types available on Runpod.
Expand Down
1 change: 1 addition & 0 deletions runpodctl/reference/runpodctl-billing.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "billing"
sidebarTitle: "billing"
description: "View billing history for Runpod Pods, Serverless endpoints, and network volumes with runpodctl."
---

View billing history for Pods, Serverless endpoints, and network volumes.
Expand Down
1 change: 1 addition & 0 deletions runpodctl/reference/runpodctl-config.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "config"
sidebarTitle: "config"
description: "Configure runpodctl with your Runpod API credentials and API URL."
---

Configure the Runpod CLI with your API credentials and API URL to enable programmatic access to your Runpod resources.
Expand Down
1 change: 1 addition & 0 deletions runpodctl/reference/runpodctl-datacenter.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "datacenter"
sidebarTitle: "datacenter"
description: "List Runpod data centers and their locations from the command line with runpodctl."
---

List available datacenters and their locations.
Expand Down
1 change: 1 addition & 0 deletions runpodctl/reference/runpodctl-doctor.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "doctor"
sidebarTitle: "doctor"
description: "Diagnose runpodctl configuration issues and set up API and SSH credentials for the Runpod CLI."
---

Diagnose and fix CLI issues, including first-time setup for API keys and SSH configuration.
Expand Down
1 change: 1 addition & 0 deletions runpodctl/reference/runpodctl-gpu.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "gpu"
sidebarTitle: "gpu"
description: "List Runpod GPU types, availability, and specifications from the command line with runpodctl."
---

List available GPU types and their specifications.
Expand Down
1 change: 1 addition & 0 deletions runpodctl/reference/runpodctl-hub.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "hub"
sidebarTitle: "hub"
description: "Browse and search deployable repositories in the Runpod Hub with runpodctl."
---

Browse and search the Runpod Hub marketplace to discover deployable repos. You can list popular repos, search by name, and get details for specific repos. Use Hub repo IDs with [`runpodctl serverless create --hub-id`](/runpodctl/reference/runpodctl-serverless) to deploy endpoints directly from the Hub.
Expand Down
1 change: 1 addition & 0 deletions runpodctl/reference/runpodctl-network-volume.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "network-volume"
sidebarTitle: "network-volume"
description: "Create, inspect, and manage persistent Runpod network volumes with runpodctl."
---

Manage network volumes for persistent shared storage across Pods and Serverless endpoints.
Expand Down
1 change: 1 addition & 0 deletions runpodctl/reference/runpodctl-pod.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "pod"
sidebarTitle: "pod"
description: "Create, list, start, stop, and delete Runpod Pods from the command line with runpodctl."
---

Manage Pods, including creating, listing, starting, stopping, and deleting Pods.
Expand Down
1 change: 1 addition & 0 deletions runpodctl/reference/runpodctl-receive.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "receive"
sidebarTitle: "receive"
description: "Receive files or folders over a secure peer-to-peer connection with runpodctl."
---

Receive files or folders sent from another machine using a secure peer-to-peer connection established with a connection code.
Expand Down
1 change: 1 addition & 0 deletions runpodctl/reference/runpodctl-registry.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "registry"
sidebarTitle: "registry"
description: "Manage private container registry credentials for Runpod deployments with runpodctl."
---

Manage container registry authentications for private Docker images.
Expand Down
1 change: 1 addition & 0 deletions runpodctl/reference/runpodctl-send.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "send"
sidebarTitle: "send"
description: "Send files or folders to a Runpod Pod or another computer with runpodctl."
---

Transfer files or folders from your local machine to a Pod or another computer using a secure peer-to-peer connection.
Expand Down
1 change: 1 addition & 0 deletions runpodctl/reference/runpodctl-serverless.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "serverless"
sidebarTitle: "serverless"
description: "Create, list, update, and delete Runpod Serverless endpoints with runpodctl."
---

import { VolumeDiskTooltip } from "/snippets/tooltips.jsx";
Expand Down
1 change: 1 addition & 0 deletions runpodctl/reference/runpodctl-ssh.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "ssh"
sidebarTitle: "ssh"
description: "Manage SSH keys and retrieve Pod connection information with runpodctl."
---

Manage SSH keys and get SSH connection information for Pods.
Expand Down
1 change: 1 addition & 0 deletions runpodctl/reference/runpodctl-template.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "template"
sidebarTitle: "template"
description: "List, search, inspect, and manage Runpod deployment templates with runpodctl."
---

import { VolumeDiskTooltip } from "/snippets/tooltips.jsx";
Expand Down
1 change: 1 addition & 0 deletions runpodctl/reference/runpodctl-update.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "update"
sidebarTitle: "update"
description: "Update runpodctl to the latest available version and verify the installed release."
---

Update `runpodctl` to the latest version to access new features and bug fixes.
Expand Down
1 change: 1 addition & 0 deletions runpodctl/reference/runpodctl-user.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "user"
sidebarTitle: "user"
description: "View your Runpod account information and current balance from the command line with runpodctl."
---

View your account information and current balance.
Expand Down
1 change: 1 addition & 0 deletions runpodctl/reference/runpodctl-version.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "version"
sidebarTitle: "version"
description: "Display the installed runpodctl version and confirm that your Runpod CLI is current."
---

Display the current version of `runpodctl` installed on your system.
Expand Down
2 changes: 1 addition & 1 deletion serverless/workers/github-integration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ For an example repository containing the minimal files necessary for deployment,

Before deploying from GitHub, you need to authorize Runpod to access your repositories:

1. Open the [settings page](http://console.runpod.io/user/settings) in the Runpod console.
1. Open the [settings page](https://console.runpod.io/user/settings) in the Runpod console.

2. Find the **GitHub** card under **Connections** and click **Connect**.

Expand Down
1 change: 1 addition & 0 deletions tips-and-tricks/tmux.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Using TMUX for persistent sessions"
sidebarTitle: "Persistent sessions with TMUX"
description: "Use TMUX on a Runpod Pod to keep terminal sessions and long-running workloads active after you disconnect."
icon: "square-terminal"
---

Expand Down
4 changes: 2 additions & 2 deletions tutorials/pods/run-your-first.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Run LLMs with JupyterLab using the transformers library"
title: "Run LLMs in JupyterLab with transformers"
sidebarTitle: "Run LLMs with JupyterLab"
description: "Learn how to run inference on the SmolLM3 model in JupyterLab using the transformers library. Follow the implementation steps in this Runpod tutorial."
---
Expand Down Expand Up @@ -172,4 +172,4 @@ Now that you have SmolLM3 running, you can explore more advanced use cases:

- **Integration with applications**: Use SmolLM3 as part of larger applications by integrating it with web frameworks or APIs.
- **Model comparison**: Try other models in the SmolLM3 family or compare with other small language models to find the best fit for your use case.
- **Persistent storage**: If you plan to work with SmolLM3 regularly, consider using a <NetworkVolumeTooltip /> to persist your models and notebooks across Pod sessions.
- **Persistent storage**: If you plan to work with SmolLM3 regularly, consider using a <NetworkVolumeTooltip /> to persist your models and notebooks across Pod sessions.
2 changes: 1 addition & 1 deletion tutorials/serverless/run-gemma-7b.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Deploy a chatbot with Gemma 3 and send requests using the OpenAI API"
title: "Deploy a Gemma 3 chatbot with the OpenAI API"
sidebarTitle: "Create a chatbot with Gemma 3"
description: "Deploy a Serverless endpoint with Google's Gemma 3 model using vLLM and the OpenAI API to build an interactive chatbot."
---
Expand Down
Loading