feat: structured snippet

Author: krampstudio

packages/tasks/src/local-apps.ts

@@ -1,6 +1,17 @@
 import type { ModelData } from "./model-data";
 import type { PipelineType } from "./pipelines";
 
+/**
+ * Code snippet to display
+ * Support placeholders in the form of {{key}} in content
+ * where key is a key in the params object
+ */
+export interface Snippet {
+	content: string;
+	language?: "javascript" | "json" | "python" | "bash" | "jboss-cli" | "markdown" | "xml";
+	parameters?: Record<string, string[]>;
+}
+
 /**
  * Elements configurable by a local app.
  */
@@ -38,28 +49,32 @@ export type LocalApp = {
 			/**
 			 * And if not (mostly llama.cpp), snippet to copy/paste in your terminal
 			 */
-			snippet: (model: ModelData) => string | string[];
+			snippet: (model: ModelData) => Snippet | Snippet[];
 	  }
 );
 
 function isGgufModel(model: ModelData) {
 	return model.tags.includes("gguf");
 }
 
-const snippetLlamacpp = (model: ModelData): string[] => {
+const snippetLlamacpp = (model: ModelData): Snippet[] => {
 	return [
-		`
-## Install and build llama.cpp with curl support
+		{
+			content: `## Install and build llama.cpp with curl support
 git clone https://github.com/ggerganov/llama.cpp.git 
 cd llama.cpp
 LLAMA_CURL=1 make
 `,
-		`## Load and run the model
+		},
+		{
+			content: `## Load and run the model
 ./main \\
 	--hf-repo "${model.id}" \\
 	-m {{GGUF_FILE}} \\
 	-p "I believe the meaning of life is" \\
 	-n 128`,
+			parameters: { GGUF_FILE: model.ggufFilePaths ?? [] },
+		},
 	];
 };
 

packages/tasks/src/model-data.ts

@@ -123,6 +123,8 @@ export interface ModelData {
 	 * Example: transformers, SpeechBrain, Stanza, etc.
 	 */
 	library_name?: string;
+
+	ggufFilePaths?: string[];
 }
 
 /**