Skip to content

Commit

Permalink
Small README changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Daethyra committed Oct 12, 2023
1 parent 0a2d0d8 commit e787961
Showing 1 changed file with 9 additions and 14 deletions.
23 changes: 9 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,18 @@ Provides an automated pipeline for retrieving embeddings from [OpenAIs `text-emb

B. **[Prompts](./OpenAI/Prompts/)**

There are three main prompt types, [multi-shot](./OpenAI/GPT-Prompt-Examples/multi-shot), [system-role](./OpenAI/GPT-Prompt-Examples/system-role), [user-role](./OpenAI/GPT-Prompt-Examples/user-role).
There are three main prompt types, [multi-shot](./OpenAI/Prompts/multi-shot), [system-role](./OpenAI/Prompts/system-role), [user-role](./OpenAI/Prompts/user-role).

Please also see the [OUT-prompt-cheatsheet](./OpenAI/GPT-Prompt-Examples/OUT-prompt-cheatsheet.md).
Please also see the [OUT-prompt-cheatsheet](./OpenAI/Prompts/OUT-prompt-cheatsheet.md).

- **[Cheatsheet](./OpenAI/GPT-Prompt-Examples/prompt-cheatsheet.md)**: @Daethyra's go-to prompts.
- **[Cheatsheet](./OpenAI/Prompts/prompt-cheatsheet.md)**: @Daethyra's go-to prompts.

- **[multi-shot](./OpenAI/GPT-Prompt-Examples/multi-shot)**: Prompts, with prompts inside them.
- **[multi-shot](./OpenAI/Prompts/multi-shot)**: Prompts, with prompts inside them.
It's kind of like a bundle of Matryoshka prompts!

- **[system-role](./OpenAI/GPT-Prompt-Examples/system-role)**: Steer your LLM by shifting the ground it stands on.
- **[system-role](./OpenAI/Prompts/system-role)**: Steer your LLM by shifting the ground it stands on.

- **[user-role](./OpenAI/GPT-Prompt-Examples/user-role)**: Markdown files for user-role prompts.
- **[user-role](./OpenAI/Prompts/user-role)**: Markdown files for user-role prompts.

---

Expand All @@ -48,9 +48,7 @@ This module offers a set of functionalities for conversational agents in LangCha
- Text splitting using `RecursiveCharacterTextSplitter`
- Various embeddings options like `OpenAIEmbeddings`, `CacheBackedEmbeddings`, and `HuggingFaceEmbeddings`

**Potential Use Cases:**

${MASK}
**Potential Use Cases:** For developing conversational agents with advanced features.

---

Expand All @@ -64,9 +62,7 @@ This module focuses on querying local documents and employs the following featur
- Vector storage options like `Chroma`
- Embedding options via `OpenAIEmbeddings`

**Potential Use Cases:**

${MASK}
**Potential Use Cases:** For querying large sets of documents efficiently.

---

Expand All @@ -86,8 +82,7 @@ This module focuses on generating captions for images using Hugging Face's trans
- Caption caching for improved efficiency
- Device selection (CPU or GPU) based on availability

**Potential Use Cases:**
${MASK}
**Potential Use Cases:** For generating accurate and context-appropriate image captions.

---

Expand Down

0 comments on commit e787961

Please sign in to comment.