Skip to content

Commit

Permalink
update docs for release
Browse files Browse the repository at this point in the history
  • Loading branch information
jjallaire committed Feb 14, 2025
1 parent a361670 commit 2db5952
Show file tree
Hide file tree
Showing 14 changed files with 54 additions and 37 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

## Unreleased
## v0.3.64 (14 February 2025)

- [Reference documentation](https://inspect.ai-safety-institute.org.uk/reference/) for Python API and CLI commands.
- Add support for [clustered standard errors](https://inspect.ai-safety-institute.org.uk/scorers.html#clustered-standard-errors) via a new `cluster` parameter for the `stderr()` metric.
Expand Down
10 changes: 5 additions & 5 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
cff-version: 1.2.0
title: 'Inspect AI: Framework for Large Language Model Evaluations'
title: "Inspect AI: Framework for Large Language Model Evaluations"
message: >-
If you cite this software, please do so using the
metadata from this file.
type: software
authors:
- name: UK AI Safety Institute
website: 'https://www.aisi.gov.uk/'
repository-code: 'https://github.com/UKGovernmentBEIS/inspect_ai'
url: 'https://inspect.ai-safety-institute.org.uk/'
- name: UK AI Security Institute
website: "https://www.aisi.gov.uk/"
repository-code: "https://github.com/UKGovernmentBEIS/inspect_ai"
url: "https://inspect.ai-safety-institute.org.uk/"
license: MIT
date-released: "2024-05-10"
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2024 UK AI Safety Institute
Copyright (c) 2024 UK AI Security Institute

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[<img width="295" src="https://inspect.ai-safety-institute.org.uk/images/aisi-logo.png" />](https://aisi.gov.uk/)
[<img width="295" src="https://inspect.ai-safety-institute.org.uk/images/aisi-logo.svg" />](https://aisi.gov.uk/)

Welcome to Inspect, a framework for large language model evaluations created by the [UK AI Safety Institute](https://aisi.gov.uk/).
Welcome to Inspect, a framework for large language model evaluations created by the [UK AI Security Institute](https://aisi.gov.uk/).

Inspect provides many built-in components, including facilities for prompt engineering, tool usage, multi-turn dialog, and model graded evaluations. Extensions to Inspect (e.g. to support new elicitation and scoring techniques) can be provided by other Python packages.

Expand Down
8 changes: 4 additions & 4 deletions docs/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ website:
title: "Inspect AI"
background: light
search: true
logo: images/aisi-logo.png
logo: images/aisi-logo.svg
logo-href: https://www.aisi.gov.uk/
left:
- text: "User Guide"
Expand Down Expand Up @@ -102,7 +102,7 @@ website:

page-footer:
left:
- text: UK AI Safety Institute
- text: UK AI Security Institute
href: https://aisi.gov.uk/
center:
- text: Code
Expand All @@ -116,8 +116,8 @@ website:

right:
- icon: twitter
href: https://twitter.com/AISafetyInst
aria-label: UK AI Safety Institute Twitter
href: https://x.com/sciTechgovuk
aria-label: UK AI Security Institute Twitter
- icon: github
href: https://github.com/UKGovernmentBEIS/inspect_ai/
aria-label: Inspect on GitHub
Expand Down
Binary file removed docs/images/aisi-logo.png
Binary file not shown.
33 changes: 33 additions & 0 deletions docs/images/aisi-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
title: Inspect
subtitle: An open-source framework for large language model evaluations
citation:
id: "UK_AI_Safety_Institute_Inspect_AI_Framework_2024"
id: "UK_AI_Security_Institute_Inspect_AI_Framework_2024"
title: "Inspect AI: Framework for Large Language Model Evaluations"
author: "UK AI Safety Institute"
author: "UK AI Security Institute"
issued: 2024-05
url: "https://github.com/UKGovernmentBEIS/inspect_ai"
type: "software"
---

## Welcome

Welcome to Inspect, a framework for large language model evaluations created by the [UK AI Safety Institute](https://aisi.gov.uk).
Welcome to Inspect, a framework for large language model evaluations created by the [UK AI Security Institute](https://aisi.gov.uk).

Inspect provides many built-in components, including facilities for prompt engineering, tool usage, multi-turn dialog, and model graded evaluations. Extensions to Inspect (e.g. to support new elicitation and scoring techniques) can be provided by other Python packages.

Expand Down
2 changes: 1 addition & 1 deletion docs/llms.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Inspect AI

> Inspect AI is a Python framework for large language model evaluations created by the [UK AI Safety Institute](https://aisi.gov.uk). Inspect provides many built-in components, including facilities for prompt engineering, tool usage, multi-turn dialog, and model graded evaluations. Extensions to Inspect (e.g. to support new elicitation and scoring techniques) can be provided by other Python packages.
> Inspect AI is a Python framework for large language model evaluations created by the [UK AI Security Institute](https://aisi.gov.uk). Inspect provides many built-in components, including facilities for prompt engineering, tool usage, multi-turn dialog, and model graded evaluations. Extensions to Inspect (e.g. to support new elicitation and scoring techniques) can be provided by other Python packages.

## Docs

Expand Down
16 changes: 0 additions & 16 deletions docs/scorers.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -535,14 +535,6 @@ Inspect includes some simple built in metrics for calculating accuracy, mean, et

#### Clustered Standard Errors

::: {.callout-note appearance="simple"}
The clustered standard errors feature described below is currently available only in the development version of Inspect. To install the development version from GitHub:

``` bash
pip install git+https://github.com/UKGovernmentBEIS/inspect_ai
```
:::

The `stderr()` metric supports computing [clustered standard errors](https://en.wikipedia.org/wiki/Clustered_standard_errors) via the `cluster` parameter. Most scorers already include `stderr()` as a built-in metric, so to compute clustered standard errors you'll want to specify custom `metrics` for your task (which will override the scorer's built in metrics).

For example, let's say you wanted to cluster on a "category" variable defined in `Sample` metadata:
Expand Down Expand Up @@ -662,14 +654,6 @@ def mean_score() -> ScoreReducer:

## Workflow {#sec-scorer-workflow}

::: {.callout-note appearance="simple"}
The `inspect score` command and `score()` function as described below are currently available only in the development version of Inspect. To install the development version from GitHub:

``` bash
pip install git+https://github.com/UKGovernmentBEIS/inspect_ai
```
:::

### Unscored Evals

By default, model output in evaluations is automatically scored. However, you can defer scoring by using the `--no-score` option. For example:
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ ignore = ["W002", "W009"]
[project]
name = "inspect_ai"
description = "Framework for large language model evaluations"
authors = [{ name = "UK AI Safety Institute" }]
authors = [{ name = "UK AI Security Institute" }]
readme = "README.md"
requires-python = ">=3.10"
license = { text = "MIT License" }
Expand Down
2 changes: 1 addition & 1 deletion src/inspect_ai/_util/constants.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from pathlib import Path
from typing import Literal

PKG_AUTHOR = "UK AI Safety Institute"
PKG_AUTHOR = "UK AI Security Institute"
PKG_AUTHOR_DIR = "UK-AISI"
PKG_NAME = Path(__file__).parent.parent.stem
PKG_PATH = Path(__file__).parent.parent
Expand Down
2 changes: 1 addition & 1 deletion tools/vscode/LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2024 UK AI Safety Institute
Copyright (c) 2024 UK AI Security Institute

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion tools/vscode/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"publisher": "ukaisi",
"icon": "assets/logo/inspect.png",
"author": {
"name": "UK AI Safety Institute"
"name": "UK AI Security Institute"
},
"version": "0.3.53",
"license": "MIT",
Expand Down

0 comments on commit 2db5952

Please sign in to comment.