Skip to content

docs: Add release notes #1141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,15 @@
"_build/**",
]

myst_url_schemes = {
"http": None,
"https": None,
"pr": {
"url": "https://github.com/NVIDIA/NeMo-Guardrails/pull/{{path}}",
"title": "PR #{{path}}",
},
}

# intersphinx_mapping = {
# 'gpu-op': ('https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest', None),
# }
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
About NeMo Guardrails <self>
getting-started/installation-guide
getting-started.md
release-notes.md
```

```{toctree}
Expand Down
51 changes: 51 additions & 0 deletions docs/release-notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
tocdepth: 2
---
<!--
SPDX-FileCopyrightText: Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0
-->

# Release Notes

The following sections summarize and highlight the changes for each release.
For a complete record of changes in a release, refer to the
[CHANGELOG.md](https://github.com/NVIDIA/NeMo-Guardrails/blob/develop/CHANGELOG.md) in the GitHub repository.

## 0.14.0

### Features

- Added support for Python 3.13.
- Simplified and broadened support for chat model providers from LangChain and
LangChain Community chat model providers.
You must use `langchain` version `0.2.14` or higher and `langchain-community` version `0.2.5` or higher.
- Added support for code injection detection.
For more information, refer to [](./user-guides/guardrails-library.md#injection-detection).
- Enhanced the `nemoguardrails` CLI with a `find-providers` argument to list chat and text completion providers.
For more information, refer to [](./user-guides/cli.md#providers).

### Breaking Changes

- Removed support for the NeMo LLM Service, `nemollm`.
This provider reached end-of-life on February 5, 2025.
- The `HuggingFacePipelineCompatible` provider is refactored.
Previously, the class was available from the `nemoguardrails.llm.providers` package.
In this release, the class is moved to the `nemoguardrails.llm.providers.huggingface` package.

### Fixed Issues

- Fixed an issue when tracing is enabled.
Previously, the response was replaced when tracing is enabled and could cause a crash or exception.
In this release, the response is not modified when tracing is enabled.
For more information, refer to <pr:1103>.

- Fixed an issue with the self check output flow.
Previously, the `stop` instruction was not executed when `enable_rails_exceptions` was enabled.
In this release, the `stop` instruction correctly regardless of the `enable_rails_execptions` value.
For more information, refer to <pr:1126>.

- Previously, the model specification in the guardrails configuration file, `config.yml`, did not validate the model name.
In this release you must specify the model name in the `model` top-level field or as `model` or `model_name` in
the parameters field.
For more information, refer to <pr:1084>.