Evaluation

weave • ドキュメント

---

weave / 評価

​

Class: Evaluation<R, E, M>

スコアラーとデータセットを含む評価を設定します。

evaluation.evaluate(model)を呼び出すと、データセットの行がモデルに渡され、データセットの列の名前とmodel.predictの引数名が一致します。

その後、すべてのスコアラーを呼び出し、結果をweaveに保存します。

​

例

// Collect your examples into a dataset
const dataset = new weave.Dataset({
  id: 'my-dataset',
  rows: [
    { question: 'What is the capital of France?', expected: 'Paris' },
    { question: 'Who wrote "To Kill a Mockingbird"?', expected: 'Harper Lee' },
    { question: 'What is the square root of 64?', expected: '8' },
  ],
});

// Define any custom scoring function
const scoringFunction = weave.op(function isEqual({ modelOutput, datasetRow }) {
  return modelOutput == datasetRow.expected;
});

// Define the function to evaluate
const model = weave.op(async function alwaysParisModel({ question }) {
  return 'Paris';
});

// Start evaluating
const evaluation = new weave.Evaluation({
  id: 'my-evaluation',
  dataset: dataset,
  scorers: [scoringFunction],
});

const results = await evaluation.evaluate({ model });

​

継承元

• WeaveObject

​

型パラメータ

• R extends DatasetRow

• E extends DatasetRow

• M

​

コンストラクタ

​

new Evaluation()

new Evaluation<R, E, M>(parameters): Evaluation<R, E, M>

​

パラメータ

• parameters: EvaluationParameters<R, E, M>

​

戻り値

Evaluation<R, E, M>

​

オーバーライド

WeaveObject.constructor

​

定義場所

evaluation.ts:148

​

プロパティ

​

__savedRef?

optional __savedRef: ObjectRef | Promise<ObjectRef>

​

継承元

WeaveObject.__savedRef

​

定義場所

weaveObject.ts:49

---

​

_baseParameters

protected _baseParameters: WeaveObjectParameters

​

継承元

WeaveObject._baseParameters

​

定義場所

weaveObject.ts:51

​

アクセサ

​

description

get description(): undefined | string

​

戻り値

undefined | string

​

継承元

WeaveObject.description

​

定義場所

weaveObject.ts:89

---

​

id

get id(): string

​

戻り値

string

​

継承元

WeaveObject.id

​

定義場所

weaveObject.ts:85

​

メソッド

​

className()

className(): any

​

戻り値

any

​

継承元

WeaveObject.className

​

定義場所

weaveObject.ts:53

---

​

evaluate()

evaluate(__namedParameters): Promise<Record<string, any>>

​

パラメータ

• __namedParameters

• __namedParameters.maxConcurrency?: number = 5

• __namedParameters.model: WeaveCallable<(…args) => Promise<M>>

• __namedParameters.nTrials?: number = 1

​

戻り値

Promise<Record<string, any>>

​

定義場所

evaluation.ts:163

---

​

predictAndScore()

predictAndScore(__namedParameters): Promise<object>

​

パラメータ

• __namedParameters

• __namedParameters.columnMapping?: ColumnMapping<R, E>

• __namedParameters.example: R

• __namedParameters.model: WeaveCallable<(…args) => Promise<M>>

​

戻り値

Promise<object>

model_latency

model_latency: number = modelLatency

model_output

model_output: any = modelOutput

model_success

model_success: boolean = !modelError

scores

scores: object

インデックスシグネチャ

[key: string]: any

​

定義場所

evaluation.ts:232

---

​

saveAttrs()

saveAttrs(): object

​

戻り値

object

​

継承元

WeaveObject.saveAttrs

​

定義場所

weaveObject.ts:57