Skip to content

docs(inspect): add Inspect AI adapter documentation - #96

Merged
julpayne merged 7 commits into
eval-hub:mainfrom
ruivieira:feat/aisi-docs
Jul 28, 2026
Merged

docs(inspect): add Inspect AI adapter documentation#96
julpayne merged 7 commits into
eval-hub:mainfrom
ruivieira:feat/aisi-docs

Conversation

@ruivieira

@ruivieira ruivieira commented Jul 28, 2026

Copy link
Copy Markdown
Member

What and why

Adds upstream documentation for the Inspect AI adapter so EvalHub users can discover and run Petri/Bloom alignment audits and inspect-evals benchmarks through the service.

Covers overview (architecture, quick start via SDK CLI / Python / REST), configuration (model roles, parameters, env vars), a benchmarks catalog (75 IDs across Petri, Bloom, and inspect-evals), and JobSpec examples. Registers the section in the Adapters sidebar.

Type

  • feat
  • fix
  • docs
  • refactor / chore
  • test / ci

Testing

  • Tests added or updated
  • Tested manually

Summary by CodeRabbit

  • New Features
    • Added an Inspect AI adapter section to the documentation navigation.
    • Documented Inspect AI integration, supported execution modes, configuration options, credentials, and deployment behavior.
    • Added benchmark references covering Petri, Bloom, and Inspect evaluations.
    • Added copy-ready examples for common providers, benchmarks, deployment setups, CLI usage, SDK, and REST API submissions.

@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@ruivieira, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 42 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 5905bc64-b3f7-49a3-8375-e3e9ba137df4

📥 Commits

Reviewing files that changed from the base of the PR and between f1887e4 and e0d1622.

📒 Files selected for processing (3)
  • src/content/docs/adapters/inspect/benchmarks.md
  • src/content/docs/adapters/inspect/configuration.md
  • src/content/docs/adapters/inspect/examples.mdx
📝 Walkthrough

Walkthrough

Adds a complete Inspect AI adapter documentation section covering architecture, configuration, benchmarks, deployment examples, and sidebar navigation.

Changes

Inspect AI adapter documentation

Layer / File(s) Summary
Adapter overview and navigation
src/content/docs/adapters/inspect/index.mdx, astro.config.mjs
Documents adapter routing, workflow, providers, containers, and quick-start usage, and adds sidebar links for the Inspect AI pages.
Configuration reference
src/content/docs/adapters/inspect/configuration.md
Documents submission fields, credentials, role-specific parameters, execution controls, and Kubernetes/container behavior.
Benchmark reference
src/content/docs/adapters/inspect/benchmarks.md
Catalogs Petri, Bloom, inspect-evals, and custom benchmarks with execution-mode and metric details.
Deployment examples
src/content/docs/adapters/inspect/examples.mdx
Provides MaaS, Petri, Bloom, standard evaluation, Dish, custom task, and CLI configuration examples.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related PRs

Suggested labels: kind/docs

Suggested reviewers: gnaulak-redhat, julpayne, ppadashe-psp, nbs-rh, scheruku-rh

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately summarizes the main change: adding Inspect AI adapter documentation.
Description check ✅ Passed It covers the required What/why, Type, and Testing sections; only the issue link and breaking-changes section are missing.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 6

🧹 Nitpick comments (1)
src/content/docs/adapters/inspect/index.mdx (1)

172-185: 🔒 Security & Privacy | 🔵 Trivial | ⚡ Quick win

Pin the container image in production-facing examples.

The Provider Details and podman examples prescribe quay.io/evalhub/community-inspect:latest, while the build instructions publish versioned images. A moving tag can silently change the adapter and prevents reproducible rollback. Use a release tag or digest for deployment examples, reserving latest for explicitly local/development usage.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/content/docs/adapters/inspect/index.mdx` around lines 172 - 185, Update
the inspect adapter’s Provider Details and Container Image examples to reference
a versioned release tag or immutable digest instead of
quay.io/evalhub/community-inspect:latest. Keep latest only where explicitly
identified for local or development usage, and align the deployment examples
with the versioned images produced by the build instructions.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/content/docs/adapters/inspect/benchmarks.md`:
- Line 18: Correct the benchmark-count statement in the documentation to match
the catalog: either add the five missing Petri category IDs so there are 40
named categories, or revise the wording to reflect 35 named category audits plus
inspect/petri-full, totaling 36 Petri benchmarks.

In `@src/content/docs/adapters/inspect/configuration.md`:
- Line 187: Update the realism_filter entry in the configuration table to
declare the accepted type as boolean | number and explain how a numeric value
acts as the realism-score threshold, preserving its experimental status and
default.
- Line 67: Clarify the guidance around the api_key and target_api_key parameter
documentation: state that plaintext API-key parameters are only for local or
development use and must not be included in persisted Kubernetes/API job
submissions. Recommend model.auth.secret_ref or environment-based credentials
for submitted jobs, while preserving the existing Secret reference instructions.
- Around line 114-115: Resolve the contradiction between the Bloom scenarios
note and the scenarios_base_url/scenarios_api_key documentation: verify the
adapter behavior and update the notes and parameter descriptions consistently.
If these parameters are mapped to global OPENAI_BASE_URL and OPENAI_API_KEY
before bloom scenarios runs, state that explicitly; otherwise remove or clarify
the per-role override claims so the documentation matches actual behavior in
both affected sections.

In `@src/content/docs/adapters/inspect/examples.mdx`:
- Around line 359-363: Update the inspect-petri-sycophancy-001 example command
to remove the --model-auth-secret maas-creds argument when targeting the
unauthenticated vLLM endpoint at http://vllm:8080/v1; keep the existing endpoint
and other arguments unchanged.
- Around line 150-152: Remove role API keys from both example JobSpecs: at
src/content/docs/adapters/inspect/examples.mdx lines 150-152, replace
auditor_api_key with the supported secret or environment-based configuration;
make the equivalent replacement for judge_anthropic_api_key at lines 221-224.
Keep the examples consistent with the credential guidance near lines 14-15.

---

Nitpick comments:
In `@src/content/docs/adapters/inspect/index.mdx`:
- Around line 172-185: Update the inspect adapter’s Provider Details and
Container Image examples to reference a versioned release tag or immutable
digest instead of quay.io/evalhub/community-inspect:latest. Keep latest only
where explicitly identified for local or development usage, and align the
deployment examples with the versioned images produced by the build
instructions.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 7408d44e-a3bf-4249-829c-d5e200c63465

📥 Commits

Reviewing files that changed from the base of the PR and between 0fb49b1 and f1887e4.

📒 Files selected for processing (5)
  • astro.config.mjs
  • src/content/docs/adapters/inspect/benchmarks.md
  • src/content/docs/adapters/inspect/configuration.md
  • src/content/docs/adapters/inspect/examples.mdx
  • src/content/docs/adapters/inspect/index.mdx

Comment thread src/content/docs/adapters/inspect/benchmarks.md Outdated
Comment thread src/content/docs/adapters/inspect/configuration.md Outdated
Comment thread src/content/docs/adapters/inspect/configuration.md Outdated
Comment thread src/content/docs/adapters/inspect/configuration.md Outdated
Comment thread src/content/docs/adapters/inspect/examples.mdx Outdated
Comment thread src/content/docs/adapters/inspect/examples.mdx Outdated

@julpayne julpayne left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@julpayne
julpayne merged commit fba6eef into eval-hub:main Jul 28, 2026
2 of 4 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in EvalHub Planning Jul 28, 2026
@ruivieira
ruivieira deleted the feat/aisi-docs branch July 28, 2026 13:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants