Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
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
2 changes: 1 addition & 1 deletion .cursor/rules/rp-styleguide.mdc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ globs:
alwaysApply: true
---
Always use sentence case for headings and titles.
These are proper nouns: Pods, Serverless, Hub, Instant Clusters, Secure Cloud, Community Cloud, Tetra.
These are proper nouns: Runpod, Pods, Serverless, Hub, Instant Clusters, Secure Cloud, Community Cloud, Tetra.
These are generic terms: endpoint, worker, cluster, template, handler, fine-tune, network volume.
Prefer using paragraphs to bullet points unless specifically requested.
When using bullet points, use hyphens instead of asterisks, and end each line with a period.
74 changes: 37 additions & 37 deletions api-reference/openapi.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"openapi": "3.0.3",
"info": {
"title": "RunPod API",
"description": "Public Rest API for managing RunPod programmatically.",
"title": "Runpod API",
"description": "Public Rest API for managing Runpod programmatically.",
"version": "0.1.0",
"contact": {
"name": "help",
Expand All @@ -11,7 +11,7 @@
}
},
"externalDocs": {
"description": "Find out more about RunPod.",
"description": "Find out more about Runpod.",
"url": "https://runpod.io"
},
"servers": [
Expand All @@ -34,7 +34,7 @@
},
{
"name": "network volumes",
"description": "Manage RunPod network volumes."
"description": "Manage Runpod network volumes."
},
{
"name": "templates",
Expand All @@ -46,7 +46,7 @@
},
{
"name": "billing",
"description": "Retrieve billing history for your RunPod account."
"description": "Retrieve billing history for your Runpod account."
}
],
"paths": {
Expand Down Expand Up @@ -82,7 +82,7 @@
"security": [],
"responses": {
"200": {
"description": "The Docs UI for the OpenAPI schema.",
"description": "The docs UI for the OpenAPI schema.",
"content": {
"text/html": {
"schema": {
Expand All @@ -96,8 +96,8 @@
}
},
"summary": "Documentation Page",
"description": "Interactive API documentation powered by Scalar.",
"operationId": "GetDocs"
"description": "Interactive API documentation.",
"operationId": "GetDocs",
}
},
"/pods": {
Expand Down Expand Up @@ -182,7 +182,7 @@
"example": [
"EU-RO-1"
],
"description": "Filter to Pods located in any of the provided RunPod data centers."
"description": "Filter to Pods located in any of the provided Runpod data centers."
}
},
{
Expand Down Expand Up @@ -1746,7 +1746,7 @@
"US-GA-1"
]
},
"description": "Filter to endpoints located in any of the provided RunPod data centers. The data center IDs are listed in the response of the /pods endpoint."
"description": "Filter to endpoints located in any of the provided Runpod data centers. The data center IDs are listed in the response of the /pods endpoint."
}
},
{
Expand Down Expand Up @@ -1968,7 +1968,7 @@
"adjustedCostPerHr": {
"type": "number",
"example": 0.69,
"description": "The effective cost in RunPod credits per hour of running a Pod, adjusted by active Savings Plans."
"description": "The effective cost in Runpod credits per hour of running a Pod, adjusted by active Savings Plans."
},
"aiApiId": {
"type": "string",
Expand All @@ -1978,7 +1978,7 @@
"consumerUserId": {
"type": "string",
"example": "user_2PyTJrLzeuwfZilRZ7JhCQDuSqo",
"description": "A unique string identifying the RunPod user who rents a Pod."
"description": "A unique string identifying the Runpod user who rents a Pod."
},
"containerDiskInGb": {
"type": "integer",
Expand All @@ -1994,7 +1994,7 @@
"type": "number",
"example": "0.74",
"format": "currency",
"description": "The cost in RunPod credits per hour of running a Pod. Note that the actual cost may be lower if Savings Plans are applied."
"description": "The cost in Runpod credits per hour of running a Pod. Note that the actual cost may be lower if Savings Plans are applied."
},
"cpuFlavorId": {
"type": "string",
Expand Down Expand Up @@ -2268,7 +2268,7 @@
"dataCenterId": {
"type": "string",
"example": "EU-RO-1",
"description": "The RunPod data center ID where a network volume is located."
"description": "The Runpod data center ID where a network volume is located."
}
},
"description": "If a network volume is attached to a Pod, information about the network volume (see [network volume schema](#/components/schemas/NetworkVolume))."
Expand Down Expand Up @@ -2515,7 +2515,7 @@
"cpu5m"
]
},
"description": "If the created Pod is a CPU Pod, a list of RunPod CPU flavors which can be attached to the Pod. The order of the list determines the order to rent CPU flavors. See cpuFlavorPriority for how the order of the list affects Pod creation."
"description": "If the created Pod is a CPU Pod, a list of Runpod CPU flavors which can be attached to the Pod. The order of the list determines the order to rent CPU flavors. See cpuFlavorPriority for how the order of the list affects Pod creation."
},
"cpuFlavorPriority": {
"type": "string",
Expand Down Expand Up @@ -2591,7 +2591,7 @@
"US-GA-1"
]
},
"description": "A list of RunPod data center IDs where the created Pod can be located. See `dataCenterPriority` for information on how the order of the list affects Pod creation."
"description": "A list of Runpod data center IDs where the created Pod can be located. See `dataCenterPriority` for information on how the order of the list affects Pod creation."
},
"dataCenterPriority": {
"type": "string",
Expand Down Expand Up @@ -2685,7 +2685,7 @@
"NVIDIA B200"
]
},
"description": "If the created Pod is a GPU Pod, a list of RunPod GPU types which can be attached to the created Pod. The order of the list determines the order to rent GPU types. See `gpuTypePriority` for information on how the order of the list affects Pod creation."
"description": "If the created Pod is a GPU Pod, a list of Runpod GPU types which can be attached to the created Pod. The order of the list determines the order to rent GPU types. See `gpuTypePriority` for information on how the order of the list affects Pod creation."
},
"gpuTypePriority": {
"type": "string",
Expand Down Expand Up @@ -2806,7 +2806,7 @@
"dataCenterId": {
"type": "string",
"example": "EU-RO-1",
"description": "The RunPod data center ID where a network volume is located."
"description": "The Runpod data center ID where a network volume is located."
}
}
}
Expand All @@ -2817,7 +2817,7 @@
"dataCenterId": {
"type": "string",
"example": "EU-RO-1",
"description": "The RunPod data center ID where a network volume is located."
"description": "The Runpod data center ID where a network volume is located."
},
"id": {
"type": "string",
Expand Down Expand Up @@ -2847,7 +2847,7 @@
"dataCenterId": {
"type": "string",
"example": "EU-RO-1",
"description": "The RunPod data center ID where the created network volume is located."
"description": "The Runpod data center ID where the created network volume is located."
},
"name": {
"type": "string",
Expand Down Expand Up @@ -2892,7 +2892,7 @@
"category": {
"type": "string",
"example": "NVIDIA",
"description": "The category of the template. The category can be used to filter templates in the RunPod UI. Current categories are NVIDIA, AMD, and CPU."
"description": "The category of the template. The category can be used to filter templates in the Runpod UI. Current categories are NVIDIA, AMD, and CPU."
},
"containerDiskInGb": {
"type": "integer",
Expand Down Expand Up @@ -2921,7 +2921,7 @@
"earned": {
"type": "number",
"example": 100,
"description": "The amount of RunPod credits earned by the creator of a template by all Pods or workers created from the template."
"description": "The amount of Runpod credits earned by the creator of a template by all Pods or workers created from the template."
},
"env": {
"type": "object",
Expand All @@ -2946,12 +2946,12 @@
"isPublic": {
"type": "boolean",
"example": false,
"description": "Set to true if a template is public and can be used by any RunPod user. Set to false if a template is private and can only be used by the creator."
"description": "Set to true if a template is public and can be used by any Runpod user. Set to false if a template is private and can only be used by the creator."
},
"isRunpod": {
"type": "boolean",
"example": true,
"description": "If true, a template is an official template managed by RunPod."
"description": "If true, a template is an official template managed by Runpod."
},
"isServerless": {
"type": "boolean",
Expand All @@ -2976,7 +2976,7 @@
},
"readme": {
"type": "string",
"description": "A string of markdown-formatted text that describes a template. The readme is displayed in the RunPod UI when a user selects the template."
"description": "A string of markdown-formatted text that describes a template. The readme is displayed in the Runpod UI when a user selects the template."
},
"runtimeInMin": {
"type": "integer"
Expand Down Expand Up @@ -3052,7 +3052,7 @@
"isPublic": {
"type": "boolean",
"default": false,
"description": "If this is a Pod template, specifies whether the template is visible to other RunPod users."
"description": "If this is a Pod template, specifies whether the template is visible to other Runpod users."
},
"isServerless": {
"type": "boolean",
Expand Down Expand Up @@ -3098,7 +3098,7 @@
"isPublic": {
"type": "boolean",
"default": false,
"description": "If this is a Pod template, specifies whether the template is visible to other RunPod users."
"description": "If this is a Pod template, specifies whether the template is visible to other Runpod users."
},
"name": {
"type": "string",
Expand Down Expand Up @@ -3167,7 +3167,7 @@
"isPublic": {
"type": "boolean",
"default": false,
"description": "If this is a Pod template, specifies whether the template is visible to other RunPod users."
"description": "If this is a Pod template, specifies whether the template is visible to other Runpod users."
},
"name": {
"type": "string",
Expand Down Expand Up @@ -3306,7 +3306,7 @@
"US-GA-1"
]
},
"description": "A list of RunPod data center IDs where workers on a Serverless endpoint can be located."
"description": "A list of Runpod data center IDs where workers on a Serverless endpoint can be located."
},
"env": {
"type": "object",
Expand Down Expand Up @@ -3373,7 +3373,7 @@
"NVIDIA B200"
]
},
"description": "A list of RunPod GPU types which can be attached to a Serverless endpoint."
"description": "A list of Runpod GPU types which can be attached to a Serverless endpoint."
},
"id": {
"type": "string",
Expand Down Expand Up @@ -3430,7 +3430,7 @@
"userId": {
"type": "string",
"example": "user_2PyTJrLzeuwfZilRZ7JhCQDuSqo",
"description": "A unique string identifying the RunPod user who created a Serverless endpoint."
"description": "A unique string identifying the Runpod user who created a Serverless endpoint."
},
"version": {
"type": "integer",
Expand Down Expand Up @@ -3544,7 +3544,7 @@
"cpu5g"
]
},
"description": "If the created Serverless endpoint is a CPU endpoint, a list of RunPod CPU flavors which can be attached to the created workers. The order of the list determines the order to rent CPU flavors."
"description": "If the created Serverless endpoint is a CPU endpoint, a list of Runpod CPU flavors which can be attached to the created workers. The order of the list determines the order to rent CPU flavors."
},
"dataCenterIds": {
"type": "array",
Expand Down Expand Up @@ -3611,7 +3611,7 @@
"US-GA-1"
]
},
"description": "A list of RunPod data center IDs where workers on the created Serverless endpoint can be located."
"description": "A list of Runpod data center IDs where workers on the created Serverless endpoint can be located."
},
"executionTimeoutMs": {
"type": "integer",
Expand Down Expand Up @@ -3674,7 +3674,7 @@
"NVIDIA B200"
]
},
"description": "If the created Serverless endpoint is a GPU endpoint, a list of RunPod GPU types which can be attached to the created workers. The order of the list determines the order to rent GPU types."
"description": "If the created Serverless endpoint is a GPU endpoint, a list of Runpod GPU types which can be attached to the created workers. The order of the list determines the order to rent GPU types."
},
"idleTimeout": {
"type": "integer",
Expand Down Expand Up @@ -3776,7 +3776,7 @@
"cpu5g"
]
},
"description": "If the created Serverless endpoint is a CPU endpoint, a list of RunPod CPU flavors which can be attached to the created workers. The order of the list determines the order to rent CPU flavors."
"description": "If the created Serverless endpoint is a CPU endpoint, a list of Runpod CPU flavors which can be attached to the created workers. The order of the list determines the order to rent CPU flavors."
},
"dataCenterIds": {
"type": "array",
Expand Down Expand Up @@ -3843,7 +3843,7 @@
"US-GA-1"
]
},
"description": "A list of RunPod data center IDs where workers on the created Serverless endpoint can be located."
"description": "A list of Runpod data center IDs where workers on the created Serverless endpoint can be located."
},
"executionTimeoutMs": {
"type": "integer",
Expand Down Expand Up @@ -3906,7 +3906,7 @@
"NVIDIA B200"
]
},
"description": "If the created Serverless endpoint is a GPU endpoint, a list of RunPod GPU types which can be attached to the created workers. The order of the list determines the order to rent GPU types."
"description": "If the created Serverless endpoint is a GPU endpoint, a list of Runpod GPU types which can be attached to the created workers. The order of the list determines the order to rent GPU types."
},
"idleTimeout": {
"type": "integer",
Expand Down
4 changes: 2 additions & 2 deletions containers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: "Containers"
<Card href="/tutorials/introduction/containers/overview">
## 📄️ Overview

Learn how to build and deploy applications on the RunPod platform with this set of tutorials, covering tools, technologies, and deployment methods, including Containers, Docker, and Serverless implementation.
Learn how to build and deploy applications on the Runpod platform with this set of tutorials, covering tools, technologies, and deployment methods, including Containers, Docker, and Serverless implementation.

</Card>

Expand Down Expand Up @@ -33,6 +33,6 @@ Learn how to persist data outside of containers by creating named volumes, mount
<Card href="/tutorials/introduction/containers/docker-commands">
## 📄️ Docker commands

RunPod enables BYOC development with Docker, providing a reference sheet for commonly used Docker commands, including login, images, containers, Dockerfile, volumes, network, and execute.
Runpod enables BYOC development with Docker, providing a reference sheet for commonly used Docker commands, including login, images, containers, Dockerfile, volumes, network, and execute.

</Card>
6 changes: 3 additions & 3 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"icons": {
"library": "fontawesome"
},
"favicon": "/og-icon-trim.svg",
"favicon": "/logo/Color.svg",
"navigation": {
"tabs": [
{
Expand Down Expand Up @@ -496,8 +496,8 @@
}
},
"logo": {
"light": "/og-logo-light.svg",
"dark": "/og-logo-dark.svg"
"dark": "/logo/runpod-logo-white.svg",
"light": "/logo/runpod-logo-black.svg"
},

"navbar": {
Expand Down
4 changes: 2 additions & 2 deletions fine-tune.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
title: "Fine-tune a model"
---

This guide explains how to fine-tune a large language model using RunPod and Axolotl. You'll learn how to select a base model, configure your training environment, and start the fine-tuning process.
This guide explains how to fine-tune a large language model using Runpod and Axolotl. You'll learn how to select a base model, configure your training environment, and start the fine-tuning process.

## Prerequisites

Before you begin fine-tuning, ensure you have:

* A RunPod account with access to the Fine Tuning feature
* A Runpod account with access to the Fine Tuning feature
* (Optional) A Hugging Face access token for gated models

## Select a base model
Expand Down
Loading