mirror of
https://github.com/microsoft/autogen.git
synced 2025-08-11 02:01:10 +00:00
b4a2c6e26f
* Rewrite and consolidate configuration docs * add link to filtering * updates based on comments * update lockfile * update redirect * spelling mistake * update the noqa * update links * fix broken links * lint fixes * address comments * update wording about model selection * update cache_seed and json pattern * add periods * Update the config json func and other small changes * update wording of json string * update intro * update description of caching * fix link * spelling mistake * fix llm config * Update website/docs/llm_configuration.ipynb Co-authored-by: gagb <gagb@users.noreply.github.com> * Add examples back as notebook --------- Co-authored-by: gagb <gagb@users.noreply.github.com> Co-authored-by: Aaron <aaronlaptop12@hotmail.com>
59 lines
1.8 KiB
Markdown
59 lines
1.8 KiB
Markdown
# 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.
|
|
|
|
```markdown
|
|
<!--
|
|
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 `h1` header, - `#`
|
|
- 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`:
|
|
```bash
|
|
pip install pyautogen
|
|
```
|
|
|
|
For more information, please refer to the [installation guide](/docs/installation/).
|
|
|
|
\:\:\:
|
|
````
|
|
|
|
When specifying the config list, to ensure consistency it is best to use approximately the following code:
|
|
|
|
```python
|
|
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_configuration).
|
|
|
|
\:\:\:
|
|
```
|