mirror of
https://github.com/openai/openai-cookbook
synced 2024-11-11 13:11:02 +00:00
31 lines
2.3 KiB
Markdown
31 lines
2.3 KiB
Markdown
<a href="https://cookbook.openai.com" target="_blank">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="/images/openai-cookbook-white.png" style="max-width: 100%; width: 400px; margin-bottom: 20px">
|
|
<img alt="OpenAI Cookbook Logo" src="/images/openai-cookbook.png" width="400px">
|
|
</picture>
|
|
</a>
|
|
|
|
<h3></h3>
|
|
|
|
> ✨ Navigate at [cookbook.openai.com](https://cookbook.openai.com)
|
|
|
|
Example code and guides for accomplishing common tasks with the [OpenAI API](https://platform.openai.com/docs/introduction). To run these examples, you'll need an OpenAI account and associated API key ([create a free account here](https://beta.openai.com/signup)). Set an environment variable called `OPENAI_API_KEY` with your API key. Alternatively, in most IDEs such as Visual Studio Code, you can create an `.env` file at the root of your repo containing `OPENAI_API_KEY=<your API key>`, which will be picked up by the notebooks.
|
|
|
|
Most code examples are written in Python, though the concepts can be applied in any language.
|
|
|
|
For other useful tools, guides and courses, check out these [related resources from around the web](https://cookbook.openai.com/related_resources).
|
|
|
|
## Contributing
|
|
|
|
The OpenAI Cookbook is a community-driven resource. Whether you're submitting an idea, fixing a typo, adding a new guide, or improving an existing one, your contributions are greatly appreciated!
|
|
|
|
Before contributing, read through the existing issues and pull requests to see if someone else is already working on something similar. That way you can avoid duplicating efforts.
|
|
|
|
If there are examples or guides you'd like to see, feel free to suggest them on the [issues page](https://github.com/openai/openai-cookbook/issues).
|
|
|
|
If you'd like to contribute new content, make sure to read through our [contribution guidelines](/CONTRIBUTING.md). We welcome high-quality submissions of new examples and guides, as long as they meet our criteria and fit within the scope of the cookbook.
|
|
|
|
The contents of this repo are automatically rendered into [cookbook.openai.com](https://cookbook.openai.com) based on [registry.yaml](/registry.yaml).
|
|
|
|
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=468576060&machine=basicLinux32gb&location=EastUs)
|