Skip to content

Commit

Permalink
Built site for gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
jjallaire committed Sep 2, 2024
1 parent f7f3326 commit a825343
Show file tree
Hide file tree
Showing 27 changed files with 2,874 additions and 1,664 deletions.
2 changes: 1 addition & 1 deletion .nojekyll
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1d00dfb7
80ceac5c
1,119 changes: 1,119 additions & 0 deletions agent-api.html

Large diffs are not rendered by default.

18 changes: 9 additions & 9 deletions agents-api.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.5.32">
<meta name="generator" content="quarto-1.5.54">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">


<title>Inspect – Agents API</title>
<title>Agents API – Inspect</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
Expand Down Expand Up @@ -127,7 +127,7 @@
<button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" role="button" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
<i class="bi bi-layout-text-sidebar-reverse"></i>
</button>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="./errors-and-limits.html">Advanced</a></li><li class="breadcrumb-item"><a href="./agents-api.html"><span class="chapter-title">Agents API</span></a></li></ol></nav>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="./eval-sets.html">Advanced</a></li><li class="breadcrumb-item"><a href="./agents-api.html"><span class="chapter-title">Agents API</span></a></li></ol></nav>
<a class="flex-grow-1" role="navigation" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
</a>
<button type="button" class="btn quarto-search-button" aria-label="Search" onclick="window.quartoOpenSearch();">
Expand Down Expand Up @@ -245,6 +245,11 @@
<ul id="quarto-sidebar-section-3" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./eval-sets.html" class="sidebar-item-text sidebar-link"><span class="chapter-title">Eval Sets</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./errors-and-limits.html" class="sidebar-item-text sidebar-link"><span class="chapter-title">Errors &amp; Limits</span></a>
</div>
</li>
Expand Down Expand Up @@ -272,11 +277,6 @@
<div class="sidebar-item-container">
<a href="./eval-logs.html" class="sidebar-item-text sidebar-link"><span class="chapter-title">Eval Logs</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./eval-suites.html" class="sidebar-item-text sidebar-link"><span class="chapter-title">Eval Suites</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down Expand Up @@ -319,7 +319,7 @@ <h2 id="toc-title">Table of contents</h2>
<!-- main -->
<main class="content" id="quarto-document-content">

<header id="title-block-header" class="quarto-title-block default"><nav class="quarto-page-breadcrumbs quarto-title-breadcrumbs d-none d-lg-block" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="./errors-and-limits.html">Advanced</a></li><li class="breadcrumb-item"><a href="./agents-api.html"><span class="chapter-title">Agents API</span></a></li></ol></nav>
<header id="title-block-header" class="quarto-title-block default"><nav class="quarto-page-breadcrumbs quarto-title-breadcrumbs d-none d-lg-block" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="./eval-sets.html">Advanced</a></li><li class="breadcrumb-item"><a href="./agents-api.html"><span class="chapter-title">Agents API</span></a></li></ol></nav>
<div class="quarto-title">
<h1 class="title"><span id="sec-agents-api" class="quarto-section-identifier"><span class="chapter-title">Agents API</span></span></h1>
</div>
Expand Down
20 changes: 10 additions & 10 deletions agents.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.5.32">
<meta name="generator" content="quarto-1.5.54">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">


<title>InspectAgents</title>
<title>AgentsInspect</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
Expand Down Expand Up @@ -245,6 +245,11 @@
<ul id="quarto-sidebar-section-3" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./eval-sets.html" class="sidebar-item-text sidebar-link"><span class="chapter-title">Eval Sets</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./errors-and-limits.html" class="sidebar-item-text sidebar-link"><span class="chapter-title">Errors &amp; Limits</span></a>
</div>
</li>
Expand Down Expand Up @@ -272,11 +277,6 @@
<div class="sidebar-item-container">
<a href="./eval-logs.html" class="sidebar-item-text sidebar-link"><span class="chapter-title">Eval Logs</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./eval-suites.html" class="sidebar-item-text sidebar-link"><span class="chapter-title">Eval Suites</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down Expand Up @@ -445,7 +445,7 @@ <h2 class="anchored" data-anchor-id="sec-custom-scaffolding">Custom Scaffolding<
<section id="sec-tool-calls" class="level3">
<h3 class="anchored" data-anchor-id="sec-tool-calls">Tool Calls</h3>
<p>When you call the <code>generate()</code> function from a solver, use the <code>tool_calls</code> parameter to customise how tool calls made by the model are handled:</p>
<table class="table">
<table class="caption-top table">
<colgroup>
<col style="width: 20%">
<col style="width: 80%">
Expand Down Expand Up @@ -788,7 +788,7 @@ <h3 class="anchored" data-anchor-id="environment-interface">Environment Interfac
<section id="environment-binding" class="level3">
<h3 class="anchored" data-anchor-id="environment-binding">Environment Binding</h3>
<p>There are two sandbox environments built in to Inspect:</p>
<table class="table">
<table class="caption-top table">
<thead>
<tr class="header">
<th>Environment Type</th>
Expand Down Expand Up @@ -858,7 +858,7 @@ <h3 class="anchored" data-anchor-id="sec-docker-configuration">Docker Configurat
<p>Before using Docker sandbox environments, please be sure to install <a href="https://docs.docker.com/engine/install/">Docker Engine</a> (version 24.0.7 or greater).</p>
<p>You can use the Docker sandbox enviornment without any special configuration, however most commonly you’ll provide explicit configuration via either a <code>Dockerfile</code> or a <a href="https://docs.docker.com/compose/compose-file/">Docker Compose</a> configuration file (<code>compose.yaml</code>).</p>
<p>Here is how Docker sandbox environments are created based on the presence of <code>Dockerfile</code> and/or <code>compose.yml</code> in the task directory:</p>
<table class="table">
<table class="caption-top table">
<thead>
<tr class="header">
<th>Config Files</th>
Expand Down
20 changes: 10 additions & 10 deletions caching.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.5.32">
<meta name="generator" content="quarto-1.5.54">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">


<title>InspectCaching</title>
<title>CachingInspect</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
Expand Down Expand Up @@ -127,7 +127,7 @@
<button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" role="button" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
<i class="bi bi-layout-text-sidebar-reverse"></i>
</button>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="./errors-and-limits.html">Advanced</a></li><li class="breadcrumb-item"><a href="./caching.html"><span class="chapter-title">Caching</span></a></li></ol></nav>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="./eval-sets.html">Advanced</a></li><li class="breadcrumb-item"><a href="./caching.html"><span class="chapter-title">Caching</span></a></li></ol></nav>
<a class="flex-grow-1" role="navigation" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
</a>
<button type="button" class="btn quarto-search-button" aria-label="Search" onclick="window.quartoOpenSearch();">
Expand Down Expand Up @@ -245,6 +245,11 @@
<ul id="quarto-sidebar-section-3" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./eval-sets.html" class="sidebar-item-text sidebar-link"><span class="chapter-title">Eval Sets</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./errors-and-limits.html" class="sidebar-item-text sidebar-link"><span class="chapter-title">Errors &amp; Limits</span></a>
</div>
</li>
Expand Down Expand Up @@ -272,11 +277,6 @@
<div class="sidebar-item-container">
<a href="./eval-logs.html" class="sidebar-item-text sidebar-link"><span class="chapter-title">Eval Logs</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./eval-suites.html" class="sidebar-item-text sidebar-link"><span class="chapter-title">Eval Suites</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down Expand Up @@ -316,7 +316,7 @@ <h2 id="toc-title">Table of contents</h2>
<!-- main -->
<main class="content" id="quarto-document-content">

<header id="title-block-header" class="quarto-title-block default"><nav class="quarto-page-breadcrumbs quarto-title-breadcrumbs d-none d-lg-block" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="./errors-and-limits.html">Advanced</a></li><li class="breadcrumb-item"><a href="./caching.html"><span class="chapter-title">Caching</span></a></li></ol></nav>
<header id="title-block-header" class="quarto-title-block default"><nav class="quarto-page-breadcrumbs quarto-title-breadcrumbs d-none d-lg-block" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="./eval-sets.html">Advanced</a></li><li class="breadcrumb-item"><a href="./caching.html"><span class="chapter-title">Caching</span></a></li></ol></nav>
<div class="quarto-title">
<h1 class="title"><span id="sec-caching" class="quarto-section-identifier"><span class="chapter-title">Caching</span></span></h1>
</div>
Expand Down Expand Up @@ -444,7 +444,7 @@ <h3 class="anchored" data-anchor-id="usage-reporting">Usage Reporting</h3>
<p>When using provider caching, model token usage will be reported with 4 distinct values rather than the normal input and output. For example:</p>
<div class="sourceCode" id="cb13"><pre class="sourceCode default code-with-copy"><code class="sourceCode default"><span id="cb13-1"><a href="#cb13-1" aria-hidden="true" tabindex="-1"></a>13,684 tokens [I: 22, CW: 1,711, CR: 11,442, O: 509]</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>Where the prefixes on reported token counts stand for:</p>
<table class="table">
<table class="caption-top table">
<tbody>
<tr class="odd">
<td><strong>I</strong></td>
Expand Down
20 changes: 10 additions & 10 deletions datasets.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.5.32">
<meta name="generator" content="quarto-1.5.54">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">


<title>InspectDatasets</title>
<title>DatasetsInspect</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
Expand Down Expand Up @@ -245,6 +245,11 @@
<ul id="quarto-sidebar-section-3" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./eval-sets.html" class="sidebar-item-text sidebar-link"><span class="chapter-title">Eval Sets</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./errors-and-limits.html" class="sidebar-item-text sidebar-link"><span class="chapter-title">Errors &amp; Limits</span></a>
</div>
</li>
Expand Down Expand Up @@ -272,11 +277,6 @@
<div class="sidebar-item-container">
<a href="./eval-logs.html" class="sidebar-item-text sidebar-link"><span class="chapter-title">Eval Logs</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./eval-suites.html" class="sidebar-item-text sidebar-link"><span class="chapter-title">Eval Suites</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down Expand Up @@ -342,7 +342,7 @@ <h2 class="anchored" data-anchor-id="overview">Overview</h2>
<h2 class="anchored" data-anchor-id="dataset-samples">Dataset Samples</h2>
<p>The core data type underlying the use of datasets with Inspect is the <code>Sample</code>, which consists of a required <code>input</code> field and several other optional fields:</p>
<p><strong>Class</strong> <code>inspect_ai.dataset.Sample</code></p>
<table class="table">
<table class="caption-top table">
<colgroup>
<col style="width: 20%">
<col style="width: 40%">
Expand Down Expand Up @@ -399,7 +399,7 @@ <h2 class="anchored" data-anchor-id="dataset-samples">Dataset Samples</h2>
</tbody>
</table>
<p>So a CSV dataset with the following structure:</p>
<table class="table">
<table class="caption-top table">
<colgroup>
<col style="width: 56%">
<col style="width: 43%">
Expand Down Expand Up @@ -507,7 +507,7 @@ <h2 class="anchored" data-anchor-id="amazon-s3">Amazon S3</h2>
<h2 class="anchored" data-anchor-id="chat-messages">Chat Messages</h2>
<p>The most important data structure within <code>Sample</code> is the <code>ChatMessage</code>. Note that often datasets will contain a simple string as their input (which is then internally converted to a <code>ChatMessageUser</code>). However, it is possible to include a full message history as the input via <code>ChatMessage</code>. Another useful application of <code>ChatMessage</code> is providing multi-modal input (e.g.&nbsp;images).</p>
<p><strong>Class</strong> <code>inspect_ai.model.ChatMessage</code></p>
<table class="table">
<table class="caption-top table">
<colgroup>
<col style="width: 10%">
<col style="width: 35%">
Expand Down
Loading

0 comments on commit a825343

Please sign in to comment.