Rewrite and consolidate configuration docs #1581
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1581 +/- ##
=======================================
Coverage 37.70% 37.70%
=======================================
Files 50 50
Lines 5683 5683
Branches 1289 1289
=======================================
Hits 2143 2143
Misses 3372 3372
Partials 168 168
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
gagb
reviewed
Feb 7, 2024
gagb
reviewed
Feb 7, 2024
gagb
reviewed
Feb 7, 2024
gagb
reviewed
Feb 7, 2024
Co-authored-by: gagb <gagb@users.noreply.github.com>
gagb
approved these changes
Feb 8, 2024
AaronWard
suggested changes
Feb 8, 2024
AaronWard
approved these changes
Feb 11, 2024
whiskyboy
pushed a commit
to whiskyboy/autogen
that referenced
this pull request
Apr 17, 2024
* 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>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
I believe the documentation surrounding configuration was confusing, so I had a go at consolidating and hopefully making things clearer.
If you want to view the rendered docs in PDF format (printed by browser) then you can view the below:
LLM Configuration _ AutoGen.pdf
Additionally this adds support for redirects which I think is important to prevent broken links as we continue to work on the documentation.
Related issue number
Closes #797
Checks