Skip to content
Merged
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: 8 additions & 1 deletion .coderabbit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,13 @@ reviews:
# Default: true
review_status: false # current: true
path_instructions:
- path: "fern/docs.yml"
instructions: |
Redirect destinations for documentation pages must use the rendered Fern route from docs/index.yml, not the source file path.
In docs/index.yml, the rendered URL comes from the section/page `slug` hierarchy; the `path` field only points to the source MDX file.
For example, the source path docs/configure-rails/colang/colang-2/language-reference/introduction.mdx renders under /configure-guardrails/colang/colang-2/language-reference/introduction because the top-level Configure Guardrails section has slug `configure-guardrails`.
Do not suggest replacing valid rendered routes such as /configure-guardrails/... with source-path-derived routes such as /configure-rails/....
Before flagging a redirect destination as wrong, verify the route by tracing the relevant entries in docs/index.yml.
- path: "docs/**/*.mdx"
instructions: |
Internal absolute documentation links in Fern MDX pages must use the rendered Fern route, not the source file path.
Expand All @@ -54,7 +61,7 @@ reviews:
- docs/configure-rails/colang/index.mdx renders at /configure-guardrails/colang, not /configure-rails/colang.
- docs/run-rails/index.mdx renders at /run-guardrailed-inference/run-rails, not /run-rails.
- docs/getting-started/installation-guide.mdx renders at /get-started/installation-guide, not /getting-started/installation-guide.
Before flagging or suggesting fixes for internal docs links, verify them with scripts/check-docs-links.sh or docs/index.yml.
Before flagging or suggesting fixes for internal docs links, verify them with docs/index.yml.
Do not suggest changing valid Fern routes back to source-path-style links.
- path: "docs/**/*.ipynb"
instructions: |
Expand Down
146 changes: 0 additions & 146 deletions .github/workflows/docs-links-pr.yaml

This file was deleted.

6 changes: 1 addition & 5 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.PHONY: help
.PHONY: test test-parallel test-serial test-benchmark test-watch test-coverage test-profile warm-fastembed-cache
.PHONY: docs-fern docs-fern-strict docs-fern-live docs-fern-preview-watch docs-fern-generate-sdk docs-fern-fix-empty-links docs-check-links docs-check-redirects docs-fern-publish-staging docs-fern-publish-public
.PHONY: docs-fern docs-fern-strict docs-fern-live docs-fern-preview-watch docs-fern-generate-sdk docs-fern-fix-empty-links docs-check-redirects docs-fern-publish-staging docs-fern-publish-public
.PHONY: pre-commit

.DEFAULT_GOAL := help
Expand Down Expand Up @@ -70,9 +70,6 @@ docs-fern-generate-sdk:
docs-fern-fix-empty-links:
node scripts/fix-empty-fern-links.mjs

docs-check-links:
bash scripts/check-docs-links.sh --local-only

docs-check-redirects:
cd docs && poetry run python scripts/validate_redirects.py

Expand Down Expand Up @@ -109,7 +106,6 @@ help:
' docs-fern-preview-watch Watch and publish Fern preview for the current branch' \
' docs-fern-generate-sdk Regenerate Python SDK reference pages with Fern' \
' docs-fern-fix-empty-links Replace empty Markdown links with titles from Fern navigation' \
' docs-check-links Validate Markdown and MDX links locally' \
' docs-check-redirects Validate docs redirects' \
'' \
'Maintenance:' \
Expand Down
24 changes: 12 additions & 12 deletions docs/about/release-notes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ sidebar-title: "Release Notes"
description: "Review new features, breaking changes, and fixed issues for each release."
keywords: ["nemo guardrails changelog", "release notes", "version history"]
content:
type: "reference"
type: "reference"
---

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.
Expand Down Expand Up @@ -118,14 +119,13 @@ For a complete record of changes in a release, refer to the

---

## Previous Release Notes

- [0.21.0](https://docs.nvidia.com/nemo/guardrails/0.21.0/release-notes.html)
- [0.20.0](https://docs.nvidia.com/nemo/guardrails/0.20.0/release-notes.html)
- [0.19.0](https://docs.nvidia.com/nemo/guardrails/0.19.0/release-notes.html)
- [0.18.0](https://docs.nvidia.com/nemo/guardrails/0.18.0/release-notes.html)
- [0.17.0](https://docs.nvidia.com/nemo/guardrails/0.17.0/release-notes.html)
- [0.16.0](https://docs.nvidia.com/nemo/guardrails/0.16.0/release-notes.html)
- [0.15.0](https://docs.nvidia.com/nemo/guardrails/0.15.0/release-notes.html)
- [0.14.1](https://docs.nvidia.com/nemo/guardrails/0.14.1/release-notes.html)
- [0.14.0](https://docs.nvidia.com/nemo/guardrails/0.14.0/release-notes.html)
## Previous Releases

- [0.21.0](https://archive.docs.nvidia.com/nemo/guardrails/0.21.0/index.html)
- [0.20.0](https://archive.docs.nvidia.com/nemo/guardrails/0.20.0/index.html)
- [0.19.0](https://archive.docs.nvidia.com/nemo/guardrails/0.19.0/index.html)
- [0.18.0](https://archive.docs.nvidia.com/nemo/guardrails/0.18.0/index.html)
- [0.17.0](https://archive.docs.nvidia.com/nemo/guardrails/0.17.0/index.html)
- [0.16.0](https://archive.docs.nvidia.com/nemo/guardrails/0.16.0/index.html)
- [0.15.0](https://archive.docs.nvidia.com/nemo/guardrails/0.15.0/index.html)
- [0.14.1](https://archive.docs.nvidia.com/nemo/guardrails/0.14.1/index.html)
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,14 @@ flow bot express greeting
```
<Note>

The recommended practice is to use past tense for matching external actions, like the user saying something, and present for bot actions that must be executed. See [Defining Flows](../language-reference/defining-flows#flow-naming-conventions) for more details.
The recommended practice is to use past tense for matching external actions, like the user saying something, and present for bot actions that must be executed. See [Defining Flows](/configure-guardrails/colang/colang-2/language-reference/defining-flows#flow-naming-conventions) for more details.

</Note>
## LLM Integration

While the example above has more structure, it is still rigid in the sense that it only works with the exact inputs "hi" and "hello".

To enable the use of the LLM to drive the interaction for inputs that are not matched exactly by flows, you have to *activate* the `llm continuation` flow, which is part of the `llm` module in the [Colang Standard Library (CSL)](../language-reference/the-standard-library#the-standard-library).
To enable the use of the LLM to drive the interaction for inputs that are not matched exactly by flows, you have to *activate* the `llm continuation` flow, which is part of the `llm` module in the [Colang Standard Library (CSL)](/configure-guardrails/colang/colang-2/language-reference/the-standard-library#the-standard-library).

**examples/v2_x/tutorial/hello_world_3/main.co**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ flow main
```
<Note>

You can find the full example from this guide [here](../../../../../examples/v2_x/tutorial/hello_world_1).
You can find the full example from this guide [here](https://github.com/NVIDIA-NeMo/Guardrails/tree/develop/examples/v2_x/tutorial/hello_world_1).

</Note>
The achieve this, the `main` flow uses two pre-defined flows:
Expand All @@ -39,7 +39,7 @@ The two flows are located in the `core` module, included in the Colang Standard

<Note>

For more details, check out the [Colang Standard Library (CSL)](../language-reference/the-standard-library#the-standard-library).
For more details, check out the [Colang Standard Library (CSL)](/configure-guardrails/colang/colang-2/language-reference/the-standard-library#the-standard-library).

</Note>
## Testing
Expand Down
18 changes: 9 additions & 9 deletions docs/configure-rails/colang/colang-2/getting-started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ models:
engine: openai
model: gpt-4-turbo
```
The above config sets the Colang version to "2.x" (this is needed since "1.0" is currently the default) and the LLM engine to OpenAI's `gpt-4-turbo`. Make sure to set the required API access key as an environment variable (e.g. OPENAI_API_KEY for OpenAI API). See section [Supported Models](../language-reference/make-use-of-llms#make-use-of-llms-supported-models) for all supported models.
The above config sets the Colang version to "2.x" (this is needed since "1.0" is currently the default) and the LLM engine to OpenAI's `gpt-4-turbo`. Make sure to set the required API access key as an environment variable (e.g. OPENAI_API_KEY for OpenAI API). See section [Supported Models](/configure-guardrails/colang/colang-2/language-reference/make-use-of-llms#make-use-of-llms-supported-models) for all supported models.

<Note>

Check the section [Development and Debugging](../language-reference/development-and-debugging#development-and-debugging) for how you can install Colang syntax highlighting to make editing Colang scripts easier.
Check the section [Development and Debugging](/configure-guardrails/colang/colang-2/language-reference/development-and-debugging#development-and-debugging) for how you can install Colang syntax highlighting to make editing Colang scripts easier.

</Note>
## Terminology
Expand All @@ -40,43 +40,43 @@ At a high level, Colang adopts as much as possible from the Python terminology.
## Guides
<Cards>

<Card title="Hello World" href="hello-world">
<Card title="Hello World" href="/configure-guardrails/colang/colang-2/getting-started/hello-world">

Create the first Colang 2.0 flow.

</Card>

<Card title="Dialog Rails" href="dialog-rails">
<Card title="Dialog Rails" href="/configure-guardrails/colang/colang-2/getting-started/dialog-rails">

Add dialog rails with LLM integration.

</Card>

<Card title="Multimodal Rails" href="multimodal-rails">
<Card title="Multimodal Rails" href="/configure-guardrails/colang/colang-2/getting-started/multimodal-rails">

Use multimodal events and actions.

</Card>

<Card title="Input Rails" href="input-rails">
<Card title="Input Rails" href="/configure-guardrails/colang/colang-2/getting-started/input-rails">

Add input rails to inspect and block user input.

</Card>

<Card title="Interaction Loop" href="interaction-loop">
<Card title="Interaction Loop" href="/configure-guardrails/colang/colang-2/getting-started/interaction-loop">

Build a simple interaction loop.

</Card>

<Card title="LLM Flows" href="llm-flows">
<Card title="LLM Flows" href="/configure-guardrails/colang/colang-2/getting-started/llm-flows">

Let the LLM generate flow continuations.

</Card>

<Card title="Recommended Next Steps" href="recommended-next-steps">
<Card title="Recommended Next Steps" href="/configure-guardrails/colang/colang-2/getting-started/recommended-next-steps">

Choose what to learn after the getting started guide.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This section explains how to create *input rails* in Colang 2.0.

To activate input rails in Colang 2.0, you must:

1. Import the `guardrails` module from the [Colang Standard Library (CSL)](../language-reference/the-standard-library#the-standard-library).
1. Import the `guardrails` module from the [Colang Standard Library (CSL)](/configure-guardrails/colang/colang-2/language-reference/the-standard-library#the-standard-library).
2. Define a flow called `input rails`, which takes a single parameter called `$input_text`.

In the example below, the `input rails` flow calls another flow named `check user message` which prompts the LLM to check the input.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The example below shows how you can control the greeting behavior of an interact

<Note>

The [Colang Standard Library (CSL)](../language-reference/the-standard-library#the-standard-library) includes an `avatars` module with flows for multimodal events and actions to implement interactive avatars use cases.
The [Colang Standard Library (CSL)](/configure-guardrails/colang/colang-2/language-reference/the-standard-library#the-standard-library) includes an `avatars` module with flows for multimodal events and actions to implement interactive avatars use cases.

</Note>
**examples/v2_x/tutorial/multi_modal/main.co**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ The Colang 2.0 getting started guide introduces you to a basic [Hello World](hel

This only scratches the surface of what can be achieved with Colang 2.0.

If you are an experienced developer and want to learn about the syntax and various features in details, we recommend going through the [Language Reference](../language-reference/index#colang_2_language_reference) documentation.
If you are an experienced developer and want to learn about the syntax and various features in details, we recommend going through the [Language Reference](/configure-guardrails/colang/colang-2/language-reference#colang_2_language_reference) documentation.

Version `0.10.0` of NeMo Guardrails will add more examples including RAG and agents. Also it will bring support for the Guardrails Library, which will enable you to use any of the existing guardrails similar to Colang 1.0.
8 changes: 4 additions & 4 deletions docs/configure-rails/colang/colang-2/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,25 @@ Use this guide to review what changed from Colang 1.0, migrate existing configur

<Cards>

<Card title="What's Changed" href="whats-changed">
<Card title="What's Changed" href="/configure-guardrails/colang/colang-2/whats-changed">

Review the main language and runtime changes in Colang 2.0.

</Card>

<Card title="Migration Guide" href="migration-guide">
<Card title="Migration Guide" href="/configure-guardrails/colang/colang-2/migration-guide">

Convert Colang 1.0 configurations to Colang 2.x.

</Card>

<Card title="Getting Started" href="getting-started">
<Card title="Getting Started" href="/configure-guardrails/colang/colang-2/getting-started">

Work through the Colang 2.0 tutorial sequence.

</Card>

<Card title="Language Reference" href="language-reference">
<Card title="Language Reference" href="/configure-guardrails/colang/colang-2/language-reference">

Explore syntax and standard library reference material.

Expand Down
Loading
Loading