Merge pull request #74 from matlab-deep-learning/main

Merge main into documentation.

Author: MiriamScharnke

+llms/+internal/callAzureChatAPI.m

@@ -64,7 +64,7 @@
 
 parameters = buildParametersCall(messages, functions, nvp);
 
-[response, streamedText] = llms.internal.sendRequest(parameters,nvp.APIKey, URL, nvp.TimeOut, nvp.StreamFun);
+[response, streamedText] = llms.internal.sendRequestWrapper(parameters,nvp.APIKey, URL, nvp.TimeOut, nvp.StreamFun);
 
 % If call errors, "choices" will not be part of response.Body.Data, instead
 % we get response.Body.Data.error

+llms/+internal/callOllamaChatAPI.m

@@ -53,7 +53,7 @@
 
 parameters = buildParametersCall(model, messages, nvp);
 
-[response, streamedText] = llms.internal.sendRequest(parameters,[],URL,nvp.TimeOut,nvp.StreamFun);
+[response, streamedText] = llms.internal.sendRequestWrapper(parameters,[],URL,nvp.TimeOut,nvp.StreamFun);
 
 % If call errors, "choices" will not be part of response.Body.Data, instead
 % we get response.Body.Data.error

+llms/+internal/callOpenAIChatAPI.m

@@ -62,7 +62,7 @@
 
 parameters = buildParametersCall(messages, functions, nvp);
 
-[response, streamedText] = llms.internal.sendRequest(parameters,nvp.APIKey, END_POINT, nvp.TimeOut, nvp.StreamFun);
+[response, streamedText] = llms.internal.sendRequestWrapper(parameters,nvp.APIKey, END_POINT, nvp.TimeOut, nvp.StreamFun);
 
 % If call errors, "choices" will not be part of response.Body.Data, instead
 % we get response.Body.Data.error

+llms/+internal/sendRequestWrapper.m

@@ -0,0 +1,5 @@
+function [response, streamedText] = sendRequestWrapper(varargin)
+% This function is undocumented and will change in a future release
+
+% A wrapper around sendRequest to have a test seam
+[response, streamedText] = llms.internal.sendRequest(varargin{:});

+llms/+internal/textGenerator.m

@@ -28,4 +28,10 @@
     properties (Access=protected)
         StreamFun
     end
+
+    methods
+        function hObj = set.StopSequences(hObj,value)
+            hObj.StopSequences = string(value);
+        end
+    end
 end

+llms/+stream/responseStreamer.m

@@ -84,7 +84,8 @@
                                 end
                                 this.StreamFun('');
                                 this.ResponseText = txt;
-                            else
+                            elseif isfield(json.choices,"delta") && ...
+                                    isfield(json.choices.delta,"content")
                                 txt = json.choices.delta.content;
                                 this.StreamFun(txt);
                                 this.ResponseText = [this.ResponseText txt];

+llms/+utils/errorMessageCatalog.m

@@ -41,22 +41,22 @@
 catalog("llms:mustBeAssistantWithIdAndFunction") = "Field 'tool_call' must be a struct with fields 'id' and 'function'.";
 catalog("llms:mustBeAssistantWithNameAndArguments") = "Field 'function' must be a struct with fields 'name' and 'arguments'.";
 catalog("llms:assistantMustHaveTextNameAndArguments") = "Fields 'name' and 'arguments' must be text with one or more characters.";
-catalog("llms:mustBeValidIndex") = "Index exceeds the number of array elements. Index must be less than or equal to ({1}).";
-catalog("llms:stopSequencesMustHaveMax4Elements") = "Number of elements must not be larger than 4.";
+catalog("llms:mustBeValidIndex") = "Index exceeds the number of array elements. Index must be less than or equal to {1}.";
+catalog("llms:stopSequencesMustHaveMax4Elements") = "Number of stop sequences must be less than or equal to 4.";
 catalog("llms:endpointMustBeSpecified") = "Unable to find endpoint. Either set environment variable AZURE_OPENAI_ENDPOINT or specify name-value argument ""Endpoint"".";
 catalog("llms:deploymentMustBeSpecified") = "Unable to find deployment name. Either set environment variable AZURE_OPENAI_DEPLOYMENT or specify name-value argument ""Deployment"".";
 catalog("llms:keyMustBeSpecified") = "Unable to find API key. Either set environment variable {1} or specify name-value argument ""APIKey"".";
-catalog("llms:mustHaveMessages") = "Value must contain at least one message in Messages.";
+catalog("llms:mustHaveMessages") = "Message history must not be empty.";
 catalog("llms:mustSetFunctionsForCall") = "When no functions are defined, ToolChoice must not be specified.";
-catalog("llms:mustBeMessagesOrTxt") = "Messages must be text with one or more characters or a messageHistory object.";
-catalog("llms:invalidOptionAndValueForModel") = "'{1}' with value '{2}' is not supported for ModelName '{3}'";
-catalog("llms:invalidOptionForModel") = "{1} is not supported for ModelName '{2}'";
-catalog("llms:invalidContentTypeForModel") = "{1} is not supported for ModelName '{2}'";
-catalog("llms:functionNotAvailableForModel") = "This function is not supported for ModelName '{1}'";
-catalog("llms:promptLimitCharacter") = "Prompt must have a maximum length of {1} characters for ModelName '{2}'";
-catalog("llms:pngExpected") = "Argument must be a PNG image.";
+catalog("llms:mustBeMessagesOrTxt") = "Message must be nonempty string, character array, cell array of character vectors, or messageHistory object.";
+catalog("llms:invalidOptionAndValueForModel") = "'{1}' with value '{2}' is not supported for model ""{3}"".";
+catalog("llms:invalidOptionForModel") = "Invalid argument name {1} for model ""{2}"".";
+catalog("llms:invalidContentTypeForModel") = "{1} is not supported for model ""{2}"".";
+catalog("llms:functionNotAvailableForModel") = "Image editing is not supported for model ""{1}"".";
+catalog("llms:promptLimitCharacter") = "Prompt must contain at most {1} characters for model ""{2}"".";
+catalog("llms:pngExpected") = "Image must be a PNG file (*.png).";
 catalog("llms:warningJsonInstruction") = "When using JSON mode, you must also prompt the model to produce JSON yourself via a system or user message.";
-catalog("llms:apiReturnedError") = "Server error: ""{1}""";
+catalog("llms:apiReturnedError") = "Server returned error indicating: ""{1}""";
 catalog("llms:dimensionsMustBeSmallerThan") = "Dimensions must be less than or equal to {1}.";
 catalog("llms:stream:responseStreamer:InvalidInput") = "Input does not have the expected json format, got ""{1}"".";
 end

+llms/+utils/mustBeValidStop.m

@@ -5,6 +5,7 @@ function mustBeValidStop(value)
     if ~isempty(value)
         mustBeVector(value);
         mustBeNonzeroLengthText(value);
+        value = string(value);
         % This restriction is set by the OpenAI API
         if numel(value)>4
             error("llms:stopSequencesMustHaveMax4Elements", llms.utils.errorMessageCatalog.getMessage("llms:stopSequencesMustHaveMax4Elements"));

.githooks/pre-commit

@@ -0,0 +1,34 @@
+#!/bin/bash
+
+cd $(git rev-parse --show-toplevel)
+pwd
+
+# For all commits of mlx files, create corresponding Markdown (md) files.
+# If the mlx files are in .../mlx-scripts/*.mlx, the corresponding
+# md files will go into .../*.md.
+#
+# This script assumes that the mlx files as currently in the file system
+# are what is being committed, instead of doing a lot of extra work to
+# get them from the stage area.
+#
+# Note that this script will not remove media files. If an mlx has
+# fewer plots at some point in the future, there will be file system
+# cruft. Which doesn't hurt the md display in GitHub or elswehere.
+changedMlxFiles=`git diff --cached --name-only --diff-filter=d '*.mlx'`
+
+if [ -n "$changedMlxFiles" ]; then
+    # Keep the line break here, we replace end-of-line with "' '" to get the quotes right
+    matlab -batch "for file = {'${changedMlxFiles//
+/' '}'}, export(file{1},replace(erase(file{1},'mlx-scripts'),'.mlx','.md')); end"
+    tmp=${changedMlxFiles//mlx-scripts\//}
+    mdFiles=${tmp//.mlx/.md}
+    for file in $mdFiles; do
+        if [ -d ${file%.md}_media ]; then
+            git add ${file%.md}_media/
+        fi
+        perl -pi -e "\$cnt++ if /^#/; " \
+            -e "\$_ .= \"\nTo run the code shown on this page, open the MLX file in MATLAB®: [mlx-scripts/$(basename $file .md).mlx](mlx-scripts/$(basename $file .md).mlx) \n\" if /^#/ && \$cnt==1;" \
+            $file
+    done
+    git add $mdFiles
+fi

.github/CODEOWNERS

@@ -0,0 +1,4 @@
+# Code owners, to get auto-filled reviewer lists
+
+# To start with, we just assume everyone in the core team is included on all reviews
+* @adulai @ccreutzi @debymf @MiriamScharnke @vpapanasta