Skip to content

Commit 2750399

Browse files
committed
Updating README.
1 parent 6c92010 commit 2750399

File tree

1 file changed

+32
-22
lines changed

1 file changed

+32
-22
lines changed

README.md

+32-22
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,35 @@ The functionality shown here serves as an interface to the ChatGPT and DALL·E A
66

77
Some of the current LLMs supported are:
88
- gpt-3.5-turbo, gpt-3.5-turbo-1106
9-
- gpt-4, gpt-4-1106-preview
9+
- gpt-4, gpt-4-turbo, gpt-4-1106-preview
1010
- gpt-4-vision-preview (a.k.a. GPT-4 Turbo with Vision)
1111
- dall-e-2, dall-e-3
1212

1313
For details on the specification of each model, check the official [OpenAI documentation](https://platform.openai.com/docs/models).
1414

15+
## Requirements
16+
17+
### MathWorks Products (https://www.mathworks.com)
18+
19+
- Requires MATLAB release R2024a or newer.
20+
- Some examples require Text Analytics Toolbox™.
21+
22+
### 3rd Party Products:
23+
24+
- An active OpenAI API subscription and API key.
25+
1526
## Setup
1627

17-
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)
28+
### MATLAB Online
29+
30+
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)
31+
1832

19-
If you would like to use it with MATLAB Desktop, proceed with the following steps:
33+
### MATLAB Desktop
2034

21-
1. Clone the repository to your local machine.
35+
To use this repository with a local installation of MATLAB, first clone the repository.
36+
37+
1. In the system command prompt, run:
2238

2339
```bash
2440
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
3248
addpath('path/to/llms-with-matlab');
3349
```
3450

35-
4. Set up your OpenAI API key. Create a `.env` file in the project root directory with the following content.
51+
### Setting up your API key
52+
53+
Set up your OpenAI API key. Create a `.env` file in the project root directory with the following content.
3654

3755
```
3856
OPENAI_API_KEY=<your key>
@@ -44,15 +62,6 @@ If you would like to use it with MATLAB Desktop, proceed with the following step
4462
loadenv(".env")
4563
```
4664

47-
### MathWorks Products (https://www.mathworks.com)
48-
49-
- Requires MATLAB release R2023a or newer.
50-
51-
### 3rd Party Products:
52-
53-
- An active OpenAI API subscription and API key.
54-
55-
5665
## Getting Started with Chat Completion API
5766

5867
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})
320329
## Examples
321330
To learn how to use this in your workflows, see [Examples](/examples/).
322331
323-
- [ExampleStreaming.mlx](/examples/ExampleStreaming.mlx): Learn to implement a simple chat that stream the response.
324-
- [ExampleSummarization.mlx](/examples/ExampleSummarization.mlx): Learn to create concise summaries of long texts with ChatGPT. (Requires Text Analytics Toolbox™)
325-
- [ExampleChatBot.mlx](/examples/ExampleChatBot.mlx): Build a conversational chatbot capable of handling various dialogue scenarios using ChatGPT. (Requires Text Analytics Toolbox)
326-
- [ExampleFunctionCalling.mlx](/examples/ExampleFunctionCalling.mlx): Learn how to create agents capable of executing MATLAB functions.
332+
- [ProcessGeneratedTextinRealTimebyUsingChatGPTinStreamingMode.mlx](/examples/ProcessGeneratedTextinRealTimebyUsingChatGPTinStreamingMode.mlx): Learn to implement a simple chat that stream the response.
333+
- [SummarizeLargeDocumentsUsingChatGPTandMATLAB.mlx](/examples/SummarizeLargeDocumentsUsingChatGPTandMATLAB.mlx): Learn to create concise summaries of long texts with ChatGPT. (Requires Text Analytics Toolbox™)
334+
- [CreateSimpleChatBot.mlx](/examples/CreateSimpleChatBot.mlx): Build a conversational chatbot capable of handling various dialogue scenarios using ChatGPT. (Requires Text Analytics Toolbox)
335+
- [AnalyzeScientificPapersUsingFunctionCalls.mlx](/examples/AnalyzeScientificPapersUsingFunctionCalls.mlx): Learn how to create agents capable of executing MATLAB functions.
327336
- [ExampleParallelFunctionCalls.mlx](/examples/ExampleParallelFunctionCalls.mlx): Learn how to take advantage of parallel function calling.
328-
- [ExampleRetrievalAugmentedGeneration.mlx](/examples/ExampleRetrievalAugmentedGeneration.mlx): Learn about retrieval augmented generation with a simple use case. (Requires Text Analytics Toolbox™)
329-
- [ExampleGPT4Vision.mlx](/examples/ExampleGPT4Vision.mlx): Learn how to use GPT-4 Turbo with Vision to understand the content of an image.
330-
- [ExampleJSONMode.mlx](/examples/ExampleJSONMode.mlx): Learn how to use JSON mode in chat completions
331-
- [ExampleDALLE.mlx](/examples/ExampleDALLE.mlx): Learn how to generate images, create variations and edit the images.
337+
- [RetrievalAugmentedGenerationUsingChatGPTandMATLAB.mlx](/examples/RetrievalAugmentedGenerationUsingChatGPTandMATLAB.mlx): Learn about retrieval augmented generation with a simple use case. (Requires Text Analytics Toolbox™)
338+
- [DescribeImagesUsingChatGPT.mlx](/examples/DescribeImagesUsingChatGPT.mlx): Learn how to use GPT-4 Turbo with Vision to understand the content of an image.
339+
- [AnalyzeSentimentinTextUsingChatGPTinJSONMode.mlx](/examples/AnalyzeSentimentinTextUsingChatGPTinJSONMode.mlx): Learn how to use JSON mode in chat completions
340+
- [UsingDALLEToEditImages.mlx](/examples/UsingDALLEToEditImages.mlx): Learn how to generate images
341+
- [UsingDALLEToGenerateImages.mlx](/examples/UsingDALLEToGenerateImages.mlx): Create variations of images and editimages.
332342
333343
## License
334344

0 commit comments

Comments
 (0)