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

Documentation Index

Fetch the complete documentation index at: https://docs.arkor.ai/llms.txt

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

​
SDK 概要

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）。
コールバックランにフック: メトリックス転送、チェックポイント評価、通知。
inferonCheckpoint から学習中のモデルを呼ぶ。
トレーナー制御start、wait、cancel、abortSignal。CLI 外で使うとき。

​
リファレンス

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