学習と評価
学習は数回の binding 呼び出しで復習履歴を処理します。入力は復習ログ CSV、出力は DefaultScheduler やカスタムの defineScheduler に渡せる重みの配列です。
例は @open-spaced-repetition/binding を import します。Node ではネイティブの napi モジュール、ブラウザでは WASI Preview 1 の wasm ビルドに解決されます(スレッドの説明はOptimizer 概要を参照)。
復習ログをアイテムに変換する
convertCsvToFsrsItems は CSV テキストを読み、カードごとに行をまとめて FSRSItem にします。列は次のとおりです。
nextDayStartsAt(翌日が始まる時刻)と、IANA タイムゾーン('UTC' など)か固定の UTC オフセット(分)を渡します。Uint8Array 入力の場合は同期でアイテムを返します。
既存の変換関数は引き続き配列を返します。CSV の任意のカード識別子を一度だけ数値化するには、convertCsvToFsrsItemsWithCardIds を使います。戻り値は { items, cardIds }(ストリーム入力では Promise)です。数値 ID は今回の変換で残ったカードごとに割り当てられ、ソート後の items と添字で対応します。元の識別子ではありません。同じ IDs を学習と直接評価に再利用し、別々の変換結果の IDs を混在させないでください。
computeParameters と evaluateWithTimeSeriesSplits は任意の options.cardIds を受け取ります。
CSV 変換・学習・評価・スケジューリングでは同じ modelVersion(既定は 'FSRS-7'、または 'FSRS-6')を使います。convertCsvToFsrsItems の第 4 引数と学習・評価のオプションに渡し、DefaultScheduler({ version: modelVersion, weights }) で利用します。FSRS-7 は 34 個の重みを返し、現地の学習日の実際の長さで正規化した小数・同日間隔を保持します。FSRS-6 は 21 個の重みと整数の学習日を使います。同日の追加復習も FSRS-7 の学習に利用できます。
重みを学習する
computeParameters(items, options) は学習済みの重みを含む Promise<number[]> を返します。enableShortTerm は必須です。numRelearningSteps と trainingConfig は省略でき、progress は学習中に (current, total) を報告します。
computeParameters と evaluateWithTimeSeriesSplits は、どのビルドでも Promise を返します。ネイティブ binding はバックグラウンドタスクで実行します。WASI Preview 1 の両ターゲット(wasm32-wasip1 と wasm32-wasip1-threads)は呼び出し元のスレッドで同期的に計算し、その結果を Promise にラップします。ブラウザでは専用 Worker から呼び出してページの応答性を保ってください。Worker は進捗コールバックから postMessage でページに進捗を送信できます。
WASI p1 の両ターゲットでは、progress(current, total) は学習の各 batch が完了した直後に同期的に呼び出されます。evaluateWithTimeSeriesSplits では各 split の完了後に呼び出されます。false を返すと処理が停止し、Promise が reject されます。コールバックが例外を投げた場合も Promise は reject されます。データ不足などで batch 学習を省略する場合、学習の進捗コールバックは発生しません。timeout はネイティブ版の進捗ポーリング間隔(ミリ秒)であり、学習の制限時間ではありません。WASI p1 では無視されます。
enableSchedPenalties は任意で、既定値は false です。true にすると、FSRS-7 の間隔の成長と短い間隔へのペナルティを学習損失に追加します。evaluateWithTimeSeriesSplits 内部の学習にも適用されますが、FSRS-6 では無視され、スケジューリングの数式は変わりません。
trainingConfig(epochs、batch size、seed、最大系列長、学習率、L2 重み)は省略可能で、省略時は binding の既定値を使います。ブラウザの WASI では、専用 Worker 内で computeParameters を呼び出してください。Playgroundページのトレーナーは同じ経路を Web Worker で実行し、進捗をライブで報告します。返された weights 配列を DefaultScheduler({ version: modelVersion, weights }) や defineScheduler の設定に渡し、モデルの既定値を置き換えます。
適合度を評価する
evaluateWithTimeSeriesSplits(items, options) は復習履歴を時刻で分割し、Promise<ModelEvaluation> を返します。その結果には logLoss と rmseBins が含まれます。学習済みの重みが保留した復習をどれだけ予測するかを判断できます。computeOptimalSteps はさらに進み、復習と目標保持率から学習・再学習ステップの推奨時間を返します。
インストールコマンドと二つの実行環境はOptimizer 概要を参照してください。