Skip to content

Commit 887561f

Browse files
committed
docs: Add release notes
Signed-off-by: Mike McKiernan <mmckiernan@nvidia.com>
1 parent 1bc565e commit 887561f

File tree

3 files changed

+39
-1
lines changed

3 files changed

+39
-1
lines changed

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
About NeMo Guardrails <self>
1919
getting-started/installation-guide
2020
getting-started.md
21+
release-notes.md
2122
```
2223

2324
```{toctree}

docs/release-notes.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
tocdepth: 2
3+
---
4+
<!--
5+
SPDX-FileCopyrightText: Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
6+
SPDX-License-Identifier: Apache-2.0
7+
-->
8+
9+
# Release Notes
10+
11+
## 0.14.0
12+
13+
### Breaking Changes
14+
15+
- Previously, the model specification in the guardrails configuration file, `config.yml`, supported `model_name` as a top-level field.
16+
In this release you must specify the model name in the `model` top-level field or as `model` or `model_name` in
17+
the parameters field.
18+
19+
Before:
20+
21+
```yaml
22+
models:
23+
- type: main
24+
engine: nim
25+
model_name: meta/llama-3.1-8b-instruct
26+
```
27+
28+
After:
29+
30+
```yaml
31+
models:
32+
- type: main
33+
engine: nim
34+
model: meta/llama-3.1-8b-instruct
35+
```
36+
37+
For more information, refer to [pull request #1084](https://github.com/NVIDIA/NeMo-Guardrails/pull/1084).

examples/configs/gs_content_safety/config/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
models:
22
- type: main
33
engine: nvidia_ai_endpoints
4-
model_name: meta/llama-3.3-70b-instruct
4+
model: meta/llama-3.3-70b-instruct
55

66
- type: content_safety
77
engine: nvidia_ai_endpoints

0 commit comments

Comments
 (0)