# Over Quota, Fairness and Preemption
This quick start provides a step-by-step walkthrough of the core scheduling concepts - [over quota](https://run-ai-docs.nvidia.com/self-hosted/2.20/platform-management/runai-scheduler/concepts#over-quota), [fairness](https://run-ai-docs.nvidia.com/self-hosted/2.20/platform-management/runai-scheduler/concepts#fairness-fair-resource-distribution), and [preemption](https://run-ai-docs.nvidia.com/self-hosted/2.20/platform-management/runai-scheduler/concepts#priority-and-preemption). It demonstrates the simplicity of resource provisioning and how the system eliminates bottlenecks by allowing users or teams to exceed their resource quota when free GPUs are available.
* **Over quota** - In this scenario, team-a runs two training workloads and team-b runs one. Team-a has a quota of 3 GPUs and is over quota by 1 GPU, while team-b has a quota of 1 GPU. The system allows this over quota usage as long as there are available GPUs in the cluster.
* **Fairness and preemption** - Since the cluster is already at full capacity, when team-b launches a new b2 workload requiring 1 GPU , team-a can no longer remain over quota. To maintain fairness, the [NVIDIA Run:ai Scheduler](https://run-ai-docs.nvidia.com/self-hosted/2.20/platform-management/runai-scheduler/scheduling/how-the-scheduler-works) preempts workload a1 (1 GPU), freeing up resources for team-b.
## **Prerequisites**
* You have created two [projects](https://run-ai-docs.nvidia.com/self-hosted/2.20/platform-management/aiinitiatives/organization/projects) - team-a and team-b - or have them created for you.
* Each project has an assigned quota of 2 GPUs.
## Step 1: Logging In
{% tabs %}
{% tab title="UI" %}
Browse to the provided NVIDIA Run:ai user interface and log in with your credentials.
{% endtab %}
{% tab title="CLI v2" %}
Log in using the following command. You will be prompted to enter your username and password:
```sh
runai login --help
```
{% endtab %}
{% tab title="CLI v1 (Deprecated)" %}
Log in using the following command. You will be prompted to enter your username and password:
```sh
runai login
```
{% endtab %}
{% tab title="API" %}
To use the API, you will need to obtain a token as shown in [API authentication](https://app.gitbook.com/s/b5QLzc5pV7wpXz3CDYyp/getting-started/how-to-authenticate-to-the-api).
{% endtab %}
{% endtabs %}
## Step 2: Submitting the First Training Workload (team-a)
{% tabs %}
{% tab title="UI" %}
1. Go to the Workload Manager → Workloads
2. Click **+NEW WORKLOAD** and select **Training**
3. Select under which **cluster** to create the workload
4. Select the **project** named team-a
5. Under **Workload architecture**, select **Standard**
6. Select **Start from scratch** to launch a new training quickly
7. Enter **a1** as the workload **name**
8. Click **CONTINUE**\
In the next step:
9. Create a new environment
* Click **+NEW ENVIRONMENT**
* Enter a **name** for the environment. The name must be unique.
* Enter the training **Image URL** - `runai.jfrog.io/demo/quickstart`
* Click **CREATE ENVIRONMENT**
The newly created environment will be selected automatically
10. Select the **'one-gpu'** compute resource for your workload (**GPU devices**: 1 )
* If 'one-gpu' is not displayed in the gallery, follow the below steps:
* Click **+NEW COMPUTE RESOURCE**
* Enter a **name** for the compute resource. The name must be unique.
* Set **GPU devices per pod:** 1
* Set **GPU memory per device:**
* Select **% (of device)** - Fraction of a GPU device's memory
* Set the memory **Request** - 100 (the workload will allocate 100% of the GPU memory)
* Optional: set the **CPU compute per pod** - 0.1 cores (default)
* Optional: set the **CPU memory per pod** - 100 MB (default)
* Click **CREATE COMPUTE RESOURCE**
The newly created compute resource will be selected automatically
11. Click **CREATE TRAINING**
{% endtab %}
{% tab title="CLI v2" %}
Copy the following command to your terminal. For more details, see [CLI reference](https://run-ai-docs.nvidia.com/self-hosted/2.20/reference/cli/runai):
```sh
runai training submit a1 -i runai.jfrog.io/demo/quickstart -g 1 -p team-a
```
{% endtab %}
{% tab title="CLI v1 (Deprecated)" %}
Copy the following command to your terminal. For more details, see [CLI reference](https://docs.run.ai/latest/Researcher/cli-reference/Introduction/):
runai submit a1 -i runai.jfrog.io/demo/quickstart -g 1 -p team-a
{% endtab %}
{% tab title="API" %}
Copy the following command to your terminal. Make sure to update the following parameters. For more details, see [Trainings](https://run-ai-docs.nvidia.com/api/2.20/workloads/trainings) API.
```bash
curl --location 'https:///api/v1/workloads/trainings' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \
--data '{
"name": "a1",
"projectId": "",
"clusterId": "",
"spec": {
"image":"runai.jfrog.io/demo/quickstart",
"compute": {
"gpuDevicesRequest": 1
}
}
}'
```
* `` - The link to the NVIDIA Run:ai user interface
* `` - The API access token obtained in [Step 1](#a13adq7eth7w)
* `` - The ID of the Project the workload is running on. You can get the Project ID via the [Get Projects](https://run-ai-docs.nvidia.com/api/2.20/organizations/projects#get-api-v1-org-unit-projects) API.
* `` - The unique identifier of the Cluster. You can get the Cluster UUID via the [Get Clusters](https://run-ai-docs.nvidia.com/api/2.20/organizations/clusters#get-api-v1-clusters) API.
{% hint style="info" %}
**Note**
The above API snippet runs with NVIDIA Run:ai clusters of 2.18 and above only.
{% endhint %}
{% endtab %}
{% endtabs %}
## Step 3: Submitting the Second Training Workload (team-a)
{% tabs %}
{% tab title="UI" %}
1. Go to the Workload Manager → Workloads
2. Click **+NEW WORKLOAD** and select **Training**
3. Select the **cluster** where the previous training workload was created
4. Select the **project** named team-a
5. Under **Workload architecture**, select **Standard**
6. Select **Start from scratch** to launch a new training quickly
7. Enter **a2** as the workload **name**
8. Click **CONTINUE**\
In the next step:
9. Select the environment created in [Step 2](#i3c9jpfzerlq)
10. Select the **'two-gpus'** compute resource for your workload (**GPU devices**: 2)
* If 'two-gpus' is not displayed in the gallery, follow the below steps:
* Click **+NEW COMPUTE RESOURCE**
* Enter a **name** for the compute resource. The name must be unique.
* Set **GPU devices per pod:** 2
* Set **GPU memory per device:**
* Select **% (of device)** - Fraction of a GPU device's memory
* Set the memory **Request** - 100 (the workload will allocate 100% of the GPU memory)
* Optional: set the **CPU compute per pod** - 0.1 cores (default)
* Optional: set the **CPU memory per pod** - 100 MB (default)
* Click **CREATE COMPUTE RESOURCE**
The newly created compute resource will be selected automatically
11. Click **CREATE TRAINING**
{% endtab %}
{% tab title="CLI v2" %}
Copy the following command to your terminal. For more details, see [CLI reference](https://run-ai-docs.nvidia.com/self-hosted/2.20/reference/cli/runai):
```sh
runai training submit a2 -i runai.jfrog.io/demo/quickstart -g 2 -p team-a
```
{% endtab %}
{% tab title="CLI v1 (Deprecated)" %}
Copy the following command to your terminal. For more details, see [CLI reference](https://docs.run.ai/latest/Researcher/cli-reference/Introduction/):
```sh
runai submit a2 -i runai.jfrog.io/demo/quickstart -g 2 -p team-a
```
{% endtab %}
{% tab title="API" %}
Copy the following command to your terminal. Make sure to update the following parameters. For more details, see [Trainings](https://run-ai-docs.nvidia.com/api/2.20/workloads/trainings) API.
```bash
curl --location 'https:///api/v1/workloads/trainings' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \
--data '{
"name": "a2",
"projectId": "",
"clusterId": "",
"spec": {
"image":"runai.jfrog.io/demo/quickstart",
"compute": {
"gpuDevicesRequest": 2
}
}
}'
```
* `` - The link to the NVIDIA Run:ai user interface
* `` - The API access token obtained in [Step 1](#a13adq7eth7w)
* `` - The ID of the Project the workload is running on. You can get the Project ID via the [Get Projects](https://run-ai-docs.nvidia.com/api/2.20/organizations/projects#get-api-v1-org-unit-projects) API.
* `` - The unique identifier of the Cluster. You can get the Cluster UUID via the [Get Clusters](https://run-ai-docs.nvidia.com/api/2.20/organizations/clusters#get-api-v1-clusters) API.
{% hint style="info" %}
**Note**
The above API snippet runs with NVIDIA Run:ai clusters of 2.18 and above only.
{% endhint %}
{% endtab %}
{% endtabs %}
## Step 4: Submitting the First Training Workload (team-b)
{% tabs %}
{% tab title="UI" %}
1. Go to the Workload Manager → Workloads
2. Click **+NEW WORKLOAD** and select **Training**
3. Select the **cluster** where the previous training was created
4. Select the **project** named team-b
5. Under **Workload architecture**, select **Standard**
6. Select **Start from scratch** to launch a new training quickly
7. Enter **b1** as the workload **name**
8. Click **CONTINUE**\
In the next step:
9. Create a new environment
* Click **+NEW ENVIRONMENT**
* Enter a **name** for the environment. The name must be unique.
* Enter the training **Image URL** - `runai.jfrog.io/demo/quickstart`
* Click **CREATE ENVIRONMENT**
10. Select the **'one-gpu'** compute resource for your workload (**GPU devices**: 1 )
* If 'one-gpu' is not displayed in the gallery, follow the below steps:
* Click **+NEW COMPUTE RESOURCE**
* Enter a **name** for the compute resource. The name must be unique.
* Set **GPU devices per pod:** 1
* Set **GPU memory per device:**
* Select **% (of device)** - Fraction of a GPU device's memory
* Set the memory **Request** - 100 (the workload will allocate 100% of the GPU memory)
* Optional: set the **CPU compute per pod** - 0.1 cores (default)
* Optional: set the **CPU memory per pod** - 100 MB (default)
* Click **CREATE COMPUTE RESOURCE**
The newly created compute resource will be selected automatically
11. Click **CREATE TRAINING**
{% endtab %}
{% tab title="CLI v2" %}
Copy the following command to your terminal. For more details, see [CLI reference](https://run-ai-docs.nvidia.com/self-hosted/2.20/reference/cli/runai):
```sh
runai training submit b1 -i runai.jfrog.io/demo/quickstart -g 1 -p team-b
```
{% endtab %}
{% tab title="CLI v1 (Deprecated)" %}
Copy the following command to your terminal. For more details, see [CLI reference](https://docs.run.ai/latest/Researcher/cli-reference/Introduction/):
```sh
runai submit b1 -i runai.jfrog.io/demo/quickstart -g 1 -p team-b
```
{% endtab %}
{% tab title="API" %}
Copy the following command to your terminal. Make sure to update the following parameters. For more details, see [Trainings](https://run-ai-docs.nvidia.com/api/2.20/workloads/trainings) API.
```bash
curl --location 'https:///api/v1/workloads/trainings' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \
--data '{
"name": "b1",
"projectId": "",
"clusterId": "",
"spec": {
"image":"runai.jfrog.io/demo/quickstart",
"compute": {
"gpuDevicesRequest": 1
}
}
}'
```
* `` - The link to the NVIDIA Run:ai user interface
* `` - The API access token obtained in [Step 1](#a13adq7eth7w)
* `` - The ID of the Project the workload is running on. You can get the Project ID via the [Get Projects](https://run-ai-docs.nvidia.com/api/2.20/organizations/projects#get-api-v1-org-unit-projects) API.
* `` - The unique identifier of the Cluster. You can get the Cluster UUID via the [Get Clusters](https://run-ai-docs.nvidia.com/api/2.20/organizations/clusters#get-api-v1-clusters) API.
{% hint style="info" %}
**Note**
The above API snippet runs with NVIDIA Run:ai clusters of 2.18 and above only.
{% endhint %}
{% endtab %}
{% endtabs %}
### Over Quota Status
{% tabs %}
{% tab title="UI" %}
System status after run:
{% endtab %}
{% tab title="CLI v2" %}
System status after run:
```sh
~ runai workload list -A
Workload Type Status Project Running/Req.Pods GPU Alloc.
────────────────────────────────────────────────────────────────────────────
a2 Training Running team-a 1/1 2.00
b1 Training Running team-b 1/1 1.00
a1 Training. Running team-a 0/1 1.00
```
{% endtab %}
{% tab title="CLI v1 (Deprecated)" %}
System status after run:
```sh
~ runai list -A
Workload Type Status Project Running/Req.Pods GPU Alloc.
────────────────────────────────────────────────────────────────────────────
a2 Training Running team-a 1/1 2.00
b1 Training Running team-b 1/1 1.00
a1 Training. Running team-a 0/1 1.00
```
{% endtab %}
{% tab title="API" %}
System status after run:
```
curl --location 'https:///api/v1/workloads' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \ # is the API access token obtained in Step 1.
--data ''
```
{% endtab %}
{% endtabs %}
## Step 5: Submitting the Second Training Workload (team-b)
{% tabs %}
{% tab title="UI" %}
1. Go to the Workload Manager → Workloads
2. Click **+NEW WORKLOAD** and select **Training**
3. Select the **cluster** where the previous training was created
4. Select the **project** named team-b
5. Under **Workload architecture**, select **Standard**
6. Select **Start from scratch** to launch a new training quickly
7. Enter **b2** as the workload **name**
8. Click **CONTINUE**\
In the next step:
9. Select the environment created in [Step 4](#i3c9jpfzerlq-2)
10. Select the compute resource created in [Step 4](#i3c9jpfzerlq-2)
11. Click **CREATE TRAINING**
{% endtab %}
{% tab title="CLI v2" %}
Copy the following command to your terminal. For more details, see [CLI reference](https://run-ai-docs.nvidia.com/self-hosted/2.20/reference/cli/runai):
```sh
runai training submit b2 -i runai.jfrog.io/demo/quickstart -g 1 -p team-b
```
{% endtab %}
{% tab title="CLI v1 (Deprecated)" %}
Copy the following command to your terminal. For more details, see [CLI reference](https://docs.run.ai/latest/Researcher/cli-reference/Introduction/):
```sh
runai submit b2 -i runai.jfrog.io/demo/quickstart -g 1 -p team-b
```
{% endtab %}
{% tab title="API" %}
Copy the following command to your terminal. Make sure to update the following parameters. For more details, see [Trainings](https://run-ai-docs.nvidia.com/api/2.20/workloads/trainings) API.
```bash
curl --location 'https:///api/v1/workloads/trainings' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \
--data '{
"name": "b2",
"projectId": "",
"clusterId": "",
"spec": {
"image":"runai.jfrog.io/demo/quickstart",
"compute": {
"gpuDevicesRequest": 1
}
}
}'
```
* `` - The link to the NVIDIA Run:ai user interface
* `` - The API access token obtained in [Step 1](#a13adq7eth7w)
* `` - The ID of the Project the workload is running on. You can get the Project ID via the [Get Projects](https://run-ai-docs.nvidia.com/api/2.20/organizations/projects#get-api-v1-org-unit-projects) API.
* `` - The unique identifier of the Cluster. You can get the Cluster UUID via the [Get Clusters](https://run-ai-docs.nvidia.com/api/2.20/organizations/clusters#get-api-v1-clusters) API.
{% hint style="info" %}
**Note**
The above API snippet runs with NVIDIA Run:ai clusters of 2.18 and above only.
{% endhint %}
{% endtab %}
{% endtabs %}
### Basic Fairness and Preemption Status
{% tabs %}
{% tab title="UI" %}
Workloads status after run:
{% endtab %}
{% tab title="CLI v2" %}
Workloads status after run:
```sh
~ runai workload list -A
Workload Type Status Project Running/Req.Pods GPU Alloc.
────────────────────────────────────────────────────────────────────────────
a2 Training Running team-a 1/1 2.00
b1 Training Running team-b 1/1 1.00
b2 Training Running team-b 1/1 1.00
a1 Training. Pending team-a 0/1 1.00
```
{% endtab %}
{% tab title="CLI v1 (Deprecated)" %}
Workloads status after run:
```sh
~ runai list -A
Workload Type Status Project Running/Req.Pods GPU Alloc.
────────────────────────────────────────────────────────────────────────────
a2 Training Running team-a 1/1 2.00
b1 Training Running team-b 1/1 1.00
b2 Training Running team-b 1/1 1.00
a1 Training. Pending team-a 0/1 1.00
```
{% endtab %}
{% tab title="API" %}
Workloads status after run:
```bash
curl --location 'https:///api/v1/workloads' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \ # is the API access token obtained in Step 1.
--data ''
```
{% endtab %}
{% endtabs %}
## Next Steps
Manage and monitor your newly created workload using the [Workloads](https://run-ai-docs.nvidia.com/self-hosted/2.20/workloads-in-nvidia-run-ai/workloads) table.
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://run-ai-docs.nvidia.com/self-hosted/2.20/platform-management/runai-scheduler/scheduling/quick-starts/over-quota.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.