Skip to content

Commit 2eaa4ca

Browse files
authored
style updates on the Upgrade doc content (#170)
## Description nvidia style guide skill updates to the upgrade ## Release intent single file update focused on the upgrade doc only <!-- pair-release-intent:v1 --> ### Changelog title n/a ### Changelog body n/a ### Bumps - services: none - nvpair-cluster-manager: none - nvpair-engine-manager: none - nvpair-errors: none - nvpair-job-scheduler: none - nvpair-manual-nodes: none - nvpair-node-info: none - nvpair-node-scanner: none - nvpair-node-settings: none - nvpair-proxy: none - nvpair-tui: none - nvpair-ui-broker: none - nvpair-workload-manager: none <!-- /pair-release-intent:v1 --> ## Scope one file only reviewed using nvidia style guide skill ## Validation <!-- List exact commands, environments, and manual checks. --> ## Risk <!-- Note compatibility, security, data, packaging, or migration concerns. --> ## Checklist - [x] I have read the [Contributing Guidelines](https://github.com/NVIDIA/Personal-AI-Router/blob/main/CONTRIBUTING.md). - [ ] Every commit is signed off (`git commit -s`), certifying the [Developer Certificate of Origin](https://developercertificate.org/). - [ ] New or existing tests cover the change. - [x] Relevant documentation is updated. - [ ] I checked the diff, changed filenames, and commit messages for credentials, private data, internal URLs, internal issue identifiers, and generated artifacts. - [ ] I recorded the validation commands and results above. - [ ] I declared version bumps in the release-intent block above. `services/versions.json` is written by automation — do not edit it by hand. Signed-off-by: meg miranda <mmiranda@nvidia.com>
1 parent 1a0b606 commit 2eaa4ca

1 file changed

Lines changed: 18 additions & 17 deletions

File tree

‎docs/upgrade-guide.mdx‎

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ SPDX-License-Identifier: Apache-2.0
55

66
# Upgrade Guide
77

8-
Updating to PAIR 1.0.0 works the same way as any other update. Your settings,
9-
cluster membership, and downloaded models all carry over, so for most machines
10-
there is nothing extra to do. Install the update as described in
11-
[Keeping PAIR Up to Date](getting-started.mdx#keeping-pair-up-to-date), and
8+
Updating to NVIDIA Personal AI Router (PAIR) 1.0.0 works the same way as any
9+
other update. Your settings, cluster membership, and downloaded models all carry
10+
over, so for most machines there is nothing extra to do. Install the update as
11+
described in [Keeping PAIR Up to Date](getting-started.mdx#keeping-pair-up-to-date), and
1212
update each machine in your cluster so they all run the same version.
1313

1414
A few situations call for a small extra step. Each section below says who it
@@ -25,7 +25,7 @@ For everything that is new in this release, refer to
2525

2626
The macOS application is now called **NVIDIA PAIR**. Earlier versions were
2727
installed as `PAIR.app`, and because the name changed, the new disk image adds
28-
`NVIDIA PAIR.app` beside the old app instead of replacing it. Keep just one by
28+
`NVIDIA PAIR.app` beside the old app instead of replacing it. Keep only one by
2929
removing the old app with the uninstaller it includes. The uninstaller keeps
3030
your settings, cluster membership, engines, and models.
3131

@@ -44,12 +44,12 @@ your settings, cluster membership, engines, and models.
4444
The uninstaller is a better choice than dragging the old app to the Trash,
4545
because it also removes PAIR's firewall rules and the helper that manages them.
4646

47-
If you updated from within PAIR using **Restart & install**, the update was
48-
applied to your existing app, which keeps working under the `PAIR.app` name.
47+
If you updated from within PAIR using **Restart & install**, PAIR applied the
48+
update to your existing app, which keeps working under the `PAIR.app` name.
4949
PAIR finds its files and data from wherever the app is, not by its name, so
50-
there is nothing more to do unless you also install `NVIDIA PAIR.app` from the
51-
disk image, in which case remove `PAIR.app` as above. If PAIR does not reopen
52-
after **Restart & install**, open it from **Applications**.
50+
there is nothing more to do. If you also install `NVIDIA PAIR.app` from the
51+
disk image, remove `PAIR.app` as described earlier in this section. If PAIR
52+
does not reopen after **Restart & install**, open it from **Applications**.
5353

5454
## If an Earlier PAIR Installed LM Studio for You
5555

@@ -109,27 +109,28 @@ This applies only to browser-based clients. Command-line tools, IDEs, agents,
109109
and desktop applications are not affected.
110110

111111
PAIR's local endpoints now use each engine's own browser access setting, known
112-
as CORS, rather than allowing every website. That means a web page can reach
113-
your models through PAIR only if you have allowed it in the engine. If a
112+
as cross-origin resource sharing (CORS), rather than allowing every website.
113+
That means a web page can reach your models through PAIR only if you have
114+
allowed it in the engine. If a
114115
browser-based client stopped connecting after the update, allow it in the
115-
engine's launch options. Ollama and llama.cpp take a list of allowed addresses;
116-
LM Studio has an on/off switch instead:
116+
engine's launch options. Ollama and llama.cpp take a list of allowed addresses,
117+
and LM Studio has an on/off switch instead:
117118

118119
| Engine | Setting |
119120
| --- | --- |
120121
| Ollama | Add the address to `OLLAMA_ORIGINS`, for example `OLLAMA_ORIGINS="https://example.com"` |
121-
| LM Studio | Add the `--cors` switch. It takes no address; LM Studio decides which origins it allows. |
122+
| LM Studio | Add the `--cors` switch. It takes no address, and LM Studio decides which origins it allows. |
122123
| llama.cpp | Add the address to `--cors-origins` |
123124

124125
Make the change on the machine that runs the engine. For Ollama and llama.cpp,
125-
include the address's scheme, such as `https://`; a wildcard on its own (`*`)
126+
include the address's scheme, such as `https://`. A wildcard on its own (`*`)
126127
or a bare `localhost` is not accepted. If requests can be routed to other
127128
machines in your cluster, make the change on each of them.
128129
[Engine Settings](engine-settings.mdx) has the details.
129130

130131
## Checking Everything Is Working
131132

132-
After updating each machine, you can confirm that **Settings → Service** shows
133+
After updating each machine, you can confirm that **Settings > Service** shows
133134
the new version, its engines are running in **Overview**, and its paired
134135
machines are still listed. If anything looks wrong,
135136
[Troubleshooting](troubleshooting.mdx) can help.

0 commit comments

Comments
 (0)