Skip to content

A reactive notebook for Python — run reproducible experiments, query with SQL, execute as a script, deploy as an app, and version with git. Stored as pure Python. All in a modern, AI-native editor.

add custom model form (#6174)

Shahmir Varqha0c445e5c78e0
diff --git a/frontend/src/components/ai/ai-model-dropdown.tsx b/frontend/src/components/ai/ai-model-dropdown.tsx
index 7ac2051101..830eff09c1 100644
--- a/frontend/src/components/ai/ai-model-dropdown.tsx
+++ b/frontend/src/components/ai/ai-model-dropdown.tsx
@@ -77,7 +77,7 @@ export const AIModelDropdown = ({
].filter(Boolean),
displayedModels: ai?.models?.displayed_models,
});
- const modelsByProvider = aiModelRegistry.getGroupedModelsByProvider();
+ const modelsByProvider = aiModelRegistry.getListModelsByProvider();
const activeModel =
forRole === "autocomplete"
@@ -157,7 +157,7 @@ export const AIModelDropdown = ({
renderModelWithRole(AiModelId.parse(activeModel), forRole)}
{activeModel && forRole && <DropdownMenuSeparator />}
- {[...modelsByProvider.entries()].map(([provider, models]) => (
+ {modelsByProvider.map(([provider, models]) => (
<ProviderDropdownContent
key={provider}
provider={provider}
@@ -367,7 +367,7 @@ export const AiModelInfoDisplay = ({
);
};
-function getProviderLabel(provider: ProviderId): string {
+export function getProviderLabel(provider: ProviderId): string {
const providerInfo = AiModelRegistry.getProviderInfo(provider);
if (providerInfo) {
return providerInfo.name;
diff --git a/frontend/src/components/app-config/ai-config.tsx b/frontend/src/components/app-config/ai-config.tsx
index ab0e171b23..4e0cfdba0b 100644
--- a/frontend/src/components/app-config/ai-config.tsx
+++ b/frontend/src/components/app-config/ai-config.tsx
@@ -1,7 +1,14 @@
/* Copyright 2024 Marimo. All rights reserved. */
-import { BrainIcon, ChevronRightIcon, InfoIcon } from "lucide-react";
-import React, { useMemo } from "react";
+import {
+ BotIcon,
+ BrainIcon,
+ ChevronRightIcon,
+ InfoIcon,
+ PlusIcon,
+ Trash2Icon,
+} from "lucide-react";
+import React, { useId, useMemo, useState } from "react";
import {
Button as AriaButton,
Tree,
@@ -26,8 +33,10 @@ import { NativeSelect } from "@/components/ui/native-select";
import { Textarea } from "@/components/ui/textarea";
import {
AiModelId,
+ PROVIDERS,
type ProviderId,
type QualifiedModelId,
+ type ShortModelId,
} from "@/core/ai/ids/ids";
import { type AiModel, AiModelRegistry } from "@/core/ai/model-registry";
import { CopilotConfig } from "@/core/codemirror/copilot/copilot-config";
@@ -36,7 +45,7 @@ import { isWasm } from "@/core/wasm/utils";
import { cn } from "@/utils/cn";
import { Events } from "@/utils/events";
import { Strings } from "@/utils/strings";
-import { AIModelDropdown } from "../ai/ai-model-dropdown";
+import { AIModelDropdown, getProviderLabel } from "../ai/ai-model-dropdown";
import {
AiProviderIcon,
type AiProviderIconProps,
@@ -48,9 +57,18 @@ import {
AccordionItem,
AccordionTrigger,
} from "../ui/accordion";
+import { Button } from "../ui/button";
import { Checkbox } from "../ui/checkbox";
import { DropdownMenuSeparator } from "../ui/dropdown-menu";
+import { Label } from "../ui/label";
import { ExternalLink } from "../ui/links";
+import {
+ Select,
+ SelectContent,
+ SelectGroup,
+ SelectItem,
+ SelectTrigger,
+} from "../ui/select";
import { Switch } from "../ui/switch";
import { Tabs, TabsContent, TabsList, TabsTrigger } from "../ui/tabs";
import { Tooltip } from "../ui/tooltip";
@@ -424,6 +442,7 @@ interface ModelListItemProps {
model: AiModel;
isEnabled: boolean;
onToggle: (modelId: QualifiedModelId) => void;
+ onDelete: (modelId: QualifiedModelId) => void;
}
const ModelListItem: React.FC<ModelListItemProps> = ({
@@ -431,11 +450,18 @@ const ModelListItem: React.FC<ModelListItemProps> = ({
model,
isEnabled,
onToggle,
+ onDelete,
}) => {
const handleToggle = () => {
onToggle(qualifiedId);
};
+ const handleDelete = (e: React.MouseEvent<HTMLButtonElement>) => {
+ e.stopPropagation();
+ e.preventDefault();
+ onDelete(qualifiedId);
+ };
+
return (
<TreeItem
id={qualifiedId}
@@ -446,6 +472,16 @@ const ModelListItem: React.FC<ModelListItemProps> = ({
<TreeItemContent>
<div className="flex items-center justify-between px-4 py-3 border-b last:border-b-0 cursor-pointer outline-none">
<ModelInfoCard model={model} qualifiedId={qualifiedId} />
+ {model.custom && (
+ <Button
+ variant="ghost"
+ size="icon"
+ onClick={handleDelete}
+ className="mr-2 hover:bg-transparent"
+ >
+ <Trash2Icon className="h-3.5 w-3.5 text-muted-foreground" />
+ </Button>
+ )}
<Switch checked={isEnabled} onClick={handleToggle} size="sm" />
</div>
</TreeItemContent>
@@ -465,6 +501,9 @@ const ModelInfoCard = ({
<div className="flex flex-col flex-1">
<div className="flex items-center gap-2">
<h3 className="font-medium">{model.name}</h3>
+ <Tooltip content="Custom model">
+ {model.custom && <BotIcon className="h-4 w-4" />}
+ </Tooltip>
</div>
<span className="text-xs text-muted-foreground font-mono">
{qualifiedId}
@@ -932,6 +971,7 @@ interface ProviderTreeItemProps {
enabledModels: Set<QualifiedModelId>;
onToggleModel: (modelId: QualifiedModelId) => void;
onToggleProvider: (providerId: ProviderId, enable: boolean) => void;
+ onDeleteModel: (modelId: QualifiedModelId) => void;
}
const ProviderTreeItem: React.FC<ProviderTreeItemProps> = ({
@@ -940,6 +980,7 @@ const ProviderTreeItem: React.FC<ProviderTreeItemProps> = ({
enabledModels,
onToggleModel,
onToggleProvider,
+ onDeleteModel,
}) => {
const enabledCount = models.filter((model) =>
enabledModels.has(new AiModelId(providerId, model.model).id),
@@ -996,6 +1037,7 @@ const ProviderTreeItem: React.FC<ProviderTreeItemProps> = ({
model={model}
isEnabled={enabledModels.has(qualifiedId)}
onToggle={onToggleModel}
+ onDelete={onDeleteModel}
/>
);
})}
@@ -1007,13 +1049,18 @@ export const AiModelDisplayConfig: React.FC<AiConfigProps> = ({
form,
onSubmit,
}) => {
+ const customModels = useWatch({
+ control: form.control,
+ name: "ai.models.custom_models",
+ }) as QualifiedModelId[];
+
const aiModelRegistry = useMemo(
() =>
AiModelRegistry.create({
displayedModels: [],
- customModels: ["openrouter/deepseek-r1-distill-llama-70b"],
+ customModels: customModels,
}),
- [],
+ [customModels],
);
const currentDisplayedModels = useWatch({
control: form.control,
@@ -1022,6 +1069,7 @@ export const AiModelDisplayConfig: React.FC<AiConfigProps> = ({
}) as QualifiedModelId[];
const currentDisplayedModelsSet = new Set(currentDisplayedModels);
const modelsByProvider = aiModelRegistry.getGroupedModelsByProvider();
+ const listModelsByProvider = aiModelRegistry.getListModelsByProvider();
const toggleModelDisplay = useEvent((modelId: QualifiedModelId) => {
const newModels = currentDisplayedModelsSet.has(modelId)
@@ -1050,9 +1098,15 @@ export const AiModelDisplayConfig: React.FC<AiConfigProps> = ({
},
);
+ const deleteModel = useEvent((modelId: QualifiedModelId) => {
+ const newModels = customModels.filter((id) => id !== modelId);
+ form.setValue("ai.models.custom_models", newModels);
+ onSubmit(form.getValues());
+ });
+
return (
- <SettingGroup>
- <p className="text-sm text-muted-secondary mb-4">
+ <SettingGroup className="gap-2">
+ <p className="text-sm text-muted-secondary mb-6">
Control which AI models are displayed in model selection dropdowns. When
no models are selected, all available models will be shown.
</p>
@@ -1063,7 +1117,7 @@ export const AiModelDisplayConfig: React.FC<AiConfigProps> = ({
className="flex-1 overflow-auto outline-none focus-visible:outline-none"
selectionMode="none"
>
- {[...modelsByProvider.entries()].map(([providerId, models]) => (
+ {listModelsByProvider.map(([providerId, models]) => (
<ProviderTreeItem
key={providerId}
providerId={providerId}
@@ -1071,14 +1125,196 @@ export const AiModelDisplayConfig: React.FC<AiConfigProps> = ({
enabledModels={currentDisplayedModelsSet}
onToggleModel={toggleModelDisplay}
onToggleProvider={toggleProviderModels}
+ onDeleteModel={deleteModel}
/>
))}
</Tree>
</div>
+ <AddModelForm form={form} customModels={customModels} />
</SettingGroup>
);
};
+export const AddModelForm: React.FC<{
+ form: UseFormReturn<UserConfig>;
+ customModels: QualifiedModelId[];
+}> = ({ form, customModels }) => {
+ const [isFormOpen, setIsFormOpen] = useState(false);
+ const [modelAdded, setModelAdded] = useState(false);
+ const [provider, setProvider] = useState<ProviderId | "custom" | null>(null);
+ const [customProviderName, setCustomProviderName] = useState("");
+ const [modelName, setModelName] = useState("");
+
+ const providerSelectId = useId();
+ const customProviderInputId = useId();
+ const modelNameInputId = useId();
+
+ const isCustomProvider = provider === "custom";
+ const providerName = isCustomProvider ? customProviderName : provider;
+ const hasValidValues = providerName?.trim() && modelName?.trim();
+
+ const resetForm = () => {
+ setProvider(null);
+ setCustomProviderName("");
+ setModelName("");
+ setIsFormOpen(false);
+ };
+
+ const handleAddModel = () => {
+ if (!hasValidValues) {
+ return;
+ }
+
+ const newModel = new AiModelId(
+ providerName as ProviderId,
+ modelName as ShortModelId,
+ );
+
+ form.setValue("ai.models.custom_models", [newModel.id, ...customModels]);
+ resetForm();
+
+ // Show model added message for 2 seconds
+ setModelAdded(true);
+ setTimeout(() => setModelAdded(false), 2000);
+ };
+
+ const providerClassName = "w-40 truncate";
+
+ const providerSelect = (
+ <div className="flex flex-col gap-2">
+ <div className="flex items-center gap-2">
+ <Label
+ htmlFor={providerSelectId}
+ className="text-sm font-medium text-muted-foreground min-w-12"
+ >
+ Provider
+ </Label>
+ <Select
+ value={provider || ""}
+ onValueChange={(v) => setProvider(v as ProviderId | "custom")}
+ >
+ <SelectTrigger id={providerSelectId} className={providerClassName}>
+ {provider ? (
+ <div className="flex items-center gap-1.5">
+ <AiProviderIcon
+ provider={provider as ProviderId}
+ className="h-3.5 w-3.5"
+ />
+ <span>{getProviderLabel(provider as ProviderId)}</span>
+ </div>
+ ) : (
+ <span className="text-muted-foreground">Select...</span>
+ )}
+ </SelectTrigger>
+ <SelectContent>
+ <SelectGroup>
+ <SelectItem value="custom">
+ <div className="flex items-center gap-2">
+ <AiProviderIcon
+ provider="openai-compatible"
+ className="h-4 w-4"
+ />
+ <span>Custom</span>
+ </div>
+ </SelectItem>
+ {PROVIDERS.filter((p) => p !== "marimo").map((p) => (
+ <SelectItem key={p} value={p}>
+ <div className="flex items-center gap-2">
+ <AiProviderIcon provider={p} className="h-4 w-4" />
+ <span>{getProviderLabel(p)}</span>
+ </div>
+ </SelectItem>
+ ))}
+ </SelectGroup>
+ </SelectContent>
+ </Select>
+ </div>
+
+ {isCustomProvider && (
+ <div className="flex items-center gap-2">
+ <Label
+ htmlFor={customProviderInputId}
+ className="text-sm font-medium text-muted-foreground min-w-12"
+ >
+ Name
+ </Label>
+ <Input
+ id={customProviderInputId}
+ value={customProviderName}
+ onChange={(e) => setCustomProviderName(e.target.value)}
+ placeholder="openrouter"
+ className={providerClassName}
+ />
+ </div>
+ )}
+ </div>
+ );
+
+ const modelInput = (
+ <div
+ className={cn(
+ "flex items-center gap-2",
+ isCustomProvider && "self-start",
+ )}
+ >
+ <Label
+ htmlFor={modelNameInputId}
+ className="text-sm font-medium text-muted-foreground"
+ >
+ Model
+ </Label>
+ <Input
+ id={modelNameInputId}
+ value={modelName}
+ onChange={(e) => setModelName(e.target.value)}
+ placeholder="gpt-4"
+ className="text-xs mb-0"
+ />
+ </div>
+ );
+
+ const inputForm = (
+ <div className="flex items-center gap-3 p-3 border border-border rounded-md">
+ {providerSelect}
+ {modelInput}
+ <div
+ className={cn("flex gap-1.5 ml-auto", isCustomProvider && "self-end")}
+ >
+ <Button onClick={handleAddModel} disabled={!hasValidValues} size="xs">
+ Add
+ </Button>
+ <Button variant="outline" onClick={resetForm} size="xs">
+ Cancel
+ </Button>
+ </div>
+ </div>
+ );
+
+ return (
+ <div>
+ {isFormOpen && inputForm}
+ <div className="flex flex-row text-sm">
+ <Button
+ onClick={(e) => {
+ e.preventDefault();
+ setIsFormOpen(true);
+ }}
+ variant="link"
+ disabled={isFormOpen}
+ >
+ <PlusIcon className="h-4 w-4 mr-2 mb-0.5" />
+ Add Model
+ </Button>
+ {modelAdded && (
+ <div className="flex items-center gap-1 text-green-700 bg-green-500/10 px-2 py-1 rounded-md ml-auto">
+ ✓ Model added
+ </div>
+ )}
+ </div>
+ </div>
+ );
+};
+
export const AiConfig: React.FC<AiConfigProps> = ({
form,
config,
diff --git a/frontend/src/core/ai/__tests__/model-registry.test.ts b/frontend/src/core/ai/__tests__/model-registry.test.ts
index 06f7b31109..1b30239c6a 100644
--- a/frontend/src/core/ai/__tests__/model-registry.test.ts
+++ b/frontend/src/core/ai/__tests__/model-registry.test.ts
@@ -234,6 +234,34 @@ describe("AiModelRegistry", () => {
});
});
+ describe("getListModelsByProvider", () => {
+ /**
+ * Provider sort order depends on `provider.json`. We can hardcode for tests
+ * OpenAI, Bedrock, Azure, Anthropic, Google, Ollama, GitHub, Marimo
+ */
+ const PROVIDER_SORT_ORDER = ["openai", "anthropic", "google"];
+
+ it("should return list of models by provider", () => {
+ const registry = AiModelRegistry.create({});
+ const listModelsByProvider = registry.getListModelsByProvider();
+ expect(listModelsByProvider).toHaveLength(3);
+
+ // Should be sorted by provider
+ const providers = listModelsByProvider.map(([provider]) => provider);
+ expect(providers).toEqual(PROVIDER_SORT_ORDER);
+ });
+
+ it("should include custom providers at the top", () => {
+ const customModels = ["openrouter/custom-gpt"];
+ const registry = AiModelRegistry.create({ customModels });
+ const listModelsByProvider = registry.getListModelsByProvider();
+ expect(listModelsByProvider).toHaveLength(4);
+
+ const providers = listModelsByProvider.map(([provider]) => provider);
+ expect(providers).toEqual(["openrouter", ...PROVIDER_SORT_ORDER]);
+ });
+ });
+
describe("getCustomModels", () => {
it("should return empty set when no custom models", () => {
const registry = AiModelRegistry.create({});
diff --git a/frontend/src/core/ai/model-registry.ts b/frontend/src/core/ai/model-registry.ts
index c6ecff6396..71c54f5a74 100644
--- a/frontend/src/core/ai/model-registry.ts
+++ b/frontend/src/core/ai/model-registry.ts
@@ -13,6 +13,18 @@ import { once } from "@/utils/once";
import type { ProviderId } from "./ids/ids";
import { AiModelId, type QualifiedModelId, type ShortModelId } from "./ids/ids";
+export const PROVIDER_SORT_ORDER: ProviderId[] = [
+ // Sort by popular ones
+ "anthropic",
+ "openai",
+ "google",
+ "github",
+ "deepseek",
+ "azure",
+ "bedrock",
+ "ollama",
+];
+
export interface AiModel extends AiModelType {
roles: Role[];
model: ShortModelId;
@@ -41,13 +53,21 @@ const getKnownModelMap = once((): ReadonlyMap<QualifiedModelId, AiModel> => {
return modelMap;
});
-const getProviderMap = once((): ReadonlyMap<ProviderId, AiProvider> => {
- const providerMap = new Map<ProviderId, AiProvider>();
- for (const provider of providers) {
- providerMap.set(provider.id as ProviderId, provider);
- }
- return providerMap;
-});
+const getProviderMap = once(
+ (): {
+ providerMap: ReadonlyMap<ProviderId, AiProvider>;
+ providerToOrderIdx: ReadonlyMap<ProviderId, number>;
+ } => {
+ const providerMap = new Map<ProviderId, AiProvider>();
+ const providerToOrderIdx = new Map<ProviderId, number>();
+ providers.forEach((provider, idx) => {
+ const providerId = provider.id as ProviderId;
+ providerMap.set(providerId, provider);
+ providerToOrderIdx.set(providerId, idx);
+ });
+ return { providerMap, providerToOrderIdx };
+ },
+);
export class AiModelRegistry {
private modelsByProviderMap = new MultiMap<ProviderId, AiModel>();
@@ -66,7 +86,8 @@ export class AiModelRegistry {
}
static getProviderInfo(providerId: ProviderId) {
- return getProviderMap().get(providerId);
+ const { providerMap } = getProviderMap();
+ return providerMap.get(providerId);
}
/**
@@ -180,6 +201,21 @@ export class AiModelRegistry {
return this.modelsByProviderMap;
}
+ getListModelsByProvider(): Array<[ProviderId, AiModel[]]> {
+ const modelsByProvider = this.getGroupedModelsByProvider();
+ const arrayModels = [...modelsByProvider.entries()];
+ const providerToOrderIdx = getProviderMap().providerToOrderIdx;
+
+ arrayModels.sort((a, b) => {
+ const aProvider = a[0];
+ const bProvider = b[0];
+ const aOrderIdx = providerToOrderIdx.get(aProvider) ?? 0;
+ const bOrderIdx = providerToOrderIdx.get(bProvider) ?? 0;
+ return aOrderIdx - bOrderIdx;
+ });
+ return arrayModels;
+ }
+
getModelsMap() {
return this.modelsMap;
}