Merge pull request #256 from lmstudio-ai/ryan/deprecate-gpu

Add deprecation notice to GPUSetting and split strategy
lmstudio-ai · Mar 4, 2025 · 6663b21 · 6663b21
2 parents d760fae + 8514ac8
commit 6663b21
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/packages/lms-shared-types/src/llm/LLMLoadModelConfig.ts b/packages/lms-shared-types/src/llm/LLMLoadModelConfig.ts
@@ -20,6 +20,8 @@ export const llmLlamaAccelerationOffloadRatioSchema = z.union([
  * - "favorMainGpu": Fill the main GPU first, then fill the rest of the GPUs evenly
  *
  * @public
+ * @deprecated We are currently working on an improved way to control split. You can use this for
+ * now. We will offer the alternative before this feature is removed.
  */
 export type LLMSplitStrategy = "evenly" | "favorMainGpu";
 export const llmSplitStrategySchema = z.enum(["evenly", "favorMainGpu"]);
@@ -28,6 +30,8 @@ export const llmSplitStrategySchema = z.enum(["evenly", "favorMainGpu"]);
  * Settings related to offloading work to the GPU.
  *
  * @public
+ * @deprecated We are currently working on an improved way to control split. You can use this for
+ * now. We will offer the alternative before this feature is removed.
  */
 export type GPUSetting = {
   /**
@@ -112,6 +116,8 @@ export interface LLMLoadModelConfig {
    * How to distribute the work to your GPUs. See {@link GPUSetting} for more information.
    *
    * @public
+   * @deprecated We are currently working on an improved way to control split. You can use this for
+   * now but expect breakage in the future.
    */
   gpu?: GPUSetting;