Skip to content

Commit

Permalink
Python: Update document generator demo README (#10386)
Browse files Browse the repository at this point in the history
### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->
`AICodeSandbox` has updated their package name. A user also reached out
about whether it is possible to use models for the demo.

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->
1. Update the Document Generator demo README to reflect this change.
2. Update the README to include a note about using other models.

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄

Co-authored-by: Evan Mattson <[email protected]>
  • Loading branch information
TaoChenOSU and moonbox3 authored Feb 4, 2025
1 parent f8592ad commit 0b2bd01
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion python/samples/demos/document_generator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ To learn more about the Semantic Kernel Agent Framework, please refer to the [Se
- `AICodeSandbox` - for executing AI generated code in a sandbox environment

```bash
pip install AICodeSandbox
pip install ai-code-sandbox
```

> You must also have `docker` installed and running on your machine. Follow the instructions [here](https://docs.docker.com/get-started/introduction/get-docker-desktop/) to install docker for your platform. Images will be pulled during runtime if not already present. Containers will be created and destroyed during code execution.
Expand All @@ -54,6 +54,7 @@ OPENAI_API_KEY=<your-key>
```

> gpt-4o-2024-08-06 was used to generate [GENERATED_DOCUMENT.md](GENERATED_DOCUMENT.md).
> Feel free to use other models from OpenAI or other providers. When you use models from another provider, make sure to update the chat completion services accordingly.

```env
Expand Down

0 comments on commit 0b2bd01

Please sign in to comment.