Submitting Workloads
How to Submit a Workload¶
To submit a workload using the UI:
- In the left menu press Workloads.
- Press New Workload, and select Workspace, Training, or Inference.
- In the Projects pane, select a project. Use the search box to find projects that are not listed. If you can't find the project, see your system administrator.
- In the Templates pane, select a template from the list. Use the search box to find templates that are not listed. If you can't find the specific template you need, create a new one, or see your system administrator.
- Enter a
Workspace
name, and press continue. -
In the Environment pane select or create a new environment. Use the search box to find environments that are not listed.
- In the Set the connection for your tool(s) pane, choose a tool for your environment (if available). In the Access pane, edit the field and choose a type of access. Everyone allows all users in the platform to access the selected tool. Group allows you a select a specific group of users (Identity provider group). Press
+Group
to add more groups. User allows you to grant access individual users (by user email) in the platform. Press+User
to add more users. (optional) - In the Runtime settings field, Set commands and arguments for the container running in the pod. (optional)
- In the Environment variable field, you can set one or more environment variables. (optional)
- In the Set the connection for your tool(s) pane, choose a tool for your environment (if available). In the Access pane, edit the field and choose a type of access. Everyone allows all users in the platform to access the selected tool. Group allows you a select a specific group of users (Identity provider group). Press
-
In the Compute resource pane, select resources for your trainings or create a new compute resource. Use the search box to find resources that are not listed. Press More settings to use Node Affinity to limit the resources to a specific node.
-
Open the Volume pane, and press Volume to add a volume to your training.
- Select the Storage class from the dropdown.
- Select the Access mode from the dropdown.
- Enter a claim size, and select the units.
- Select a Volume system, mode from the dropdown.
- Enter the Container path for volume target location.
- Select a Volume persistency.
-
In the Data sources pane, select a data source. If you need a new data source, press add a new data source. For more information, see Creating a new data source When complete press, Create Data Source.
Note
- Data sources that have private credentials, which have the status of issues found, will be greyed out.
- Data sources can now include Secrets.
-
In the General pane, add special settings for your training (optional):
- Toggle the switch to allow the workspace to exceed the project's quota.
- Set the backoff limit before workload failure, this can be changed, if necessary. Use integers only. (Default = 6, maximum = 100, minimum = 0).
- Press Auto-deletion to delete the training automatically when it either completes or fails. You can configure the timeframe in days, hours, minuets, and seconds. If the timeframe is set to 0, the training will be deleted immediately after it completes or fails. (default = 30 days)
- Press Annotation to a name and value to annotate the training. Repeat this step to add multiple annotations.
- Press Label to a name and value to label the training. Repeat this step to add multiple labels.
-
When complete, press Create workspace.
- In the Projects pane, select the destination project. Use the search box to find projects that are not listed. If you can't find the project, you can create your own, or see your system administrator.
- In the Multi-node pane, choose
Single node
for a single node training, orMulti-node (distributed)
for distributed training. When you chooseMulti-node
, select a framework that is listed, then select themulti-node
training configuration by selecting eitherWorkers & master
orWorkers only
. - In the Templates pane, select a template from the list. Use the search box to find templates that are not listed. If you can't find the specific template you need, see your system administrator.
- In the Training name pane, enter a name for the Training, then press continue.
- In the Environment pane select or create a new environment. Use the search box to find environments that are not listed.
- In the Set the connection for your tool(s) pane, choose a tool for your environment (if available). In the Access pane, edit the field and choose a type of access. Everyone allows all users in the platform to access the selected tool. Group allows you a select a specific group of users (Identity provider group). Press
+Group
to add more groups. User allows you to grant access individual users (by user email) in the platform. Press+User
to add more users. (optional) - In the Runtime settings field, Set commands and arguments for the container running in the pod. (optional)
- In the Environment variable field, you can set one or more environment variables. (optional)
- In the Set the connection for your tool(s) pane, choose a tool for your environment (if available). In the Access pane, edit the field and choose a type of access. Everyone allows all users in the platform to access the selected tool. Group allows you a select a specific group of users (Identity provider group). Press
-
In the Compute resource pane:
- Select the number of workers for your training.
- Select Compute resources for your training or create a new compute resource. Use the search box to find resources that are not listed. Press More settings to use Node Affinity to limit the resources to a specific node.
Note
The number of compute resources for the workers is based on the number of workers selected.
-
(Optional) Open the Volume pane, and press Volume to add a volume to your training.
- Select the Storage class from the dropdown.
- Select the Access mode from the dropdown.
- Enter a claim size, and select the units.
- Select a Volume system, mode from the dropdown.
- Enter the Container path for volume target location.
- Select a Volume persistency. Choose Persistent or Ephemeral.
-
(Optional) In the Data sources pane, select a data source. If you need a new data source, press add a new data source. For more information, see Creating a new data source When complete press, Create Data Source.
Note
- Data sources that have private credentials, which have the status of issues found, will be greyed out.
- Data sources can now include Secrets.
-
(Optional) In the General pane, add special settings for your training (optional):
- Set the backoff limit before workload failure, this can be changed, if necessary. Use integers only. (Default = 6, maximum = 100, minimum = 0).
- Press Auto-deletion to delete the training automatically when it either completes or fails. You can configure the timeframe in days, hours, minuets, and seconds. If the timeframe is set to 0, the training will be deleted immediately after it completes or fails. (default = 30 days)
- Press Annotation to a name and value to annotate the training. Repeat this step to add multiple annotations.
- Press Label to a name and value to label the training. Repeat this step to add multiple labels.
-
If you if selected
Workers & master
Press Continue toConfigure the master
and go to the next step. If not, then press Create training. -
If you do not want a different setup for the master, press Create training. If you would like to have a different setup for the master, toggle the switch to enable to enable a different setup.
- In the Environment pane select or create a new environment. Use the search box to find environments that are not listed. Press More settings to add an
Environment variable
or to edit the Command and Arguments field for the environment you selected.- In the Set the connection for your tool(s) pane, choose a tool for your environment (if available). In the Access pane, edit the field and choose a type of access. Everyone allows all users in the platform to access the selected tool. Group allows you a select a specific group of users (Identity provider group). Press
+Group
to add more groups. User allows you to grant access individual users (by user email) in the platform. Press+User
to add more users. (optional) - In the Runtime settings field, Set commands and arguments for the container running in the pod. (optional)
- In the Environment variable field, you can set one or more environment variables. (optional)
- In the Set the connection for your tool(s) pane, choose a tool for your environment (if available). In the Access pane, edit the field and choose a type of access. Everyone allows all users in the platform to access the selected tool. Group allows you a select a specific group of users (Identity provider group). Press
- In the Compute resource pane, select a Compute resources for your training or create a new compute resource. Use the search box to find resources that are not listed. Press More settings to use Node Affinity to limit the resources to a specific node.
-
(Optional) Open the Volume pane, and press Volume to add a volume to your training.
- Select the Storage class from the dropdown.
- Select the Access mode from the dropdown.
- Enter a claim size, and select the units.
- Select a Volume system, mode from the dropdown.
- Enter the Container path for volume target location.
- Select a Volume persistency. Choose Persistent or Ephemeral.
-
(Optional) In the Data sources pane, select a data source. If you need a new data source, press add a new data source. For more information, see Creating a new data source When complete press, Create Data Source.
!!! Note * Data sources that have private credentials, which have the status of issues found, will be greyed out. * Data sources can now include Secrets.
-
(Optional) In the General pane, add special settings for your training (optional):
- Set the backoff limit before workload failure, this can be changed, if necessary. Use integers only. (Default = 6, maximum = 100, minimum = 0).
- Press Auto-deletion to delete the training automatically when it either completes or fails. You can configure the timeframe in days, hours, minuets, and seconds. If the timeframe is set to 0, the training will be deleted immediately after it completes or fails. (default = 30 days)
- Press Annotation to a name and value to annotate the training. Repeat this step to add multiple annotations.
- Press Label to a name and value to label the training. Repeat this step to add multiple labels.
- In the Environment pane select or create a new environment. Use the search box to find environments that are not listed. Press More settings to add an
-
When your training configuration is complete. press Create training.
- In the Projects pane, select a project. Use the search box to find projects that are not listed. If you can't find the project, see your system administrator.
-
In the Inference by type pane select Custom or model.
When you select Model:
- Select a catalog. Choose from Run:ai or Hugging Face.
- If you choose Run:ai, select a model from the tiles. Use the search box to find a model that is not listed. If you can't find the model, see your system administrator.
- If you choose Hugging Face, go to the next step.
- In the Inference name field, enter a name for the workload.
- In the Credentials field, enter the token to access the model catalog.
- If you selected Hugging Face, enter the name of the model in the Model Name section. This will not appear if you selected Run:ai.
-
In the Compute resource field, select a compute resource from the tiles.
- In the Replica autoscaling section, set the minimum and maximum replicas for your inference.
- In the Set conditions for creating a new replica section, use the drop down to select from
Throughput (Requests/sec)
,Latency (milliseconds)
, orConcurrency (Requests/sec)
. Then set the value. (default = 100) This section will only appear if you have 2 or more set as the maximum. - In the Set when replicas should be automatically scaled down to zero section, from the drop down select Never, After one, five, 15 or 30 minutes of inactivity.
Note
When automatic scaling to zero is enabled, the minimum number of replicas is 0.
- In the Nodes field, change the order of priority of the node pools, or add a new node pool to the list.
-
When complete, press Create inference.
When you select Custom:
- In the Inference name field, enter a name for the workload.
- In the Environment field, select an environment. Use the search box to find an environment that is not listed. If you can't find an environment, press New environment or see your system administrator.
- In the Set the connection for your tool(s) pane, choose a tool for your environment (if available). In the Access pane, edit the field and choose a type of access. Everyone allows all users in the platform to access the selected tool. Group allows you a select a specific group of users (Identity provider group). Press
+Group
to add more groups. User allows you to grant access individual users (by user email) in the platform. Press+User
to add more users. (optional) - In the Runtime settings field, Set commands and arguments for the container running in the pod. (optional)
- In the Environment variable field, you can set one or more environment variables. (optional)
- In the Set the connection for your tool(s) pane, choose a tool for your environment (if available). In the Access pane, edit the field and choose a type of access. Everyone allows all users in the platform to access the selected tool. Group allows you a select a specific group of users (Identity provider group). Press
-
In the Compute resource field, select a compute resource from the tiles. Use the search box to find a compute resource that is not listed. If you can't find an environment, press New compute resource or see your system administrator.
- In the Replica autoscaling section, set the minimum and maximum replicas for your inference.
- In the Set conditions for creating a new replica section, use the drop down to select from
Throughput (Requests/sec)
,Latency (milliseconds)
, orConcurrency (Requests/sec)
. Then set the value. (default = 100) This section will only appear if you have 2 or more set as the maximum. - In the Set when replicas should be automatically scaled down to zero section, from the drop down select Never, After one, five, 15 or 30 minutes of inactivity.
Note
When automatic scaling to zero is enabled, the minimum number of replicas is 0.
-
In the Data sources field, add a New data source. (optional)
Note
- Data sources that are not available will be greyed out.
- Assets that are cluster syncing will be greyed out.
- Only PVC, Git, and ConfigMap resources are supported.
-
In the General field you can:
- Add an Auto-deletion time. This sets the timeframe between inference completion/failure and auto-deletion. (optional) (default = 30 days)
- Add one or more Annotation. (optional)
- Add one or more Labels. (optional)
- When complete, press Create inference.
- Select a catalog. Choose from Run:ai or Hugging Face.
Workload Policies¶
As an administrator, you can set Policies on Workloads. Policies allow administrators to impose restrictions and set default values for Researcher Workloads. For more information see Workload Policies.
Workload Ownership Protection¶
Workload ownership protection in Run:ai ensures that only users who created a workload can delete or modify them. This feature is designed to safeguard important jobs and configurations from accidental or unauthorized modifications by users who did not originally create the workload.
By enforcing ownership rules, Run:ai helps maintain the integrity and security of your machine learning operations. This additional layer of security ensures that only users with the appropriate permissions can delete and suspend workloads.
This protection maintains workflow stability and prevents disruptions in shared or collaborative environments.
This feature is implemented at the cluster management entity level.
To enable ownership protection:
- Update the runai-public configmap and set
workloadOwnershipProtection=true
. - Perform a cluster-sync to update cluster-service in the CP.
- Use the workload-service flag to block deletion and suspension of workloads, when appropriate.