mirror of
https://github.com/zylon-ai/private-gpt.git
synced 2025-12-22 20:12:55 +01:00
docs: add recipes and summarize doc
This commit is contained in:
parent
88ffbc8299
commit
98408b59bb
3 changed files with 55 additions and 0 deletions
|
|
@ -74,6 +74,16 @@ navigation:
|
||||||
path: ./docs/pages/ui/gradio.mdx
|
path: ./docs/pages/ui/gradio.mdx
|
||||||
- page: Alternatives
|
- page: Alternatives
|
||||||
path: ./docs/pages/ui/alternatives.mdx
|
path: ./docs/pages/ui/alternatives.mdx
|
||||||
|
- tab: recipes
|
||||||
|
layout:
|
||||||
|
- section: Getting started
|
||||||
|
contents:
|
||||||
|
- page: Quickstart
|
||||||
|
path: ./docs/pages/recipes/quickstart.mdx
|
||||||
|
- section: General use cases
|
||||||
|
contents:
|
||||||
|
- page: Summarize
|
||||||
|
path: ./docs/pages/recipes/summarize.mdx
|
||||||
# Small code snippet or example of usage to help users
|
# Small code snippet or example of usage to help users
|
||||||
- tab: tested-combinations
|
- tab: tested-combinations
|
||||||
layout:
|
layout:
|
||||||
|
|
|
||||||
23
fern/docs/pages/recipes/quickstart.mdx
Normal file
23
fern/docs/pages/recipes/quickstart.mdx
Normal file
|
|
@ -0,0 +1,23 @@
|
||||||
|
# Recipes
|
||||||
|
|
||||||
|
Recipes are predefined use cases that help users solve very specific tasks using PrivateGPT.
|
||||||
|
They provide a streamlined approach to achieve common goals with the platform, offering both a starting point and inspiration for further exploration.
|
||||||
|
The main goal of Recipes is to empower the community to create and share solutions, expanding the capabilities of PrivateGPT.
|
||||||
|
|
||||||
|
## How to Create a New Recipe
|
||||||
|
|
||||||
|
1. **Identify the Task**: Define a specific task or problem that the Recipe will address.
|
||||||
|
2. **Develop the Solution**: Create a clear and concise guide, including any necessary code snippets or configurations.
|
||||||
|
3. **Submit a PR**: Fork the PrivateGPT repository, add your Recipe to the appropriate section, and submit a PR for review.
|
||||||
|
|
||||||
|
We encourage you to be creative and think outside the box! Your contributions help shape the future of PrivateGPT.
|
||||||
|
|
||||||
|
## Available Recipes
|
||||||
|
|
||||||
|
<Cards>
|
||||||
|
<Card
|
||||||
|
title="Summarize"
|
||||||
|
icon="fa-solid fa-file-alt"
|
||||||
|
href="/recipes/general-use-cases/summarize"
|
||||||
|
/>
|
||||||
|
</Cards>
|
||||||
22
fern/docs/pages/recipes/summarize.mdx
Normal file
22
fern/docs/pages/recipes/summarize.mdx
Normal file
|
|
@ -0,0 +1,22 @@
|
||||||
|
# Summarize
|
||||||
|
|
||||||
|
The Summarize Recipe provides a method to extract concise summaries from ingested documents or texts using PrivateGPT.
|
||||||
|
This tool is particularly useful for quickly understanding large volumes of information by distilling key points and main ideas.
|
||||||
|
|
||||||
|
## Use Case
|
||||||
|
|
||||||
|
The primary use case for the `Summarize` tool is to automate the summarization of lengthy documents,
|
||||||
|
making it easier for users to grasp the essential information without reading through entire texts.
|
||||||
|
This can be applied in various scenarios, such as summarizing research papers, news articles, or business reports.
|
||||||
|
|
||||||
|
## Key Features
|
||||||
|
|
||||||
|
1. **Ingestion-compatible**: The user provides the text to be summarized. The text can be directly inputted or retrieved from ingested documents within the system.
|
||||||
|
2. **Customization**: The summary generation can be influenced by providing specific `instructions` or a `prompt`. These inputs guide the model on how to frame the summary, allowing for customization according to user needs.
|
||||||
|
3. **Streaming Support**: The tool supports streaming, allowing for real-time summary generation, which can be particularly useful for handling large texts or providing immediate feedback.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
If you have ideas for improving the Summarize or want to add new features, feel free to contribute!
|
||||||
|
You can submit your enhancements via a pull request on our [GitHub repository](https://github.com/zylon-ai/private-gpt).
|
||||||
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue