Skip to content

Allow --mlx, --gguf and @quant in owner/name format for lms get #322

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
rugvedS07 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Allow --mlx, --gguf and @quant in owner/name format for lms get #322

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 46 additions & 10 deletions src/subcommands/get.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,14 +109,6 @@ export const get = addLogLevelOptions(

if (modelName !== undefined && modelName.split("/").length === 2) {
// New lms get behavior: download artifact
if (mlx) {
logger.error("You cannot use the --mlx flag when an exact artifact is specified.");
process.exit(1);
}
if (gguf) {
logger.error("You cannot use the --gguf flag when an exact artifact is specified.");
process.exit(1);
}
if (limit !== undefined) {
logger.error("You cannot use the --limit flag when an exact artifact is specified.");
process.exit(1);
Expand All @@ -133,7 +125,31 @@ export const get = addLogLevelOptions(
`;
process.exit(1);
}
const [owner, name] = modelName.toLowerCase().split("/");

let owner: string, name: string, quant: string | undefined;
// Parse owner/name@quant format
if (modelName.includes("@")) {
const parts = modelName.toLowerCase().split("@");
if (parts.length !== 2) {
logger.error("Invalid model format. Use: owner/name or owner/name@quant");
process.exit(1);
}
const [ownerName, quantPart] = parts;
const ownerNameParts = ownerName.split("/");
if (ownerNameParts.length !== 2) {
logger.error("Invalid model format. Use: owner/name or owner/name@quant");
process.exit(1);
}
[owner, name] = ownerNameParts;
quant = quantPart;
} else {
const parts = modelName.toLowerCase().split("/");
if (parts.length !== 2) {
logger.error("Invalid model format. Use: owner/name or owner/name@quant");
process.exit(1);
}
[owner, name] = parts;
}
if (!kebabCaseRegex.test(owner)) {
logger.error("Invalid artifact owner:", owner);
process.exit(1);
Expand All @@ -142,7 +158,11 @@ export const get = addLogLevelOptions(
logger.error("Invalid artifact name:", name);
process.exit(1);
}
await downloadArtifact(client, logger, owner, name, yes);
await downloadArtifact(client, logger, owner, name, yes, {
mlx,
gguf,
quant,
});
return;
}

Expand Down Expand Up @@ -608,12 +628,19 @@ async function artifactDownloadPlanToString(
}
}

interface DownloadArtifactOpts {
mlx?: boolean;
gguf?: boolean;
quant?: string;
}

export async function downloadArtifact(
client: LMStudioClient,
logger: SimpleLogger,
owner: string,
name: string,
yes: boolean,
{ mlx, gguf, quant }: DownloadArtifactOpts = {},
) {
console.info();
let downloadPlan: ArtifactDownloadPlan = {
Expand Down Expand Up @@ -680,13 +707,22 @@ export async function downloadArtifact(
}
};
process.stdout.write("\x1B[?25l");
const types: Array<ModelCompatibilityType> = [];
if (mlx === true) {
types.push("safetensors");
}
if (gguf === true) {
types.push("gguf");
}
using downloadPlanner = client.repository.createArtifactDownloadPlanner({
owner,
name,
onPlanUpdated: newPlan => {
downloadPlan = newPlan;
reprintDownloadPlan(false);
},
compatibilityTypeFilter: types.length > 0 ? types : undefined,
quantizationFilter: quant !== undefined ? [quant] : undefined,
});
reprintDownloadPlan(false);
const autoReprintInterval = setInterval(() => {
Expand Down