SDK 概要

CLI と Studio が利用する TypeScript プリミティブ。

arkor パッケージは典型的なプロジェクトに必要な 3 つのプリミティブを提供します。トレーナーを定義し、プロジェクトマニフェストでラップして、CLI / Studio に認識させます。

// src/arkor/trainer.ts
import { createTrainer } from "arkor";

export const trainer = createTrainer({
  name: "support-bot-v1",
  model: "unsloth/gemma-4-E4B-it",
  dataset: { type: "huggingface", name: "arkorlab/triage-demo" },
  lora: { r: 16, alpha: 16 },
  maxSteps: 100,
});

// src/arkor/index.ts
import { createArkor } from "arkor";
import { trainer } from "./trainer";

export const arkor = createArkor({ trainer });

これが arkor dev と arkor start が発見する全体の形です。

このセクションにあるもの

トピック	何をするか
`createTrainer`	学習を定義: モデル、データセット、LoRA、ハイパーパラメーター。
`createArkor`	トレーナーを CLI が読むマニフェストにラップ。
`DatasetSource`	データの所在を伝える（HuggingFace 名 or blob URL）。
コールバック	学習にフック: メトリックス転送、チェックポイント評価、通知。
`infer`	`onCheckpoint` から学習中のモデルを呼ぶ。
トレーナー制御	`start`、`wait`、`cancel`、`abortSignal`。CLI 外で使うとき。
Deployments	学習済みアダプタやベースモデルを `CloudApiClient` 経由で `*.arkor.app` URL として公開。

リファレンス

完全な型シグネチャー、TrainerInput の全フィールド、補助ヘルパー（runTrainer、readCredentials など）、公開と内部のエクスポート契約は SDK リファレンスを参照してください。