Skip to content

Commit ff1eca0

Browse files
committed
docs: Release notes for 0.14.0
Signed-off-by: Mike McKiernan <[email protected]>
1 parent 4bcedf5 commit ff1eca0

File tree

3 files changed

+77
-0
lines changed

3 files changed

+77
-0
lines changed

docs/conf.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,15 @@
6363
"_build/**",
6464
]
6565

66+
myst_url_schemes = {
67+
"http": None,
68+
"https": None,
69+
"pr": {
70+
"url": "https://github.com/NVIDIA/NeMo-Guardrails/pull/{{path}}",
71+
"title": "PR #{{path}}",
72+
},
73+
}
74+
6675
# intersphinx_mapping = {
6776
# 'gpu-op': ('https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest', None),
6877
# }

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: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
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+
The following sections summarize and highlight the changes for each release.
12+
For a complete record of changes in a release, refer to the
13+
[CHANGELOG.md](https://github.com/NVIDIA/NeMo-Guardrails/blob/develop/CHANGELOG.md) in the GitHub repository.
14+
15+
(0-14-0)=
16+
17+
## 0.14.0
18+
19+
(0-14-0-features)=
20+
21+
### Features
22+
23+
- Added support for Python 3.13.
24+
- Enhanced working with advanced reasoning models.
25+
- Added support for the NVIDIA Nemotron family of advanced reasoning models, such as Llama 3.1 Nemotron Ultra 253B V1.
26+
- Added the `rails.output.apply_to_reasoning_traces` field.
27+
When this field is `True`, output rails are applied to the reasoning traces and the model output.
28+
For more information, refer to [](./user-guides/configuration-guide.md#using-llms-with-reasoning-traces).
29+
- The `reasoning_config.remove_thinking_traces` field is deprecated and replaced by the `reasoning_config.remove_reasoning_traces` field that has the same purpose and subfields.
30+
- Using advanced reasoning models with dialog rails is not supported.
31+
- Simplified and broadened support for chat model providers from LangChain and
32+
LangChain Community chat model providers.
33+
You must use `langchain` version `0.2.14` or higher and `langchain-community` version `0.2.5` or higher.
34+
For information about using model providers, refer to [](./user-guides/configuration-guide.md#the-llm-model).
35+
- Added support for code injection detection.
36+
For more information, refer to [](./user-guides/guardrails-library.md#injection-detection).
37+
- Enhanced the `nemoguardrails` CLI with a `find-providers` argument to list chat and text completion providers.
38+
For more information, refer to [](./user-guides/cli.md#providers).
39+
40+
(0-14-0-breaking-changes)=
41+
42+
### Breaking Changes
43+
44+
- Removed support for the NeMo LLM Service, `nemollm`.
45+
This provider reached end-of-life on February 5, 2025.
46+
- The `HuggingFacePipelineCompatible` provider is refactored.
47+
Previously, the class was available from the `nemoguardrails.llm.providers` package.
48+
In this release, the class is moved to the `nemoguardrails.llm.providers.huggingface` package.
49+
50+
(0-14-0-fixed-issues)=
51+
52+
### Fixed Issues
53+
54+
- Fixed an issue when tracing is enabled.
55+
Previously, the response was replaced when tracing is enabled and could cause a crash or exception.
56+
In this release, the response is not modified when tracing is enabled.
57+
For more information, refer to <pr:1103>.
58+
59+
- Fixed an issue with the self check output flow.
60+
Previously, the `stop` instruction was not executed when `enable_rails_exceptions` was enabled.
61+
In this release, the `stop` instruction correctly regardless of the `enable_rails_execptions` value.
62+
For more information, refer to <pr:1126>.
63+
64+
- Previously, the model specification in the guardrails configuration file, `config.yml`, did not validate the model name.
65+
In this release you must specify the model name in the `model` top-level field or as `model` or `model_name` in
66+
the parameters field.
67+
For more information, refer to <pr:1084>.

0 commit comments

Comments
 (0)