ai-toolkit/ui/src/extensions/README.md

Extension UI modules

A model package registers its python classes in AI_TOOLKIT_MODELS (extensions/<pkg>/__init__.py). To show those archs in the web UI (training form and Generate page) add a ui.tsx next to it exporting the UI entries:

// extensions/<pkg>/ui.tsx
import type { ModelArch } from '@/app/jobs/new/options';

export const AI_TOOLKIT_UI_MODELS: ModelArch[] = [
  {
    name: 'my_arch', // must equal the python class's `arch`
    label: 'My Model',
    group: 'image',
    defaults: {
      'config.process[0].model.name_or_path': ['org/my-model', ''],
      'config.process[0].model.quantize': [true, false],
    },
  },
];

• The file is read and transpiled by the UI server on every page load (/api/model_archs), so adding or editing one needs no rebuild. .ts, .jsx and .js also work.
• The ModelArch shape is in ui/src/app/jobs/new/options.tsx; the built-in tables in extensions_built_in/*/ui.tsx are the reference examples.
• Code runs in the browser. Only these imports are available: react, next/link, @/helpers/defaultSamples, @/components/formInputs, plus @/app/jobs/new/options, and type-only imports from @/types.
• Entries are merged by name; extensions/ loads after extensions_built_in/, so an extension can override a built-in entry.
• A module that fails to compile or evaluate is skipped and logged in the browser console; the others still load.
• Type check: cd ui && npm run check_extensions (uses the repo root tsconfig.json, which editors also pick up for these files).