> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-workspaces-notebooks.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# EvaluationLogger

> TypeScript SDK リファレンス

export const GitHubLink = ({url, compact = false}) => <a href={url} target="_blank" rel="noopener noreferrer" className={compact ? "source-link" : "github-source-link"}>
    {compact ? "ソースを表示" : <>
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    GitHub のソース
      </>}
  </a>;

<GitHubLink url="https://github.com/wandb/weave/blob/7c9efdc9fe05ffcaf2430dd652ef9bc5b3ffdfaa/sdks/node/src/evaluationLogger.ts#L556" />

EvaluationLogger を使うと、予測とスコアを段階的にログできます。

事前にデータセットを用意してバッチ処理を行う必要がある従来の Evaluation クラスとは異なり、
EvaluationLogger では、予測が発生したタイミングで、柔軟にスコアリングしながらログできます。

<div id="example">
  ## 例
</div>

```ts twoslash theme={null}
// @noErrors
const ev = new EvaluationLogger({name: 'my-eval', dataset: 'my-dataset'});

for (const example of streamingData) {
  const output = await myModel.predict(example);
  const pred = ev.logPrediction(example, output);

  if (shouldScore(output)) {
    pred.logScore("accuracy", calculateAccuracy(output));
  }
  pred.finish();
}

await ev.logSummary();
```

<div id="constructor">
  ## コンストラクター
</div>

> **new EvaluationLogger**(`options`): `EvaluationLogger`

<div id="parameters">
  ### パラメーター
</div>

<ParamField path="options" type="object" required>
  <Expandable title="properties" defaultOpen>
    <ParamField path="attributes" type="Record<string, any>" />

    <ParamField path="dataset" type="string | Dataset<DatasetRow>">
      [`Dataset`](./dataset) を参照してください。
    </ParamField>

    <ParamField path="description" type="string" />

    <ParamField path="model" type="WeaveObject | { name?: string; }">
      [`WeaveObject`](./weaveobject) を参照してください。
    </ParamField>

    <ParamField path="name" type="string" required />

    <ParamField path="scorers" type="string[]" />
  </Expandable>
</ParamField>

<div id="returns">
  ### 戻り値
</div>

`EvaluationLogger`

<div id="methods">
  ## メソッド
</div>

<div id="logprediction">
  ### logPrediction()
</div>

> **logPrediction**(`inputs`, `output`): [`ScoreLogger`](./scorelogger)

入力と出力を含む予測をログする (同期バージョン) 。
predict\_and\_score call (子 predict call を含む) を作成します。
スコアを追加するための ScoreLogger をすぐに返します。

この method は ScoreLogger を同期的に返します。初期化が完了すると、
ScoreLogger に対する操作 (`logScore`、`finish`) はキューに追加され、実行されます。

<div id="parameters-2">
  #### パラメーター
</div>

<ParamField path="inputs" type="Record<string, any>" required />

<ParamField path="output" type="any" required />

<div id="returns-2">
  #### 戻り値
</div>

[`ScoreLogger`](./scorelogger)

<div id="example-2">
  #### 例
</div>

```ts twoslash theme={null}
// @noErrors
// ファイア・アンド・フォーゲット方式
const scoreLogger = evalLogger.logPrediction({input: 'test'}, 'output');
scoreLogger.logScore('accuracy', 0.95);
scoreLogger.finish();
await evalLogger.logSummary(); // すべての処理が完了するまで待機
```

***

<div id="logpredictionasync">
  ### logPredictionAsync()
</div>

> **logPredictionAsync**(`inputs`, `output`): `Promise`\<[`ScoreLogger`](./scorelogger)>

入力と出力とともに予測をログする (非同期版) 。
logPrediction() と同様ですが、
予測 call が完全に初期化された時点で解決する Promise を返します。

続行する前に初期化の完了を await する必要がある場合は、これを使用します。

<div id="parameters-3">
  #### パラメーター
</div>

<ParamField path="inputs" type="Record<string, any>" required />

<ParamField path="output" type="any" required />

<div id="returns-3">
  #### 戻り値
</div>

`Promise`\<[`ScoreLogger`](./scorelogger)>

<div id="example-3">
  #### 例
</div>

```ts twoslash theme={null}
// @noErrors
// Await可能なスタイル
const scoreLogger = await evalLogger.logPredictionAsync({input: 'test'}, 'output');
await scoreLogger.logScore('accuracy', 0.95);
await scoreLogger.finish();
```

***

<div id="logsummary">
  ### logSummary()
</div>

> **logSummary**(`summary?`): `Promise`\<`void`>

サマリーをログし、評価を完了します。
summarize call を作成し、evaluate call を完了します。

この method は await なしでも呼び出せます (ファイア・アンド・フォーゲット) が、内部的には
保留中のすべての 操作 が完了するまで待機します。

<div id="parameters-4">
  #### パラメーター
</div>

<ParamField path="summary" type="Record<string, any>" />

<div id="returns-4">
  #### 戻り値
</div>

`Promise`\<`void`>