Enhance docs #29
Merged
Enhance docs #29
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
MarcSkovMadsen
commented
Oct 7, 2023
| @@ -1,5 +1,5 @@ | |||
|
|
|||
| # Examples | |||
| # Panel Chat Examples | |||
There was a problem hiding this comment.
Renaming to Panel Chat Examples will keep the "Panel Chat Examples" when scrolling. This is much better than "Examples" if you want to copy-paste screen shots and share on social media.
MarcSkovMadsen
commented
Oct 7, 2023
| Note the default installation is not optimized for GPU usage. To enable GPU support for local | ||
| models (i.e. not OpenAI), install `ctransformers` with the proper backend and modify the | ||
| scripts configs' accordingly, e.g. `n_gpu_layers=1` for a single GPU. | ||
| !!! note |
There was a problem hiding this comment.
Add admonition. Looks better.
MarcSkovMadsen
commented
Oct 7, 2023
| @@ -1,18 +1,19 @@ | |||
| site_name: Panel Chat Examples | |||
| site_description: Example recipes for Panel ChatInterface. | |||
| site_description: Example recipes for Panel Chat Components | |||
There was a problem hiding this comment.
I think this site if for Panel Chats in general. Not just Panels ChatInterface components.
Codecov ReportAll modified lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #29 +/- ##
======================================
Coverage ? 0.00%
======================================
Files ? 1
Lines ? 3
Branches ? 0
======================================
Hits ? 0
Misses ? 3
Partials ? 0 ☔ View full report in Codecov by Sentry. |
ahuang11
approved these changes
Oct 8, 2023
ahuang11
approved these changes
Oct 8, 2023
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.
Builds on #26. Please review that one first.
This is an attempt to enhance the docs
Addresses #22 . Fully addressing this would require a custom css file. That can be done later.
Addresses #24 by fixing the most obvious Markdown style issues.
addresses #28 by putting docs instructions into seperate DEVELOPER_GUIDE.md file.