Skip to content

Commit

Permalink
Updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
debymf committed Nov 14, 2023
1 parent a0f599b commit f774734
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,16 @@ 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. You can either:
- Pass it directly to the `openAIChat` class, using the nvp `ApiKey`
- Or set it as an environment variable using [`setenv`](https://www.mathworks.com/help/matlab/ref/setenv.html) or [`loadenv`](https://www.mathworks.com/help/matlab/ref/loadenv.html):
```matlab
setenv("OPENAI_API_KEY","your key here")
4. Set up your OpenAI API key. Create a `.env` file in the project root directory with the following content.

```
or
OPENAI_API_KEY=<your key>
```

Then load your `.env` file as follows:

```matlab
loadenv(filename)
loadenv(".env")
```

### MathWorks Products (https://www.mathworks.com)
Expand Down Expand Up @@ -240,6 +241,7 @@ To learn how to use this in your workflows, see [Examples](/examples/).
- [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.
- [ExampleRetrievalAugmentedGeneration.mlx](/examples/ExampleRetrievalAugmentedGeneration.mlx): Learn about retrieval augmented generation with a simple use case. (Requires Text Analytics Toolbox™)

## License

Expand Down

0 comments on commit f774734

Please sign in to comment.