Skip to content

Commit

Permalink
docs and changelog for release
Browse files Browse the repository at this point in the history
  • Loading branch information
aisi-inspect committed Nov 12, 2024
1 parent e7aebfa commit c70f539
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Changelog

## Unreleased
## v0.3.46 (12 November 2024)

- [eval](https://inspect.ai-safety-institute.org.uk/eval-logs.html#sec-log-format) is now the default log format (use `--log-format=json` to use old format).
- Base 64 images are now logged by default for all log formats (disable with `--no-log-images`).
Expand Down
6 changes: 2 additions & 4 deletions docs/eval-logs.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Both formats are fully supported by the [Log File API](#sec-log-file-api) and [L

### Format Option

The PyPI version of Inspect currently defaults to using the `.json` format, whereas the development version on GitHub currently defaults to `.eval` because of its size and speed advantages. You can explicitly control the log format globally in your `.env` file:
Beginning with Inspect v0.3.46, `.eval` is the default log file format. You can explicitly control the global log format default in your `.env` file:

``` {.bash filename=".env"}
INSPECT_LOG_FORMAT=eval
Expand All @@ -90,9 +90,7 @@ If you do need to interact with the underlying JSON (e.g., when reading logs fro

## Image Logging

When running the development version of Insepct from GitHub, full base64 encoded copies of images are included in the log file by default (the PyPI version currently still defaults to not logging images for the `.json` format).

Image logging will not create performance problems when using `.eval` logs, however if you are using `.json` logs then large numbers of images could become unweildy (i.e. if your `.json` log file grows to 100mb or larger as a result).
By default, full base64 encoded copies of images are included in the log file. Image logging will not create performance problems when using `.eval` logs, however if you are using `.json` logs then large numbers of images could become unweildy (i.e. if your `.json` log file grows to 100mb or larger as a result).

You can disable this using the `--no-log-images` flag. For example, here we enable the `.json` log format and disable image logging:

Expand Down

0 comments on commit c70f539

Please sign in to comment.