Skip to content

Commit 6bf8771

Browse files
Merge pull request #744 from jasonnovichRunAI/v2.17-RUN-14525-Add-inference-to-env-creation
RUN-14525 add inference and change workload types
2 parents de27349 + 7fea148 commit 6bf8771

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

docs/Researcher/user-interface/workspaces/create/create-env.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,27 @@ To create an environment:
88
4. Enter the image URL path and an image pull policy.
99
5. Choose a supported workload type. Configure this section based on the type of workload you expect to run in this environment. Choose from:
1010

11-
* `Single node`—use for running workloads on a single node.
12-
* `Multi-node`—use for running distributed workloads on multiple nodes.
11+
* *Standard*—use for running workloads on a single node.
12+
* *Distributed*—use for running distributed workloads on multiple nodes.
1313

1414
Then choose the workload that can use the environment:
1515

16-
* `Workspace`
17-
* `Training`
18-
6. In the *Supported workload types* pane select either `Single node` or `Multi-node (Distributed)`.
16+
* *Workspace*
17+
* *Training*
18+
* *Inference*
1919

20-
1. If you selected `Single node`, select `Workspace`, or `Training` or both.
21-
2. If you selected `Multi-node (Distributed)`, select a framework from the dropdown, then select `Workspace`, or `Training` or both.
20+
If you selected *Inference*, in the *endpoint* pane, select a *Protocol* from the dropdown, then enter the *Container port*.
2221

23-
7. Select a tool from the list. You can add multiple tools by pressing *+ Tool*. Selecting a tool is optional.
22+
6. Select a tool from the list. You can add multiple tools by pressing *+ Tool*. Selecting a tool is optional.
2423

2524
Tools can be:
2625

2726
* Different applications such as Code editor IDEs (for example, VS Code), Experiment tracking (for example, Weight and Biases), visualization tools (for example, Tensor Board), and more.
2827
* Open source tools (for example, Jupyter notebook) or commercial 3rd party tools (for example,. MATLAB)
2928

29+
!!! Note
30+
Tool configuration is not supported with *Inference* environments.
31+
3032
It is also possible to set up a custom tool used by the organization.
3133

3234
For each tool, you must set the type of connection interface and port. If not set, default values are provided. The supported connection types are:
@@ -35,12 +37,14 @@ To create an environment:
3537
* External node port: A [NodePort](../../../../admin/runai-setup/config/allow-external-access-to-containers.md) exposes your application externally on every host of the cluster, access the tool using `http://<HOST_IP>:<NODEPORT>` (for example, http://203.0.113.20:30556).
3638

3739
!!! Note
38-
Selecting a tool requires configuration to be up and running. To configure a tool:
40+
Selecting a tool requires a configuration to be up and running.
41+
42+
To configure a tool:
3943

4044
* The container image needs to support the tool.
4145
* The administrator must configure a DNS record and certificate. For more information, see [Workspaces configuration](../../../../admin/runai-setup/config/allow-external-access-to-containers.md#workspaces-configuration).
4246

43-
8. Configure runtime settings with:
47+
7. Configure runtime settings with:
4448

4549
1. Commands and arguments&mdash;visible, but not editable in the workspace creation form.
4650
2. Environment variables&mdash;visible and editable in the workspace creation form.
@@ -49,15 +53,15 @@ To create an environment:
4953
!!! Note
5054
The value of an environment variable can remain empty for the researcher to fill in when creating a workspace.
5155

52-
9. Configure the security settings from:
56+
8. Configure the security settings from:
5357

5458
1. Settings in the image&mdash;security settings that come with the image file.
5559
2. Custom settings:
5660

57-
1. User ID.
58-
2. Group ID.
59-
3. Supplementary Groups.
60-
4. Values modification settings.
61+
1. User ID.
62+
2. Group ID.
63+
3. Supplementary Groups.
64+
4. Values modification settings.
6165

6266
3. Add linux capabilities.
6367

0 commit comments

Comments
 (0)