Skip to content

Commit 3b00a0c

Browse files
miyoungctgasser-nv
andauthored
docs: last bits of the revamp project (#1713)
Signed-off-by: Tim Gasser <200644301+tgasser-nv@users.noreply.github.com> Co-authored-by: Tim Gasser <200644301+tgasser-nv@users.noreply.github.com>
1 parent 7e1cf84 commit 3b00a0c

6 files changed

Lines changed: 10 additions & 72 deletions

File tree

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@
9191
# Top-level pages
9292
"architecture": "about/how-it-works.html",
9393
"architecture/readme": "reference/colang-architecture-guide.html",
94-
"faqs": "resources/faqs.html",
95-
"glossary": "resources/glossary.html",
94+
"faqs": "index.html",
95+
"glossary": "index.html",
9696
"release-notes": "about/release-notes.html",
9797
"security/guidelines": "resources/security/guidelines.html",
9898
# Getting started

docs/configure-rails/caching/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ content:
1414

1515
# Caching Instructions and Prompts
1616

17+
The NVIDIA NeMo Guardrails library provides two caching strategies to reduce inference latency.
18+
The in-memory model cache stores LLM responses and returns them for repeated prompts without calling the LLM again.
19+
KV cache reuse is a NIM-level optimization that avoids computation of the system prompt on each NemoGuard NIM call.
20+
You can enable either or both strategies independently.
21+
1722
::::{grid} 1 2 2 2
1823
:gutter: 3
1924

docs/configure-rails/custom-initialization/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ content:
2222

2323
# Configuring Custom Initialization
2424

25-
The `config.py` file contains initialization code that runs **once at startup**, before the `LLMRails` instance is fully initialized. Use it to register custom providers and set up shared resources.
25+
The `config.py` file contains initialization code that runs once at startup, before the `LLMRails` instance is fully initialized. Use it to register custom providers and set up shared resources.
2626

2727
## When to Use config.py vs actions.py
2828

@@ -53,7 +53,7 @@ Define the init() function to initialize resources and register action parameter
5353
:link: custom-llm-providers
5454
:link-type: doc
5555

56-
Register custom text completion (BaseLLM) and chat models (BaseChatModel) for use with NeMo Guardrails.
56+
Register custom text completion (BaseLLM) and chat models (BaseChatModel) for use with the NVIDIA NeMo Guardrails library.
5757
+++
5858
{bdg-secondary}`How To`
5959
:::
@@ -62,7 +62,7 @@ Register custom text completion (BaseLLM) and chat models (BaseChatModel) for us
6262
:link: custom-embedding-providers
6363
:link-type: doc
6464

65-
Register custom embedding providers for vector similarity search in NeMo Guardrails.
65+
Register custom embedding providers for vector similarity search in the NVIDIA NeMo Guardrails library.
6666
+++
6767
{bdg-secondary}`How To`
6868
:::

docs/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,5 @@ Troubleshooting <troubleshooting>
267267
:name: Resources
268268
:hidden:
269269
270-
FAQs <resources/faqs.md>
271-
Glossary <resources/glossary.md>
272270
Security <resources/security/guidelines.md>
273271
```

docs/resources/faqs.md

Lines changed: 0 additions & 45 deletions
This file was deleted.

docs/resources/glossary.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)