Skip to content

Commit 46cc329

Browse files
Merge pull request #473 from jasonnovichRunAI/v2.14
grammar and MD corrections
2 parents b9093ac + d2c1a02 commit 46cc329

File tree

2 files changed

+14
-15
lines changed

2 files changed

+14
-15
lines changed

docs/admin/researcher-setup/cli-install.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Install the Run:ai Command-line Interface
22

3-
The Run:ai Command-line Interface (CLI) is __one__ of the ways for a Researcher to send deep learning workloads, acquire GPU-based containers, list jobs, etc.
3+
The Run:ai Command-line Interface (CLI) is **one** of the ways for a Researcher to send deep learning workloads, acquire GPU-based containers, list jobs, etc.
44

55
The instructions below will guide you through the process of installing the CLI. The Run:ai CLI runs on Mac and Linux. You can run the CLI on Windows by using Docker for Windows. See the end of this document.
66

@@ -11,33 +11,32 @@ When enabled, Researcher authentication requires additional setup when installin
1111

1212
## Prerequisites
1313

14-
* When installing the command-line interface, it is worth considering future upgrades:
15-
* Install the CLI on a dedicated _Jumpbox_ machine. Researchers will connect to the Jumpbox from which they can submit Run:ai commands
14+
* When installing the command-line interface, it is worth considering future upgrades:
15+
* Install the CLI on a dedicated *Jumpbox* machine. Researchers will connect to the Jumpbox from which they can submit Run:ai commands
1616
* Install the CLI on a shared directory that is mounted on Researchers' machines.
17-
* A __Kubernetes configuration file__.
18-
17+
* A **Kubernetes configuration file**.
1918

2019
## Setup
2120

2221
### Kubernetes Configuration
2322

24-
* On the Researcher's root folder, create a directory _.kube_. Copy the Kubernetes configuration file into the directory. Each Researcher should have a __separate copy__ of the configuration file. The Researcher should have _write_ access to the configuration file as it stores user defaults.
25-
* If you choose to locate the file at a different location than `~/.kube/config`, you must create a shell variable to point to the configuration file as follows:
23+
* In the Researcher's root folder, create a directory *.kube*. Copy the Kubernetes configuration file into the directory. Each Researcher should have a **separate copy** of the configuration file. The Researcher should have *write* access to the configuration file as it stores user defaults.
24+
* If you choose to locate the file at a different location than `~/.kube/config`, you must create a shell variable to point to the configuration file as follows:
2625

2726
```
2827
export KUBECONFIG=<Kubernetes-config-file>
2928
```
3029

31-
* Test the connection by running:
30+
* Test the connection by running:
3231

3332
```
3433
kubectl get nodes
3534
```
3635

37-
### Install Run:ai CLI
36+
### Install Run:ai CLI
3837

3938
* Go to the Run:ai user interface. On the top right select `Researcher Command Line Interface`.
40-
* Select `Mac`, `Linux` or `Windows`.
39+
* Select `Mac`, `Linux` or `Windows`.
4140
* Download directly using the button or copy the file to run it on a remote machine
4241

4342
=== "Mac or Linux"
@@ -48,7 +47,7 @@ kubectl get nodes
4847
sudo mv runai /usr/local/bin/runai
4948
```
5049

51-
=== "Windows"
50+
=== "Windows"
5251
Rename the downloaded file to have a `.exe` extension and move the file to a folder that is a part of the `PATH`.
5352

5453
!!! Note
@@ -63,7 +62,7 @@ To verify the installation run:
6362
runai list jobs
6463
```
6564

66-
## Install Command Auto-Completion
65+
## Install Command Auto-Completion
6766

6867
It is possible to configure your Linux/Mac shell to complete Run:ai CLI commands. This feature works on _bash_ and _zsh_ shells only.
6968

docs/home/whats-new-2-14.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ August 2023
88

99
#### Release content
1010

11-
This version contains features and fixes from previous versions. Refer to the prior versions for specific features and fixes. For information about features, functionality, and fixed issues in previous versions see:
11+
This version contains new features and fixes in addition to the features and fixes from previous versions. For information about features, functionality, and fixed issues in previous versions see:
1212

1313
* [What's new 2.13](whats-new-2-13.md)
1414
* [What's new 2.12](whats-new-2-12.md)
@@ -24,7 +24,7 @@ TODO Add RBAC old--new conversion table here. -->
2424

2525
##### Auto delete jobs
2626
<!-- RUN-8586/RUN-11777 -->
27-
* We are pleased to announce new functionality in our UI and CLI that provides configuration options which automatically delete jobs after a specified amount of time. Auto-deletion provides more efficient use of resources and makes it easier for researchers to manage their jobs. For more configuration options in the UI, see Auto deletion (Step 9) in [Create a new workspace](../Researcher/user-interface/workspaces/create/workspace-v2.md#create-a-new-workspace). For more information on the CLI flag, see [--auto-deletion-time-after-completion](../Researcher/cli-reference/runai-submit.md).
27+
* We are pleased to announce new functionality in our UI and CLI that provides configuration options which automatically delete jobs after a specified amount of time. Auto-deletion provides more efficient use of resources and makes it easier for researchers to manage their jobs. For more configuration options in the UI, see *Auto deletion* (Step 9) in [Create a new workspace](../Researcher/user-interface/workspaces/create/workspace-v2.md#create-a-new-workspace). For more information on the CLI flag, see [--auto-deletion-time-after-completion](../Researcher/cli-reference/runai-submit.md).
2828

2929
##### Multiple service types
3030
<!-- RUN-10235/RUN-10485 Support multi service types in the CLI submission -->
@@ -47,7 +47,7 @@ TODO Add RBAC old--new conversion table here. -->
4747

4848
##### Policy improvements
4949
<!-- RUN-10575/RUN-10579 Add numeric rules in the policy to GPU memory, CPU memory & CPU -->
50-
* We are pleased to announce increased flexibility when creating policies. The improved flexibility includes the abililty to allocate a `min` and a `max` value for CPU and GPU memory. For configuration information, see [GPU and CPU memory limits](../admin/workloads/policies.md#gpu-and-cpu-memory-limits) in *Configuring policies*.
50+
* We are pleased to announce increased flexibility when creating policies. The improved flexibility includes the ability to allocate a `min` and a `max` value for CPU and GPU memory. For configuration information, see [GPU and CPU memory limits](../admin/workloads/policies.md#gpu-and-cpu-memory-limits) in *Configuring policies*.
5151

5252
##### Resource costing
5353
<!-- RUN-11421/RUN-11508 Consumption report cost and bugs -->

0 commit comments

Comments
 (0)