メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://arkor-92aeef0e-eng-736.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

このセクションは SDK リファレンスCLI リファレンス に飛び込む前に必要なメンタルモデルを得るためのものです。順番に読み進めてください。各項目は前の項目を踏まえて書かれています。

読む順番

  • プロジェクト構成。Arkor がコードを置くべきと考える場所(src/arkor/index.tssrc/arkor/trainer.ts)、.arkor/~/.arkor/ の役割、arkor.config.ts が現状できること(できないこと)。
  • トレーナーcreateTrainer の形: 必須フィールド、データセットソース、LoRA 設定、Trainer.start / wait / cancel のライフサイクル。
  • ライフサイクルコールバック。5 つのコールバック(onStartedonLogonCheckpointonCompletedonFailed)、それぞれの引数の形、発火するタイミング。TypeScript でファインチューニングする意義の多くはここにあります。
  • Studio。ローカル Web UI が何のためにあり、なぜループバックで動き、開発ループにどう組み込まれるのか。

1 段落で言うと

src/arkor/trainer.ts の中で createTrainer({ name, model, dataset, ... }) を使って Trainer を定義し、src/arkor/index.tscreateArkor({ trainer }) で登録します。arkor dev でブラウザーにローカル Studio が開き、Studio の Run training をクリックすると arkor start がサブプロセスとして起動し、trainer.start()trainer.wait() が呼び出されます。wait() の実行中は SSE イベントストリームからコールバックがディスパッチされ、Arkor のマネージド GPU から学習の進捗がストリーミングされて、同じ内容が Studio にも反映されます。