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
2 changes: 2 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ The package is small and self-documenting, so there's no separate `src/` guide.
`uv run pytest --cov`.
- **Gates (all required, blocking PR checks):** `ruff check .`,
`ruff format --check .`, `mypy` (strict), `pytest --cov` at **100% coverage**.
- Every public module, class, and function needs a docstring, enforced by `ruff` D1;
state the contract, don't restate the name.

## Publishing model checkpoints to HuggingFace (any agent session)

Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ If you know [Inspect Evals](https://inspect.aisi.org.uk/evals/), this is that fo
[![CI](https://github.com/robocurve/worldevals/actions/workflows/ci.yml/badge.svg)](https://github.com/robocurve/worldevals/actions/workflows/ci.yml)
[![License: MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE)
[![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)](https://github.com/robocurve/worldevals/actions/workflows/ci.yml)
[![Docs coverage](https://img.shields.io/badge/public%20docstrings-100%25-brightgreen)](https://github.com/robocurve/worldevals/actions/workflows/ci.yml)
[![Built on Inspect Robots](https://img.shields.io/badge/built%20on-Inspect%20Robots-indigo)](https://github.com/robocurve/inspect-robots)

**[Browse the catalog → worldevals.org](https://worldevals.org/)**
Expand Down Expand Up @@ -104,6 +105,9 @@ Published checkpoints are catalogued in [WorldPolicies](https://github.com/roboc
> forget. Day-to-day conventions (PR-only `main`, the required `ci-ok` check,
> one-click releases) are documented in [`CLAUDE.md`](CLAUDE.md).

Every public module, class, and function needs a docstring, enforced by `ruff` D1;
state the contract, don't restate the name.

```bash
uv venv && uv pip install -e ".[dev]" # inspect_robots resolved from the v0.3.0 tag
uv run pre-commit install
Expand Down
3 changes: 3 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,7 @@ name, well-formed `https://github.com/...` repo URL, ≥1 task key), and CI requ
100% coverage. Keep `task_keys` in sync with the benchmark's actual registered
task names.

Every public module, class, and function needs a docstring, enforced by `ruff` D1;
state the contract, don't restate the name.

See the [API reference](api.md) for the `Benchmark` fields.
7 changes: 6 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,12 @@ target-version = "py310"
src = ["src", "tests"]

[tool.ruff.lint]
select = ["E", "F", "W", "I", "UP", "B", "C4", "SIM", "RUF"]
select = ["E", "F", "W", "I", "UP", "B", "C4", "SIM", "RUF", "D1"]
ignore = ["D105", "D107"]

[tool.ruff.lint.per-file-ignores]
"scripts/**" = ["D1"]
"tests/**" = ["D1"]

[tool.ruff.lint.isort]
known-first-party = ["worldevals"]
Expand Down
2 changes: 2 additions & 0 deletions src/worldevals/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@


def build_parser() -> argparse.ArgumentParser:
"""Create the argument parser for the catalog browsing commands."""
parser = argparse.ArgumentParser(
prog="worldevals",
description="WorldEvals — the Inspect Evals for robotics (a benchmark catalog).",
Expand Down Expand Up @@ -67,6 +68,7 @@ def _cmd_tasks() -> int:


def main(argv: Sequence[str] | None = None) -> int:
"""Run the catalog CLI and return its process exit status."""
parser = build_parser()
args = parser.parse_args(argv)
if args.command == "list":
Expand Down
Loading