Spaces:
Sleeping
Sleeping
File size: 6,942 Bytes
19e88d2 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 | import type { ModelData } from "./model-data.js";
import type { PipelineType } from "./pipelines.js";
export interface LocalAppSnippet {
/**
* Title of the snippet
*/
title: string;
/**
* Optional setup guide
*/
setup?: string;
/**
* Content (or command) to be run
*/
content: string | string[];
}
/**
* Elements configurable by a local app.
*/
export type LocalApp = {
/**
* Name that appears in buttons
*/
prettyLabel: string;
/**
* Link to get more info about a local app (website etc)
*/
docsUrl: string;
/**
* main category of app
*/
mainTask: PipelineType;
/**
* Whether to display a pill "macOS-only"
*/
macOSOnly?: boolean;
comingSoon?: boolean;
/**
* IMPORTANT: function to figure out whether to display the button on a model page's main "Use this model" dropdown.
*/
displayOnModelPage: (model: ModelData) => boolean;
} & ({
/**
* If the app supports deeplink, URL to open.
*/
deeplink: (model: ModelData, filepath?: string) => URL;
} | {
/**
* And if not (mostly llama.cpp), snippet to copy/paste in your terminal
* Support the placeholder {{GGUF_FILE}} that will be replaced by the gguf file path or the list of available files.
* Support the placeholder {{QUANT_TAG}} that will be replaced by the list of available quant tags or will be removed if there are no multiple quant files in a same repo.
*/
snippet: (model: ModelData, filepath?: string) => string | string[] | LocalAppSnippet | LocalAppSnippet[];
});
declare function isTgiModel(model: ModelData): boolean;
declare function isLlamaCppGgufModel(model: ModelData): boolean;
declare function isVllmModel(model: ModelData): boolean;
declare function isDockerModelRunnerModel(model: ModelData): boolean;
/**
* Add your new local app here.
*
* This is open to new suggestions and awesome upcoming apps.
*
* /!\ IMPORTANT
*
* If possible, you need to support deeplinks and be as cross-platform as possible.
*
* Ping the HF team if we can help with anything!
*/
export declare const LOCAL_APPS: {
"llama.cpp": {
prettyLabel: string;
docsUrl: string;
mainTask: "text-generation";
displayOnModelPage: typeof isLlamaCppGgufModel;
snippet: (model: ModelData, filepath?: string) => LocalAppSnippet[];
};
"node-llama-cpp": {
prettyLabel: string;
docsUrl: string;
mainTask: "text-generation";
displayOnModelPage: typeof isLlamaCppGgufModel;
snippet: (model: ModelData, filepath?: string) => LocalAppSnippet[];
};
vllm: {
prettyLabel: string;
docsUrl: string;
mainTask: "text-generation";
displayOnModelPage: typeof isVllmModel;
snippet: (model: ModelData) => LocalAppSnippet[];
};
sglang: {
prettyLabel: string;
docsUrl: string;
mainTask: "text-generation";
displayOnModelPage: (model: ModelData) => boolean;
snippet: (model: ModelData) => LocalAppSnippet[];
};
"mlx-lm": {
prettyLabel: string;
docsUrl: string;
mainTask: "text-generation";
displayOnModelPage: (model: ModelData) => boolean;
snippet: (model: ModelData) => LocalAppSnippet[];
};
tgi: {
prettyLabel: string;
docsUrl: string;
mainTask: "text-generation";
displayOnModelPage: typeof isTgiModel;
snippet: (model: ModelData) => LocalAppSnippet[];
};
lmstudio: {
prettyLabel: string;
docsUrl: string;
mainTask: "text-generation";
displayOnModelPage: (model: ModelData) => boolean;
deeplink: (model: ModelData, filepath: string | undefined) => URL;
};
localai: {
prettyLabel: string;
docsUrl: string;
mainTask: "text-generation";
displayOnModelPage: typeof isLlamaCppGgufModel;
snippet: (model: ModelData, filepath?: string) => LocalAppSnippet[];
};
jan: {
prettyLabel: string;
docsUrl: string;
mainTask: "text-generation";
displayOnModelPage: typeof isLlamaCppGgufModel;
deeplink: (model: ModelData) => URL;
};
backyard: {
prettyLabel: string;
docsUrl: string;
mainTask: "text-generation";
displayOnModelPage: typeof isLlamaCppGgufModel;
deeplink: (model: ModelData) => URL;
};
sanctum: {
prettyLabel: string;
docsUrl: string;
mainTask: "text-generation";
displayOnModelPage: typeof isLlamaCppGgufModel;
deeplink: (model: ModelData) => URL;
};
jellybox: {
prettyLabel: string;
docsUrl: string;
mainTask: "text-generation";
displayOnModelPage: (model: ModelData) => boolean;
deeplink: (model: ModelData) => URL;
};
msty: {
prettyLabel: string;
docsUrl: string;
mainTask: "text-generation";
displayOnModelPage: typeof isLlamaCppGgufModel;
deeplink: (model: ModelData) => URL;
};
recursechat: {
prettyLabel: string;
docsUrl: string;
mainTask: "text-generation";
macOSOnly: true;
displayOnModelPage: typeof isLlamaCppGgufModel;
deeplink: (model: ModelData) => URL;
};
drawthings: {
prettyLabel: string;
docsUrl: string;
mainTask: "text-to-image";
macOSOnly: true;
displayOnModelPage: (model: ModelData) => boolean;
deeplink: (model: ModelData) => URL;
};
diffusionbee: {
prettyLabel: string;
docsUrl: string;
mainTask: "text-to-image";
macOSOnly: true;
displayOnModelPage: (model: ModelData) => boolean;
deeplink: (model: ModelData) => URL;
};
joyfusion: {
prettyLabel: string;
docsUrl: string;
mainTask: "text-to-image";
macOSOnly: true;
displayOnModelPage: (model: ModelData) => boolean;
deeplink: (model: ModelData) => URL;
};
ollama: {
prettyLabel: string;
docsUrl: string;
mainTask: "text-generation";
displayOnModelPage: typeof isLlamaCppGgufModel;
snippet: (model: ModelData, filepath?: string) => string;
};
"docker-model-runner": {
prettyLabel: string;
docsUrl: string;
mainTask: "text-generation";
displayOnModelPage: typeof isDockerModelRunnerModel;
snippet: (model: ModelData, filepath?: string) => string;
};
lemonade: {
prettyLabel: string;
docsUrl: string;
mainTask: "text-generation";
displayOnModelPage: (model: ModelData) => boolean;
snippet: (model: ModelData, filepath?: string) => LocalAppSnippet[];
};
};
export type LocalAppKey = keyof typeof LOCAL_APPS;
export {};
//# sourceMappingURL=local-apps.d.ts.map |