Skip to content

Commit 4e9646b

Browse files
committed
chore(terminology): sweep Guardian Intrinsics → Guardian adapter functions
Replaces all remaining "Guardian Intrinsics" / "Guardian intrinsics" prose with "Guardian adapter functions" across 13 doc pages and one deprecation warning in guardian.py. Not covered by Phase 1 (#1136, symbol-only) or Phase 4 (#1144, deferred page rewrite) — safe to fix in this sweep. Also fixes 7 bare [Intrinsics](path) cross-doc links (missing .md suffix, violating CONTRIBUTING_DOCS.md) by adding the extension and updating link text to "Adapter functions". No page slugs are renamed; the intrinsics.md page stays in place until Phase 4. Assisted-by: Claude Code Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
1 parent 71b418c commit 4e9646b

14 files changed

Lines changed: 28 additions & 28 deletions

File tree

docs/docs/advanced/intrinsics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -254,9 +254,9 @@ Output format is task-specific — `requirement-check` returns a likelihood scor
254254

255255
---
256256

257-
## Guardian Intrinsics
257+
## Guardian adapter functions
258258

259-
Safety and factuality checks use a separate set of Guardian-specific intrinsics:
259+
Safety and factuality checks use a separate set of Guardian-specific adapter functions:
260260
`guardian_check()`, `policy_guardrails()`, `factuality_detection()`, and
261261
`factuality_correction()`. These are documented in the
262262
[Safety Guardrails](../how-to/safety-guardrails) how-to guide.

docs/docs/advanced/lora-and-alora-adapters.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Hugging Face account.
2020
>
2121
> Granite Switch models ship with pre-trained adapter functions embedded in the
2222
> model weights, which can be used via `OpenAIBackend` with
23-
> `load_embedded_adapters=True`. See [Intrinsics](./intrinsics) for details.
23+
> `load_embedded_adapters=True`. See [Adapter functions](./intrinsics.md) for details.
2424
2525
## LoRA vs aLoRA
2626

@@ -160,7 +160,7 @@ backend.default_to_constraint_checking_alora = False
160160
Set it back to `True` to re-enable. This flag is per-backend instance and does not
161161
affect other sessions.
162162

163-
**See also:** [Intrinsics](./intrinsics) |
163+
**See also:** [Adapter functions](./intrinsics.md) |
164164
[The Requirements System](../concepts/requirements-system) |
165165
[Write Custom Verifiers](../how-to/write-custom-verifiers) |
166166
[CLI Reference](../reference/cli)

docs/docs/advanced/prefix-caching-and-kv-blocks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,5 +132,5 @@ identical — disabling caching only affects whether prefill states are stored a
132132
reused.
133133

134134
**See also:** [HuggingFace Transformers](../integrations/huggingface) |
135-
[Intrinsics](./intrinsics) |
135+
[Adapter functions](./intrinsics.md) |
136136
[LoRA and aLoRA Adapters](./lora-and-alora-adapters)

docs/docs/concepts/architecture-vs-agents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ orchestrator:
135135
with [`ChatContext`](../reference/glossary#chatcontext) and the `@tool` decorator. See
136136
[Tools and Agents](../how-to/tools-and-agents).
137137
- **Guarded agents** — combine the ReACT pattern with `requirements` and
138-
[Guardian Intrinsics](../how-to/safety-guardrails) to enforce safety constraints
138+
[Guardian adapter functions](../how-to/safety-guardrails.md) to enforce safety constraints
139139
at every step.
140140
- **Structured outputs** — use `@generative` with Pydantic models or `Literal` types
141141
to enforce type-safe structured output at each step. See

docs/docs/examples/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ to run.
6161

6262
| Category | What it shows |
6363
| -------- | ------------- |
64-
| `intrinsics/` | [Guardian Intrinsics](../how-to/safety-guardrails.md): `guardian_check()` for harm, jailbreak, social bias, groundedness; `policy_guardrails()`; `factuality_detection()` / `factuality_correction()` |
64+
| `intrinsics/` | [Guardian adapter functions](../how-to/safety-guardrails.md): `guardian_check()` for harm, jailbreak, social bias, groundedness; `policy_guardrails()`; `factuality_detection()` / `factuality_correction()` |
6565
| `safety/` | *(Examples removed — see [Guardian how-to guide](../how-to/safety-guardrails.md) for the current API. The `RepairTemplateStrategy` gap is tracked in [#1071](https://github.com/generative-computing/mellea/issues/1071).)* |
6666

6767
### Integration and deployment

docs/docs/how-to/backends-and-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ print(str(result))
132132

133133
> **Backend note:** Requires `pip install "mellea[hf]"`. Models are downloaded from
134134
> HuggingFace Hub on first use. GPU recommended for reasonable inference speed.
135-
> Required for [Intrinsics](../advanced/intrinsics).
135+
> Required for [Adapter functions](../advanced/intrinsics.md).
136136
137137
Run models locally using HuggingFace transformers:
138138

docs/docs/how-to/safety-guardrails.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
22
title: "Safety Guardrails"
3-
description: "Use Guardian Intrinsics to detect harmful, biased, ungrounded, or policy-violating content in LLM outputs."
3+
description: "Use Guardian adapter functions to detect harmful, biased, ungrounded, or policy-violating content in LLM outputs."
44
# diataxis: how-to
55
---
66

77
**Prerequisites:** `pip install "mellea[hf]"` for local inference; Apple Silicon or CUDA GPU recommended.
8-
Guardian Intrinsics work via `LocalHFBackend` (local HuggingFace inference) or `OpenAIBackend`
8+
Guardian adapter functions work via `LocalHFBackend` (local HuggingFace inference) or `OpenAIBackend`
99
pointed at a Granite Switch endpoint.
1010

11-
Guardian Intrinsics evaluate LLM outputs for safety and quality using LoRA adapters
11+
Guardian adapter functions evaluate LLM outputs for safety and quality using LoRA adapters
1212
loaded directly into a HuggingFace backend — purpose-built for evaluation tasks, not
1313
general-purpose generation.
1414

15-
> **Generation vs evaluation:** Guardian Intrinsics evaluate content; they do not
15+
> **Generation vs evaluation:** Guardian adapter functions evaluate content; they do not
1616
> generate responses. Your session's generation backend (Ollama, OpenAI, etc.) is
1717
> unchanged. A separate `LocalHFBackend` instance handles evaluation only.
1818
@@ -316,7 +316,7 @@ else:
316316

317317
## Limitations
318318

319-
Guardian Intrinsics return a numeric score (or label string) rather than a
319+
Guardian adapter functions return a numeric score (or label string) rather than a
320320
[`Requirement`](../reference/glossary#requirement) instance, so they cannot be
321321
passed to `m.validate()` or wired into `RepairTemplateStrategy` the way the
322322
deprecated `GuardianCheck` could. The practical workaround is to call
@@ -339,4 +339,4 @@ Guardian functions also do not emit `mellea.requirement` metrics — see
339339
> [`factuality_correction.py`](https://github.com/generative-computing/mellea/blob/main/docs/examples/intrinsics/factuality_correction.py),
340340
> and [`policy_guardrails.py`](https://github.com/generative-computing/mellea/blob/main/docs/examples/intrinsics/policy_guardrails.py).
341341
342-
**See also:** [Intrinsics](../advanced/intrinsics) | [LoRA and aLoRA Adapters](../advanced/lora-and-alora-adapters) | [Tutorial: Making Agents Reliable](../tutorials/making-agents-reliable)
342+
**See also:** [Adapter functions](../advanced/intrinsics.md) | [LoRA and aLoRA Adapters](../advanced/lora-and-alora-adapters.md) | [Tutorial: Making Agents Reliable](../tutorials/making-agents-reliable.md)

docs/docs/how-to/use-context-and-sessions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ while keeping the session's backend and other configuration intact.
100100

101101
Subclass `MelleaSession` and override any method to inject custom behavior.
102102
The example below gates all incoming chat messages through
103-
[Guardian Intrinsics](../how-to/safety-guardrails) safety checks:
103+
[Guardian adapter functions](../how-to/safety-guardrails.md) safety checks:
104104

105105
```python
106106
from typing import Literal

docs/docs/integrations/huggingface.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ hardware. See the aLoRA guide for training and usage.
8989

9090
> **Tip:** For adapter functions without local GPU requirements, Granite Switch models
9191
> serve pre-embedded adapters via vLLM and the OpenAI backend. See
92-
> [Intrinsics](../advanced/intrinsics) for details.
92+
> [Adapter functions](../advanced/intrinsics.md) for details.
9393
9494
## Vision support
9595

docs/docs/integrations/openai.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,7 @@ backend = OpenAIBackend(
292292

293293
The high-level adapter function wrappers (`rag.check_answerability`,
294294
`core.check_certainty`, etc.) work identically with this backend. See
295-
[Intrinsics](../advanced/intrinsics) for the full list of available adapter functions.
295+
[Adapter functions](../advanced/intrinsics.md) for the full list of available adapter functions.
296296

297297
> **Note:** `load_embedded_adapters=True` downloads adapter I/O configurations
298298
> from the model's HuggingFace repository on first use. No adapter weights are

0 commit comments

Comments
 (0)