Fixing text, m-help and README.

debymf · debymf · commit b270c1ad8110 · 2023-10-09T15:19:13.000+01:00
diff --git a/README.md b/README.md
@@ -4,19 +4,18 @@ This repository contains example code to demonstrate how to connect MATLAB to th
 
 The functionality shown here serves as an interface to the ChatGPT API. To start using the ChatGPT API, you first need to obtain the OpenAI API keys. You are responsible for any fees OpenAI may charge for the use of their API. You should be familiar with the limitations and risks associated with using this technology, and you agree that you shall be solely responsible for full compliance with any terms that may apply to your use of the OpenAI Chat Completions API.
 
-The current LLMs supported are:
+Some of the current LLMs supported are:
 - gpt-3.5-turbo
-- gpt-3.5-turbo-0613
-- gpt-3.5-turbo-16k
-- gpt-3.5-turbo-16k-0613
 - gpt-4
-- gpt-4-0613
-- gpt-4-32k
-- gpt-4-32k-0613
 
 For details on the specification of each model, check the official [OpenAI documentation](https://platform.openai.com/docs/models).
 
 ## Setup
+
+If you would like to use this repository with MATLAB Online, simply click [![Open in MATLAB Online](https://www.mathworks.com/images/responsive/global/open-in-matlab-online.svg)](https://matlab.mathworks.com/open/github/v1?repo=matlab-deep-learning/llms-with-matlab)
+
+If you would like to use it with MATLAB Desktop, proceed with the following steps:
+
 1. Clone the repository to your local machine.
 
     ```bash
@@ -42,7 +41,6 @@ For details on the specification of each model, check the official [OpenAI docum
     loadenv(filename)
     ```
 
-
 ### MathWorks Products (https://www.mathworks.com)
 
 - Requires MATLAB release R2023a or newer.
diff --git a/examples/ExampleBasicUsage.mlx b/examples/ExampleBasicUsage.mlx
diff --git a/examples/ExampleSummarization.m b/examples/ExampleSummarization.m
@@ -6,8 +6,8 @@
 % piece of text extracted from a webpage hosted by MathWorks.
 
 % Initiating a ChatGPT session with the role defined as a professional summarizer
-chat = openAIChat("You are a professional summarizer, create a summary of the provided text, be it an article, post, conversation, or passage.");
-
+chat = openAIChat("You are a professional summarizer, create a summary of the provided text, be it an article," + ...
+    " post, conversation, or passage.");
 
 url = "https://www.mathworks.com/help/textanalytics";
 code = webread(url);
@@ -19,11 +19,11 @@
 %% Summarizing large documents
 % This section of the script demonstrates how to incrementally summarize a large text
 % by breaking it into smaller chunks and summarizing each chunk step by
-% step. It uses as input text Romeo and Juliet, by William Shakespeare,
-% from The Project Gutenberg.
+% step. It uses as input text Alice's Adventures in Wonderland by
+% Lewis Carroll from Project Gutenberg.
 
 options = weboptions(Timeout=30);
-code = webread("https://www.gutenberg.org/files/1513/1513-h/1513-h.htm", options);
+code = webread("https://www.gutenberg.org/files/11/11-h/11-h.htm", options);
 longText = extractHTMLText(string(code));
 
 incrementalSummary = longText;
diff --git a/openAIChat.m b/openAIChat.m
@@ -4,32 +4,32 @@
 %   CHAT = openAIChat(systemPrompt) creates an openAIChat object with the
 %   specified system prompt.
 %
-%   CHAT = openAIChat(systemPrompt, Name=Value) specifies additional options
+%   CHAT = openAIChat(systemPrompt,ApiKey=key) uses the specified API key
+%
+%   CHAT = openAIChat(systemPrompt,Name=Value) specifies additional options
 %   using one or more name-value arguments:
 %
-%   'Functions'              - An array of openAIFunction objects representing
+%   Functions               - Array of openAIFunction objects representing
 %                             custom functions to be used during chat completions.
 %
-%   'ModelName'              - The name of the model to use for chat completions.
+%   ModelName               - Name of the model to use for chat completions.
 %                             The default value is "gpt-3.5-turbo".
 %
-%   'Temperature'            - The temperature value for controlling the randomness
-%                             of the output. The default value is 1.
+%   Temperature             - Temperature value for controlling the randomness
+%                             of the output. Default value is 1.
 %
-%   'TopProbabilityMass'     - The top probability mass value for controlling the
-%                             diversity of the output. The default value is 1.
+%   TopProbabilityMass      - Top probability mass value for controlling the
+%                             diversity of the output. Default value is 1.
 %
-%   'StopSequences'          - Vector of strings that when encountered, will
-%                             stop the generation of tokens. The default
+%   StopSequences           - Vector of strings that when encountered, will
+%                             stop the generation of tokens. Default
 %                             value is empty.
 %
-%   'ApiKey'                 - The API key for accessing the OpenAI Chat API.
-%
-%   'PresencePenalty'        - The penalty value for using a token in the response
-%                             that has already been used.  The default value is 0.
+%   PresencePenalty         - Penalty value for using a token in the response
+%                             that has already been used. Default value is 0.
 %
-%   'FrequencyPenalty'       - The penalty value for using a token that is frequent
-%                             in the training data.  The default value is 0.
+%   FrequencyPenalty         - Penalty value for using a token that is frequent
+%                             in the training data. Default value is 0.
 %
 %   openAIChat Functions:
 %       openAIChat           - Chat completion API from OpenAI.
@@ -145,20 +145,19 @@
             %generate   Generate a response using the openAIChat instance.
             %
             %   [TEXT, MESSAGE, RESPONSE] = generate(CHAT, MESSAGES) generates a response
-            %   with the specified MESSAGES and optional
-            %   name-value pair arguments.
+            %   with the specified MESSAGES.
             %
             %   [TEXT, MESSAGE, RESPONSE] = generate(__, Name=Value) specifies additional options
             %   using one or more name-value arguments:
             %
             %       NumCompletions   - Number of completions to generate.
-            %                          The default value is 1.
+            %                          Default value is 1.
             %
             %       MaxNumTokens     - Maximum number of tokens in the generated response.
-            %                          The default value is inf.
+            %                          Default value is inf.
             %
             %       FunctionCall     - Function call to execute before generating the
-            %                          response. The default value is empty.
+            %                          response, specified as a string array. Default value is empty.
             
             arguments
                 this                    (1,1) openAIChat
diff --git a/openAIFunction.m b/openAIFunction.m
@@ -2,7 +2,7 @@
 %openAIFunction   Define a function
 %
 %   FUNC = openAIFunction(NAME, DESCRIPTION) creates an open AI function
-%   object with the specified NAME and DESCRIPTION.
+%   object with the specified name and description.
 %
 %   openAIFunction Functions:
 %       openAIFunction - Define a function.
@@ -48,28 +48,27 @@
         function this = addParameter(this, parameterName, propertyName, propertyValue, nvp)
             %addParameter   Add parameter to the function
             %
-            %   FUNC = addParameter(FUNC, parameterName, propertyName, propertyValue)
-            %   adds a parameter to the function signature with name parameterName and
-            %   property propertyName with value propertyValue. Inputs propertyName and
-            %   propertyValue can be specified repeatedly. The values
-            %   accepted for propertyNames are "type", "description" and
-            %   "enum". Each propertyName will accept different values 
-            %   for propertyValue: 
-            %   - type: accepts "string", "number", "integer", "object", "boolean",
-            %       "null" and any combination of those values.
-            %   - description: accepts text scalar.
-            %   - enum: accepts string vectors of text.
+            %   FCN = addParameter(FCN,paramName,propName1,value1, ..., propNameN,valueN)
+            %   adds the specified parameter and corresponding property names and values to the
+            %   function signature. The property names must be 
+            %   "type", "description", or "enum".
+            %   The values depend on the property name:
+            %   - Values corresponding to "type" must be any combination of "string",
+            %   "number", "integer", "object", "boolean", "null".
+            %   - Values corresponding to "description" must be a string scalar.
+            %   - Value corresponging to "enum" must be string vectors.
             %
-            %   FUNC = addParameter(__, RequiredParameter=TF), specifies
-            %   if the parameter is required.
+            %   FCN = addParameter(__,RequiredParameter=TF), specifies
+            %   if the parameter is a required parameter.
             %
             %   Example:
             %   % Create an OpenAI function object
             %   f = openAIFunction("editDistance", "Find edit distance between two strings or documents");
             %
             %   % Add two parameters with type and description
-            %   f = addParameter(f, "str1", type="string", description="Source string.");
-            %   f = addParameter(f, "str2", type="string", description="Target string.");
+            %   f = addParameter(f,"str1","type","string","description","Source string.");
+            %   f = addParameter(f,"str2","type","string" ,"description","Target string.");
+
 
             arguments
                 this (1,1) openAIFunction
diff --git a/openAIMessages.m b/openAIMessages.m
@@ -24,7 +24,7 @@
             %addSystemMessage   Add system message.
             %
             %   MESSAGES = addSystemMessage(MESSAGES, NAME, CONTENT) adds a system
-            %   message with the specified NAME and CONTENT. NAME and CONTENT
+            %   message with the specified name and content. NAME and CONTENT
             %   must be text scalars.
             %
             %   Example:
@@ -51,7 +51,7 @@
             %addUserMessage   Add user message.
             %
             %   MESSAGES = addUserMessage(MESSAGES, CONTENT) adds a user message
-            %   with the specified CONTENT to MESSAGES. CONTENT must be a text scalar.
+            %   with the specified content to MESSAGES. CONTENT must be a text scalar.
             %
             %   Example:
             %   % Create messages object
@@ -73,7 +73,7 @@
             %addFunctionMessage   Add function message.
             %
             %   MESSAGES = addFunctionMessage(MESSES, NAME, CONTENT) adds a function
-            %   message with the specified NAME and CONTENT. NAME and
+            %   message with the specified name and content. NAME and
             %   CONTENT must be text scalars.
             %
             %   Example:
@@ -145,7 +145,7 @@
             %removeMessage   Remove message.
             %
             %   MESSAGES = removeMessage(MESSAGES, IDX) removes a message at the specified
-            %   IDX from MESSAGES. IDX must be a positive integer.
+            %   index from MESSAGES. IDX must be a positive integer.
             %
             %   Example:
             %

Original file line number	Diff line number	Diff line change
`@@ -4,32 +4,32 @@`
`4`	`4`	`% CHAT = openAIChat(systemPrompt) creates an openAIChat object with the`
`5`	`5`	`% specified system prompt.`
`6`	`6`	`%`
`7`		`-% CHAT = openAIChat(systemPrompt, Name=Value) specifies additional options`
	`7`	`+% CHAT = openAIChat(systemPrompt,ApiKey=key) uses the specified API key`
	`8`	`+%`
	`9`	`+% CHAT = openAIChat(systemPrompt,Name=Value) specifies additional options`
`8`	`10`	`% using one or more name-value arguments:`
`9`	`11`	`%`
`10`		`-% 'Functions' - An array of openAIFunction objects representing`
	`12`	`+% Functions - Array of openAIFunction objects representing`
`11`	`13`	`% custom functions to be used during chat completions.`
`12`	`14`	`%`
`13`		`-% 'ModelName' - The name of the model to use for chat completions.`
	`15`	`+% ModelName - Name of the model to use for chat completions.`
`14`	`16`	`% The default value is "gpt-3.5-turbo".`
`15`	`17`	`%`
`16`		`-% 'Temperature' - The temperature value for controlling the randomness`
`17`		`-% of the output. The default value is 1.`
	`18`	`+% Temperature - Temperature value for controlling the randomness`
	`19`	`+% of the output. Default value is 1.`
`18`	`20`	`%`
`19`		`-% 'TopProbabilityMass' - The top probability mass value for controlling the`
`20`		`-% diversity of the output. The default value is 1.`
	`21`	`+% TopProbabilityMass - Top probability mass value for controlling the`
	`22`	`+% diversity of the output. Default value is 1.`
`21`	`23`	`%`
`22`		`-% 'StopSequences' - Vector of strings that when encountered, will`
`23`		`-% stop the generation of tokens. The default`
	`24`	`+% StopSequences - Vector of strings that when encountered, will`
	`25`	`+% stop the generation of tokens. Default`
`24`	`26`	`% value is empty.`
`25`	`27`	`%`
`26`		`-% 'ApiKey' - The API key for accessing the OpenAI Chat API.`
`27`		`-%`
`28`		`-% 'PresencePenalty' - The penalty value for using a token in the response`
`29`		`-% that has already been used. The default value is 0.`
	`28`	`+% PresencePenalty - Penalty value for using a token in the response`
	`29`	`+% that has already been used. Default value is 0.`
`30`	`30`	`%`
`31`		`-% 'FrequencyPenalty' - The penalty value for using a token that is frequent`
`32`		`-% in the training data. The default value is 0.`
	`31`	`+% FrequencyPenalty - Penalty value for using a token that is frequent`
	`32`	`+% in the training data. Default value is 0.`
`33`	`33`	`%`
`34`	`34`	`% openAIChat Functions:`
`35`	`35`	`% openAIChat - Chat completion API from OpenAI.`
`@@ -145,20 +145,19 @@`
`145`	`145`	`%generate Generate a response using the openAIChat instance.`
`146`	`146`	`%`
`147`	`147`	`% [TEXT, MESSAGE, RESPONSE] = generate(CHAT, MESSAGES) generates a response`
`148`		`- % with the specified MESSAGES and optional`
`149`		`- % name-value pair arguments.`
	`148`	`+ % with the specified MESSAGES.`
`150`	`149`	`%`
`151`	`150`	`% [TEXT, MESSAGE, RESPONSE] = generate(__, Name=Value) specifies additional options`
`152`	`151`	`% using one or more name-value arguments:`
`153`	`152`	`%`
`154`	`153`	`% NumCompletions - Number of completions to generate.`
`155`		`- % The default value is 1.`
	`154`	`+ % Default value is 1.`
`156`	`155`	`%`
`157`	`156`	`% MaxNumTokens - Maximum number of tokens in the generated response.`
`158`		`- % The default value is inf.`
	`157`	`+ % Default value is inf.`
`159`	`158`	`%`
`160`	`159`	`% FunctionCall - Function call to execute before generating the`
`161`		`- % response. The default value is empty.`
	`160`	`+ % response, specified as a string array. Default value is empty.`
`162`	`161`
`163`	`162`	`arguments`
`164`	`163`	`this (1,1) openAIChat`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`%addSystemMessage Add system message.`
`25`	`25`	`%`
`26`	`26`	`% MESSAGES = addSystemMessage(MESSAGES, NAME, CONTENT) adds a system`
`27`		`- % message with the specified NAME and CONTENT. NAME and CONTENT`
	`27`	`+ % message with the specified name and content. NAME and CONTENT`
`28`	`28`	`% must be text scalars.`
`29`	`29`	`%`
`30`	`30`	`% Example:`
`@@ -51,7 +51,7 @@`
`51`	`51`	`%addUserMessage Add user message.`
`52`	`52`	`%`
`53`	`53`	`% MESSAGES = addUserMessage(MESSAGES, CONTENT) adds a user message`
`54`		`- % with the specified CONTENT to MESSAGES. CONTENT must be a text scalar.`
	`54`	`+ % with the specified content to MESSAGES. CONTENT must be a text scalar.`
`55`	`55`	`%`
`56`	`56`	`% Example:`
`57`	`57`	`% % Create messages object`
`@@ -73,7 +73,7 @@`
`73`	`73`	`%addFunctionMessage Add function message.`
`74`	`74`	`%`
`75`	`75`	`% MESSAGES = addFunctionMessage(MESSES, NAME, CONTENT) adds a function`
`76`		`- % message with the specified NAME and CONTENT. NAME and`
	`76`	`+ % message with the specified name and content. NAME and`
`77`	`77`	`% CONTENT must be text scalars.`
`78`	`78`	`%`
`79`	`79`	`% Example:`
`@@ -145,7 +145,7 @@`
`145`	`145`	`%removeMessage Remove message.`
`146`	`146`	`%`
`147`	`147`	`% MESSAGES = removeMessage(MESSAGES, IDX) removes a message at the specified`
`148`		`- % IDX from MESSAGES. IDX must be a positive integer.`
	`148`	`+ % index from MESSAGES. IDX must be a positive integer.`
`149`	`149`	`%`
`150`	`150`	`% Example:`
`151`	`151`	`%`