38d03b0e63
* Initial infrasctructure for notebooks page * migrate two notebooks * add readme notification for notebook dir * override 'text' prism language to add basic syntactical structure to autogens output * Rework to retain existing directory and not expose front matter to consumers of the notebook * improve error handling of process notebooks * format, ruff and type fixes * undo changes to navbar * update readme, CI * whitespace * spelling mistakes * spelling * Add contributing guide for notebooks * update notebook * formatting
1.8 KiB
Contributing
How to get a notebook displayed on the website
Ensure the first cell is markdown and before absolutely anything else include the following yaml within a comment.
<!--
tags: ["code generation", "debugging"]
description: |
Use conversable language learning model agents to solve tasks and provide automatic feedback through a comprehensive example of writing, executing, and debugging Python code to compare stock price changes.
-->
The tags field is a list of tags that will be used to categorize the notebook. The description field is a brief description of the notebook.
Best practices for authoring notebooks
The following points are best practices for authoring notebooks to ensure consistency and ease of use for the website.
- The Colab button will be automatically generated on the website for all notebooks where it is missing. Going forward, it is recommended to not include the Colab button in the notebook itself.
- Ensure the header is a
h1header, -# - Don't put anything between the yaml and the header
Consistency for installation and LLM config
You don't need to explain in depth how to install AutoGen. Unless there are specific instructions for the notebook just use the following markdown snippet:
::info Requirements
Install pyautogen:
pip install pyautogen
For more information, please refer to the installation guide.
:::
When specifying the config list, to ensure consistency it is best to use approximately the following code:
config_list = autogen.config_list_from_json(
env_or_file="OAI_CONFIG_LIST",
)
Then after the code cell where this is used, include the following markdown snippet:
\:\:\:tip
Learn more about the various ways to configure LLM endpoints [here](/docs/llm_endpoint_configuration).
\:\:\: