Skip to content

Commit 2d73681

Browse files
ccreutziccreutzi
committed
Rename Model to ModelName
For consistency between `ollamaChat` and `openAIChat`.
1 parent 13ba080 commit 2d73681

File tree

4 files changed

+19
-19
lines changed

4 files changed

+19
-19
lines changed

‎functionSignatures.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@
105105
{
106106
"inputs":
107107
[
108-
{"name":"model","kind":"positional","type":"choices=ollamaChat.models"},
108+
{"name":"modelName","kind":"positional","type":"choices=ollamaChat.models"},
109109
{"name":"systemPrompt","kind":"ordered","type":["string","scalar"]},
110110
{"name":"Temperature","kind":"namevalue","type":["numeric","scalar",">=0","<=2"]},
111111
{"name":"TopP","kind":"namevalue","type":["numeric","scalar",">=0","<=1"]},
@@ -131,7 +131,7 @@
131131
{"name":"messages","kind":"required","type":[["messageHistory","row"],["string","scalar"]]},
132132
{"name":"MaxNumTokens","kind":"namevalue","type":["numeric","scalar","positive"]},
133133
{"name":"Seed","kind":"namevalue","type":["numeric","integer","scalar"]},
134-
{"name":"Model","kind":"namevalue","type":"choices=ollamaChat.models"},
134+
{"name":"ModelName","kind":"namevalue","type":"choices=ollamaChat.models"},
135135
{"name":"Temperature","kind":"namevalue","type":["numeric","scalar",">=0","<=2"]},
136136
{"name":"TopP","kind":"namevalue","type":["numeric","scalar",">=0","<=1"]},
137137
{"name":"MinP","kind":"namevalue","type":["numeric","scalar",">=0","<=1"]},

‎ollamaChat.m‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,14 @@
6262
% generate - Generate a response using the ollamaChat instance.
6363
%
6464
% ollamaChat Properties, in addition to the name-value pairs above:
65-
% Model - Model name (as expected by Ollama server).
65+
% ModelName - Model name (as expected by Ollama server).
6666
%
6767
% SystemPrompt - System prompt.
6868

6969
% Copyright 2024 The MathWorks, Inc.
7070

7171
properties
72-
Model (1,1) string
72+
ModelName (1,1) string
7373
Endpoint (1,1) string
7474
TopK (1,1) {mustBeReal,mustBePositive} = Inf
7575
MinP (1,1) {llms.utils.mustBeValidProbability} = 0
@@ -106,7 +106,7 @@
106106
end
107107
end
108108

109-
this.Model = modelName;
109+
this.ModelName = modelName;
110110
this.ResponseFormat = nvp.ResponseFormat;
111111
this.Temperature = nvp.Temperature;
112112
this.TopP = nvp.TopP;
@@ -133,8 +133,8 @@
133133
% Seed - An integer value to use to obtain
134134
% reproducible responses
135135
%
136-
% Model - Model name (as expected by Ollama server).
137-
% Default value is CHAT.Model.
136+
% ModelName - Model name (as expected by Ollama server).
137+
% Default value is CHAT.ModelName.
138138
%
139139
% Temperature - Temperature value for controlling the randomness
140140
% of the output. Default value is CHAT.Temperature.
@@ -187,7 +187,7 @@
187187
arguments
188188
this (1,1) ollamaChat
189189
messages {mustBeValidMsgs}
190-
nvp.Model {mustBeTextScalar} = this.Model
190+
nvp.ModelName {mustBeTextScalar} = this.ModelName
191191
nvp.Temperature {llms.utils.mustBeValidTemperature} = this.Temperature
192192
nvp.TopP {llms.utils.mustBeValidProbability} = this.TopP
193193
nvp.MinP {llms.utils.mustBeValidProbability} = this.MinP
@@ -220,7 +220,7 @@
220220
end
221221

222222
[text, message, response] = llms.internal.callOllamaChatAPI(...
223-
nvp.Model, messagesStruct, ...
223+
nvp.ModelName, messagesStruct, ...
224224
Temperature=nvp.Temperature, ...
225225
TopP=nvp.TopP, MinP=nvp.MinP, TopK=nvp.TopK,...
226226
TailFreeSamplingZ=nvp.TailFreeSamplingZ,...

‎tests/topenAIChat.m‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ function assignValueToProperty(property, value)
236236
end
237237

238238
function gpt35TurboErrorsForImages(testCase)
239-
chat = openAIChat(APIKey="this-is-not-a-real-key",Model="gpt-3.5-turbo");
239+
chat = openAIChat(APIKey="this-is-not-a-real-key",ModelName="gpt-3.5-turbo");
240240
image_path = "peppers.png";
241241
emptyMessages = messageHistory;
242242
inValidMessages = addUserMessageWithImages(emptyMessages,"What is in the image?",image_path);

‎tests/topenAIImages.m‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,39 +36,39 @@ function keyNotFound(testCase)
3636
end
3737

3838
function promptSizeLimit(testCase)
39-
mdl = openAIImages(APIKey="this-is-not-a-real-key", Model="dall-e-2");
39+
mdl = openAIImages(APIKey="this-is-not-a-real-key", ModelName="dall-e-2");
4040
testCase.verifyError(@()generate(mdl, repmat('c', 1, 1001)), "llms:promptLimitCharacter")
4141
testCase.verifyError(@()edit(mdl, which("peppers.png"), repmat('c', 1, 1001)), "llms:promptLimitCharacter")
42-
mdl = openAIImages(APIKey="this-is-not-a-real-key", Model="dall-e-3");
42+
mdl = openAIImages(APIKey="this-is-not-a-real-key", ModelName="dall-e-3");
4343
testCase.verifyError(@()generate(mdl, repmat('c', 1, 4001)), "llms:promptLimitCharacter")
4444
end
4545

4646

4747
function invalidOptionsGenerate(testCase)
48-
mdl = openAIImages(APIKey="this-is-not-a-real-key", Model="dall-e-2");
48+
mdl = openAIImages(APIKey="this-is-not-a-real-key", ModelName="dall-e-2");
4949
testCase.verifyError(@()generate(mdl, "cat", Quality="hd"), "llms:invalidOptionForModel")
5050
testCase.verifyError(@()generate(mdl, "cat", Style="natural"), "llms:invalidOptionForModel")
5151
testCase.verifyError(@()generate(mdl, "cat", Size="1024x1792"), "MATLAB:validators:mustBeMember")
52-
mdl = openAIImages(ApiKey="this-is-not-a-real-key", Model="dall-e-3");
52+
mdl = openAIImages(ApiKey="this-is-not-a-real-key", ModelName="dall-e-3");
5353
testCase.verifyError(@()generate(mdl, "cat", Size="256x256"), "MATLAB:validators:mustBeMember")
5454
testCase.verifyError(@()generate(mdl, "cat", NumImages=4), "llms:invalidOptionAndValueForModel")
5555
end
5656

5757
function invalidModelEdit(testCase)
5858
validImage = string(which("peppers.png"));
59-
mdl = openAIImages(APIKey="this-is-not-a-real-key", Model="dall-e-3");
59+
mdl = openAIImages(APIKey="this-is-not-a-real-key", ModelName="dall-e-3");
6060
testCase.verifyError(@()edit(mdl, validImage, "cat"), "llms:functionNotAvailableForModel")
6161
end
6262

6363
function invalidModelVariation(testCase)
6464
validImage = string(which("peppers.png"));
65-
mdl = openAIImages(APIKey="this-is-not-a-real-key", Model="dall-e-3");
65+
mdl = openAIImages(APIKey="this-is-not-a-real-key", ModelName="dall-e-3");
6666
testCase.verifyError(@()createVariation(mdl, validImage), ...
6767
"llms:functionNotAvailableForModel")
6868
end
6969

7070
function generateWithAllNVP(testCase)
71-
mdl = openAIImages(APIKey="this-is-not-a-real-key", Model="dall-e-3");
71+
mdl = openAIImages(APIKey="this-is-not-a-real-key", ModelName="dall-e-3");
7272
testCase.verifyWarningFree(@()generate(mdl, ...
7373
"prompt", ...
7474
Quality="hd", ...
@@ -79,7 +79,7 @@ function generateWithAllNVP(testCase)
7979

8080
function editWithAllNVP(testCase)
8181
validImage = string(which("peppers.png"));
82-
mdl = openAIImages(APIKey="this-is-not-a-real-key", Model="dall-e-2");
82+
mdl = openAIImages(APIKey="this-is-not-a-real-key", ModelName="dall-e-2");
8383
testCase.verifyWarningFree(@()edit(mdl, ...
8484
validImage,...
8585
"prompt", ...
@@ -90,7 +90,7 @@ function editWithAllNVP(testCase)
9090

9191
function variationWithAllNVP(testCase)
9292
validImage = string(which("peppers.png"));
93-
mdl = openAIImages(APIKey="this-is-not-a-real-key", Model="dall-e-2");
93+
mdl = openAIImages(APIKey="this-is-not-a-real-key", ModelName="dall-e-2");
9494
testCase.verifyWarningFree(@()createVariation(mdl, ...
9595
validImage,...
9696
Size="512x512",...

0 commit comments

Comments
 (0)