Skip to content

Commit

Permalink
Add ToC
Browse files Browse the repository at this point in the history
  • Loading branch information
svilupp committed Nov 7, 2023
1 parent fb441c9 commit cb91381
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,32 @@ Pro tip: Use `asyncmap` to run multiple AI-powered tasks concurrently.

Pro tip: If you use slow models (like GPT-4), you can use async version of `@ai_str` -> `@aai_str` to avoid blocking the REPL, eg, `aai"Say hi but slowly!"gpt4`

## Table of Contents

- [PromptingTools.jl: "Your Daily Dose of AI Efficiency."](#promptingtoolsjl-your-daily-dose-of-ai-efficiency)
- [Quick Start with `@ai_str` and Easy Templating](#quick-start-with-ai_str-and-easy-templating)
- [Table of Contents](#table-of-contents)
- [Why PromptingTools.jl](#why-promptingtoolsjl)
- [Advanced Examples](#advanced-examples)
- [Advanced Prompts / Conversations](#advanced-prompts--conversations)
- [Asynchronous Execution](#asynchronous-execution)
- [Model Aliases](#model-aliases)
- [Embeddings](#embeddings)
- [Classification](#classification)
- [Data Extraction](#data-extraction)
- [More Examples](#more-examples)
- [Package Interface](#package-interface)
- [Frequently Asked Questions](#frequently-asked-questions)
- [Why OpenAI](#why-openai)
- [Data Privacy and OpenAI](#data-privacy-and-openai)
- [Creating OpenAI API Key](#creating-openai-api-key)
- [Setting OpenAI Spending Limits](#setting-openai-spending-limits)
- [How much does it cost? Is it worth paying for?](#how-much-does-it-cost-is-it-worth-paying-for)
- [Configuring the Environment Variable for API Key](#configuring-the-environment-variable-for-api-key)
- [Understanding the API Keyword Arguments in `aigenerate` (`api_kwargs`)](#understanding-the-api-keyword-arguments-in-aigenerate-api_kwargs)
- [Instant Access from Anywhere](#instant-access-from-anywhere)
- [Roadmap](#roadmap)

## Why PromptingTools.jl

Prompt engineering is neither fast nor easy. Moreover, different models and their fine-tunes might require different prompt formats and tricks, or perhaps the information you work with requires special models to be used. PromptingTools.jl is meant to unify the prompts for different backends and make the common tasks (like templated prompts) as simple as possible.
Expand Down

0 comments on commit cb91381

Please sign in to comment.