mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-03-02 03:30:04 +00:00
initial model store (#674)
* initial model store * refactor the 'modelstoreserviceimpl' to pinia * pepper in some reactive the inner ModelStore (per-folder) can't be pinia because its made of temporary instances, but it can be reactive * use refs in metadata class * remove 'reactive' * remove ref too * add simple unit tests for modelStore * make things worse via autoformatting * move mock impls to a function
This commit is contained in:
committed by
GitHub
parent
6c7fb5041d
commit
060e61f0db
136
src/stores/modelStore.ts
Normal file
136
src/stores/modelStore.ts
Normal file
@@ -0,0 +1,136 @@
|
||||
import { api } from '@/scripts/api'
|
||||
import { defineStore } from 'pinia'
|
||||
|
||||
/** (Internal helper) finds a value in a metadata object from any of a list of keys. */
|
||||
function _findInMetadata(metadata: any, ...keys: string[]): string | null {
|
||||
for (const key of keys) {
|
||||
if (key in metadata) {
|
||||
return metadata[key]
|
||||
}
|
||||
for (const k in metadata) {
|
||||
if (k.endsWith(key)) {
|
||||
return metadata[k]
|
||||
}
|
||||
}
|
||||
}
|
||||
return null
|
||||
}
|
||||
|
||||
/** Defines and holds metadata for a model */
|
||||
export class ComfyModelDef {
|
||||
/** Proper filename of the model */
|
||||
name: string = ''
|
||||
/** Directory containing the model, eg 'checkpoints' */
|
||||
directory: string = ''
|
||||
/** Title / display name of the model, sometimes same as the name but not always */
|
||||
title: string = ''
|
||||
/** Metadata: architecture ID for the model, such as 'stable-diffusion-xl-v1-base' */
|
||||
architecture_id: string = ''
|
||||
/** Metadata: author of the model */
|
||||
author: string = ''
|
||||
/** Metadata: resolution of the model, eg '1024x1024' */
|
||||
resolution: string = ''
|
||||
/** Metadata: description of the model */
|
||||
description: string = ''
|
||||
/** Metadata: usage hint for the model */
|
||||
usage_hint: string = ''
|
||||
/** Metadata: trigger phrase for the model */
|
||||
trigger_phrase: string = ''
|
||||
/** Metadata: tags list for the model */
|
||||
tags: string[] = []
|
||||
/** Metadata: image for the model */
|
||||
image: string = ''
|
||||
/** Whether the model metadata has been loaded from the server, used for `load()` */
|
||||
has_loaded_metadata: boolean = false
|
||||
|
||||
constructor(name: string, directory: string) {
|
||||
this.name = name
|
||||
this.title = name
|
||||
this.directory = directory
|
||||
}
|
||||
|
||||
/** Loads the model metadata from the server, filling in this object if data is available */
|
||||
async load(): Promise<void> {
|
||||
if (this.has_loaded_metadata) {
|
||||
return
|
||||
}
|
||||
const metadata = await api.viewMetadata(this.directory, this.name)
|
||||
if (!metadata) {
|
||||
return
|
||||
}
|
||||
this.title =
|
||||
_findInMetadata(
|
||||
metadata,
|
||||
'modelspec.title',
|
||||
'title',
|
||||
'display_name',
|
||||
'name'
|
||||
) || this.name
|
||||
this.architecture_id =
|
||||
_findInMetadata(metadata, 'modelspec.architecture', 'architecture') || ''
|
||||
this.author = _findInMetadata(metadata, 'modelspec.author', 'author') || ''
|
||||
this.description =
|
||||
_findInMetadata(metadata, 'modelspec.description', 'description') || ''
|
||||
this.resolution =
|
||||
_findInMetadata(metadata, 'modelspec.resolution', 'resolution') || ''
|
||||
this.usage_hint =
|
||||
_findInMetadata(metadata, 'modelspec.usage_hint', 'usage_hint') || ''
|
||||
this.trigger_phrase =
|
||||
_findInMetadata(metadata, 'modelspec.trigger_phrase', 'trigger_phrase') ||
|
||||
''
|
||||
this.image =
|
||||
_findInMetadata(
|
||||
metadata,
|
||||
'modelspec.thumbnail',
|
||||
'thumbnail',
|
||||
'image',
|
||||
'icon'
|
||||
) || ''
|
||||
const tagsCommaSeparated =
|
||||
_findInMetadata(metadata, 'modelspec.tags', 'tags') || ''
|
||||
this.tags = tagsCommaSeparated.split(',').map((tag) => tag.trim())
|
||||
this.has_loaded_metadata = true
|
||||
}
|
||||
}
|
||||
|
||||
/** Model store for a folder */
|
||||
export class ModelStore {
|
||||
models: Record<string, ComfyModelDef> = {}
|
||||
|
||||
constructor(directory: string, models: string[]) {
|
||||
for (const model of models) {
|
||||
this.models[model] = new ComfyModelDef(model, directory)
|
||||
}
|
||||
}
|
||||
|
||||
async loadModelMetadata(modelName: string) {
|
||||
if (this.models[modelName]) {
|
||||
await this.models[modelName].load()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/** Model store handler, wraps individual per-folder model stores */
|
||||
export const useModelStore = defineStore('modelStore', {
|
||||
state: () => ({
|
||||
modelStoreMap: {} as Record<string, ModelStore>
|
||||
}),
|
||||
actions: {
|
||||
async getModelsInFolderCached(folder: string): Promise<ModelStore> {
|
||||
if (folder in this.modelStoreMap) {
|
||||
return this.modelStoreMap[folder]
|
||||
}
|
||||
// TODO: needs a lock to avoid overlapping calls
|
||||
const models = await api.getModels(folder)
|
||||
if (!models) {
|
||||
return null
|
||||
}
|
||||
const store = new ModelStore(folder, models)
|
||||
this.modelStoreMap[folder] = store
|
||||
return store
|
||||
},
|
||||
clearCache() {
|
||||
this.modelStoreMap = {}
|
||||
}
|
||||
}
|
||||
})
|
||||
Reference in New Issue
Block a user