From 27503999762cb37b80db4a085a02ef361b257f4b Mon Sep 17 00:00:00 2001 From: Deborah Ferreira Date: Sun, 14 Apr 2024 09:29:08 +0100 Subject: [PATCH] Updating README. --- README.md | 54 ++++++++++++++++++++++++++++++++---------------------- 1 file changed, 32 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index b1fdcf9..25978ba 100644 --- a/README.md +++ b/README.md @@ -6,19 +6,35 @@ The functionality shown here serves as an interface to the ChatGPT and DALL·E A Some of the current LLMs supported are: - gpt-3.5-turbo, gpt-3.5-turbo-1106 -- gpt-4, gpt-4-1106-preview +- gpt-4, gpt-4-turbo, gpt-4-1106-preview - gpt-4-vision-preview (a.k.a. GPT-4 Turbo with Vision) - dall-e-2, dall-e-3 For details on the specification of each model, check the official [OpenAI documentation](https://platform.openai.com/docs/models). +## Requirements + +### MathWorks Products (https://www.mathworks.com) + +- Requires MATLAB release R2024a or newer. +- Some examples require Text Analytics Toolbox™. + +### 3rd Party Products: + +- An active OpenAI API subscription and API key. + ## 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) +### MATLAB Online + +To use this repository with MATLAB Online, 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: +### MATLAB Desktop -1. Clone the repository to your local machine. +To use this repository with a local installation of MATLAB, first clone the repository. + +1. In the system command prompt, run: ```bash git clone https://github.com/matlab-deep-learning/llms-with-matlab.git @@ -32,7 +48,9 @@ If you would like to use it with MATLAB Desktop, proceed with the following step addpath('path/to/llms-with-matlab'); ``` -4. Set up your OpenAI API key. Create a `.env` file in the project root directory with the following content. +### Setting up your API key + +Set up your OpenAI API key. Create a `.env` file in the project root directory with the following content. ``` OPENAI_API_KEY= @@ -44,15 +62,6 @@ If you would like to use it with MATLAB Desktop, proceed with the following step loadenv(".env") ``` -### MathWorks Products (https://www.mathworks.com) - -- Requires MATLAB release R2023a or newer. - -### 3rd Party Products: - -- An active OpenAI API subscription and API key. - - ## Getting Started with Chat Completion API To get started, you can either create an `openAIChat` object and use its methods or use it in a more complex setup, as needed. @@ -320,15 +329,16 @@ imshow(images{1}) ## Examples To learn how to use this in your workflows, see [Examples](/examples/). -- [ExampleStreaming.mlx](/examples/ExampleStreaming.mlx): Learn to implement a simple chat that stream the response. -- [ExampleSummarization.mlx](/examples/ExampleSummarization.mlx): Learn to create concise summaries of long texts with ChatGPT. (Requires Text Analytics Toolbox™) -- [ExampleChatBot.mlx](/examples/ExampleChatBot.mlx): Build a conversational chatbot capable of handling various dialogue scenarios using ChatGPT. (Requires Text Analytics Toolbox) -- [ExampleFunctionCalling.mlx](/examples/ExampleFunctionCalling.mlx): Learn how to create agents capable of executing MATLAB functions. +- [ProcessGeneratedTextinRealTimebyUsingChatGPTinStreamingMode.mlx](/examples/ProcessGeneratedTextinRealTimebyUsingChatGPTinStreamingMode.mlx): Learn to implement a simple chat that stream the response. +- [SummarizeLargeDocumentsUsingChatGPTandMATLAB.mlx](/examples/SummarizeLargeDocumentsUsingChatGPTandMATLAB.mlx): Learn to create concise summaries of long texts with ChatGPT. (Requires Text Analytics Toolbox™) +- [CreateSimpleChatBot.mlx](/examples/CreateSimpleChatBot.mlx): Build a conversational chatbot capable of handling various dialogue scenarios using ChatGPT. (Requires Text Analytics Toolbox) +- [AnalyzeScientificPapersUsingFunctionCalls.mlx](/examples/AnalyzeScientificPapersUsingFunctionCalls.mlx): Learn how to create agents capable of executing MATLAB functions. - [ExampleParallelFunctionCalls.mlx](/examples/ExampleParallelFunctionCalls.mlx): Learn how to take advantage of parallel function calling. -- [ExampleRetrievalAugmentedGeneration.mlx](/examples/ExampleRetrievalAugmentedGeneration.mlx): Learn about retrieval augmented generation with a simple use case. (Requires Text Analytics Toolbox™) -- [ExampleGPT4Vision.mlx](/examples/ExampleGPT4Vision.mlx): Learn how to use GPT-4 Turbo with Vision to understand the content of an image. -- [ExampleJSONMode.mlx](/examples/ExampleJSONMode.mlx): Learn how to use JSON mode in chat completions -- [ExampleDALLE.mlx](/examples/ExampleDALLE.mlx): Learn how to generate images, create variations and edit the images. +- [RetrievalAugmentedGenerationUsingChatGPTandMATLAB.mlx](/examples/RetrievalAugmentedGenerationUsingChatGPTandMATLAB.mlx): Learn about retrieval augmented generation with a simple use case. (Requires Text Analytics Toolbox™) +- [DescribeImagesUsingChatGPT.mlx](/examples/DescribeImagesUsingChatGPT.mlx): Learn how to use GPT-4 Turbo with Vision to understand the content of an image. +- [AnalyzeSentimentinTextUsingChatGPTinJSONMode.mlx](/examples/AnalyzeSentimentinTextUsingChatGPTinJSONMode.mlx): Learn how to use JSON mode in chat completions +- [UsingDALLEToEditImages.mlx](/examples/UsingDALLEToEditImages.mlx): Learn how to generate images +- [UsingDALLEToGenerateImages.mlx](/examples/UsingDALLEToGenerateImages.mlx): Create variations of images and editimages. ## License