Skip to content
Merged
85 changes: 40 additions & 45 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@
"pages": [
"serverless/overview",
"serverless/quickstart",
"serverless/sdks",
"serverless/pricing",
{
"group": "Create handler functions",
Expand All @@ -109,7 +110,9 @@
"serverless/development/error-handling",
"serverless/development/cleanup",
"serverless/development/write-logs",
"serverless/development/huggingface-models",
"serverless/development/environment-variables",
"serverless/development/aggregate-outputs",
"serverless/workers/concurrent-handler"
]
},
Expand All @@ -121,7 +124,6 @@
"serverless/workers/deploy",
"serverless/workers/github-integration",
"serverless/storage/overview",
"serverless/endpoints/model-caching",
"serverless/development/dual-mode-worker"
]
},
Expand All @@ -131,6 +133,7 @@
"serverless/endpoints/overview",
"serverless/endpoints/send-requests",
"serverless/endpoints/endpoint-configurations",
"serverless/endpoints/model-caching",
"serverless/development/optimization"
]
},
Expand Down Expand Up @@ -460,50 +463,6 @@
}
]
},
{
"tab": "SDK",
"groups": [
{
"group": "Python",
"pages": [
"sdks/python/overview",
"sdks/python/apis",
"sdks/python/endpoints",
{
"group": "Tutorials",
"pages": [
"tutorials/sdks/python/get-started/introduction",
"tutorials/sdks/python/get-started/prerequisites",
"tutorials/sdks/python/get-started/hello-world",
"tutorials/sdks/python/get-started/running-locally",
"tutorials/sdks/python/101/hello",
"tutorials/sdks/python/101/local-server-testing",
"tutorials/sdks/python/101/generator",
"tutorials/sdks/python/101/async",
"tutorials/sdks/python/101/error",
"tutorials/sdks/python/101/aggregate",
"tutorials/sdks/python/102/huggingface-models",
"tutorials/sdks/python/102/stable-diffusion-text-to-image"
]
}
]
},
{
"group": "JavaScript",
"pages": [
"sdks/javascript/overview",
"sdks/javascript/endpoints"
]
},
{
"group": "Go",
"pages": [
"sdks/go/overview",
"sdks/go/endpoints"
]
}
]
},
{
"tab": "CLI",
"groups": [
Expand Down Expand Up @@ -882,6 +841,42 @@
"source": "/hub/public-endpoint-reference",
"destination": "/public-endpoints/reference"
},
{
"source": "/sdks/python/overview",
"destination": "/serverless/sdks"
},
{
"source": "/sdks/python/endpoints",
"destination": "/serverless/endpoints/send-requests"
},
{
"source": "/sdks/python/apis",
"destination": "/api-reference/overview"
},
{
"source": "/sdks/javascript/overview",
"destination": "/serverless/sdks"
},
{
"source": "/sdks/javascript/endpoints",
"destination": "/serverless/endpoints/send-requests"
},
{
"source": "/sdks/go/overview",
"destination": "/serverless/sdks"
},
{
"source": "/sdks/go/endpoints",
"destination": "/serverless/endpoints/send-requests"
},
{
"source": "/tutorials/sdks/python/:slug*",
"destination": "/serverless/workers/handler-functions"
},
{
"source": "/get-started/install-sdks",
"destination": "/serverless/sdks"
},
{
"source": "/flash/endpoint-functions",
"destination": "/flash/create-endpoints"
Expand Down
2 changes: 1 addition & 1 deletion get-started/api-keys.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Manage API keys"
description: "Learn how to create, edit, and disable Runpod API keys."
description: "Create, edit, and disable Runpod API keys."
---

import { ServerlessTooltip } from "/snippets/tooltips.jsx";
Expand Down
2 changes: 1 addition & 1 deletion get-started/connect-to-runpod.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Choose a workflow"
description: "Review the available methods for accessing and managing Runpod resources."
description: "Review available methods for accessing and managing Runpod resources."
---

import { PodsTooltip, EndpointTooltip, ServerlessTooltip } from "/snippets/tooltips.jsx";
Expand Down
1 change: 1 addition & 0 deletions get-started/mcp-servers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Use Runpod's MCP servers"
sidebarTitle: "Runpod MCP servers"
description: "Connect AI tools to Runpod using the Model Context Protocol for infrastructure management and documentation access."
tag: "NEW"
---

Runpod provides two [Model Context Protocol (MCP)](https://modelcontextprotocol.io) servers that connect AI tools and coding agents directly to Runpod:
Expand Down
1 change: 0 additions & 1 deletion integrations/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: "Integrate your applications with Runpod"
sidebarTitle: "Overview"
description: "Integrate Runpod compute resources with your applications, external tools, and agentic frameworks."
tag: "NEW"
---

import { InferenceTooltip } from "/snippets/tooltips.jsx";
Expand Down
12 changes: 5 additions & 7 deletions pods/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ When you're ready to get started, [follow this tutorial](/get-started) to create

Each Pod consists of these core components:

- **Container environment**: An Ubuntu Linux-based container that can run almost any compatible software.
- **Container environment**: An Ubuntu Linux-based [container](/tutorials/introduction/containers) that can run almost any compatible software.
- **Unique identifier**: Each Pod receives a dynamic ID (e.g., `2s56cp0pof1rmt`) for management and access.
- [Storage](#storage-options):
- <PodContainerDiskTooltip />: Houses the operating system and temporary storage.
Expand All @@ -30,11 +30,11 @@ Each Pod consists of these core components:

## Pod templates

Pod <TemplatesTooltip /> are pre-configured Docker image setups that let you quickly spin up Pods without manual environment configuration. They're essentially deployment configurations that include specific models, frameworks, or workflows bundled together.
Pod <TemplatesTooltip /> are pre-configured [Docker image](/tutorials/introduction/containers#what-are-images) setups that let you quickly spin up Pods without manual environment configuration. They're essentially deployment configurations that include specific models, frameworks, or workflows bundled together.

Templates eliminate the need to manually set up environments, saving time and reducing configuration errors. For example, instead of installing PyTorch, configuring JupyterLab, and setting up all dependencies yourself, you can select an official Runpod PyTorch template and have everything ready to go instantly.

To learn how to create your own custom templates, see [Build a custom Pod template](/pods/templates/create-custom-template).
To learn how to create your own custom templates, see [Build a custom Pod template](/pods/templates/create-custom-template). If you're new to Docker, start with the [introduction to containers](/tutorials/introduction/containers) tutorial series.

## Storage

Expand All @@ -54,13 +54,11 @@ You can deploy Pods in several ways:

- [From a template](/pods/templates/overview): Pre-configured environments for quick setup of common workflows.
- **Custom containers**: Pull from any compatible container registry such as Docker Hub, GitHub Container Registry, or Amazon ECR.
- **Custom images**: Build and deploy your own container images.
- **Custom images**: [Build and deploy your own container images](/tutorials/introduction/containers/create-dockerfiles).
- [From Serverless repos](/hub/overview#deploy-as-a-pod): Deploy any <ServerlessTooltip />-compatible repository from the <RunpodHubTooltip /> directly as a Pod, providing a cost-effective option for consistent workloads.

<Note>

When building a container image for Runpod on a Mac (Apple Silicon), use the flag `--platform linux/amd64` to ensure your image is compatible with the platform.

When building a container image for Runpod on a Mac (Apple Silicon), use the flag `--platform linux/amd64` to ensure your image is compatible with the platform. Learn more about [building Docker images](/tutorials/introduction/containers/create-dockerfiles#building-for-runpod).
</Note>

## Connecting to your Pod
Expand Down
4 changes: 2 additions & 2 deletions pods/pricing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,8 @@ You can select your preferred pricing model directly from the Runpod console whe

Runpod offers [three types of storage](/pods/storage/types) for Pods::

- **Container volumes:** Temporary storage that is erased if the Pod is stopped, billed at \$0.10 per GB per month for storage on running Pods. Billed per-second.
- **Disk volumes:** Persistent storage that is billed at \$0.10 per GB per month on running Pods and \$0.20 per GB per month for volume storage on stopped Pods. Billed per-second.
- **Container disk:** Temporary storage that is erased if the Pod is stopped, billed at \$0.10 per GB per month for storage on running Pods. Billed per-second.
- **Volume disk:** Persistent storage that is billed at \$0.10 per GB per month on running Pods and \$0.20 per GB per month for volume storage on stopped Pods. Billed per-second.
- **Network volumes:** External storage that is billed at \$0.07 per GB per month for storage requirements below 1TB. For requirements exceeding 1TB, the rate is \$0.05 per GB per month. Billed hourly.

You are not charged for storage if the host <MachineTooltip /> is down or unavailable from the public internet.
Expand Down
2 changes: 1 addition & 1 deletion pods/storage/create-network-volumes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Network volumes are backed by high-performance storage servers co-located with R

Using network volumes provides significant flexibility that can lead to cost savings, especially if you need to frequently switch between Pods or share large datasets.

Network volume storage space costs less than for disk volumes (\$0.07/GB/month rather than \$0.10/GB/month), and storing data on a network volume can save you money compared to provisioning separate disk space for multiple Pods (even with just two Pods sharing one volume).
Network volume storage space costs less than for volume disks (\$0.07/GB/month rather than \$0.10/GB/month), and storing data on a network volume can save you money compared to provisioning separate disk space for multiple Pods (even with just two Pods sharing one volume).

For a deeper dive into potential benefits, read this [blog article on network volumes](https://blog.runpod.io/four-reasons-to-set-up-a/).

Expand Down
4 changes: 4 additions & 0 deletions pods/templates/create-custom-template.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ Before you begin, you'll need:
- A Docker Hub account (or access to another container registry).
- Basic familiarity with Docker and Python.

<Tip>
New to Docker? Learn the fundamentals with the [introduction to containers](/tutorials/introduction/containers) tutorial series, which covers [creating Dockerfiles](/tutorials/introduction/containers/create-dockerfiles), [Docker commands](/tutorials/introduction/containers/docker-commands), and [data persistence](/tutorials/introduction/containers/persist-data).
</Tip>

## Step 1: Set up your project structure

First, create a directory for your custom template and the necessary files.
Expand Down
2 changes: 1 addition & 1 deletion pods/templates/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Streamline your Pod deployments with templates, bundling prebuilt

import { PodTooltip, PodEnvironmentVariablesTooltip } from "/snippets/tooltips.jsx";

<PodTooltip /> templates are pre-configured Docker image setups that let you quickly spin up Pods without manual environment configuration. They're essentially deployment configurations that include specific models, frameworks, or workflows bundled together.
<PodTooltip /> templates are pre-configured [Docker image](/tutorials/introduction/containers#what-are-images) setups that let you quickly spin up Pods without manual environment configuration. They're essentially deployment configurations that include specific models, frameworks, or workflows bundled together.

Templates eliminate the need to manually set up environments, saving time and reducing configuration errors. For example, instead of installing PyTorch, configuring JupyterLab, and setting up all dependencies yourself, you can select a pre-configured template and have everything ready to go instantly.

Expand Down
Loading
Loading