From 8d5d2770d73d291a8058e1954b510675c33741c1 Mon Sep 17 00:00:00 2001 From: Massimiliano Pippi Date: Wed, 30 Oct 2024 10:27:01 +0100 Subject: [PATCH] cookbooks -> cookbook --- README.md | 10 +++++----- .../Prompt_Caching_with_Anthropic.ipynb | 2 +- {cookbooks => cookbook}/Prompt_Versioning.ipynb | 2 +- {cookbooks => cookbook}/in_prompt_completion.ipynb | 2 +- docs/index.md | 8 ++++---- pyproject.toml | 2 +- 6 files changed, 13 insertions(+), 13 deletions(-) rename {cookbooks => cookbook}/Prompt_Caching_with_Anthropic.ipynb (98%) rename {cookbooks => cookbook}/Prompt_Versioning.ipynb (98%) rename {cookbooks => cookbook}/in_prompt_completion.ipynb (98%) diff --git a/README.md b/README.md index 50324a8..3ccb114 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ Docs are available [here](https://masci.github.io/banks/). - [banks](#banks) - [Installation](#installation) - [Features](#features) - - [Cookbooks](#cookbooks) + - [Cookbook](#cookbook) - [Examples](#examples) - [:point\_right: Render a prompt template as chat messages](#point_right-render-a-prompt-template-as-chat-messages) - [:point\_right: Use a LLM to generate a text while rendering a prompt](#point_right-use-a-llm-to-generate-a-text-while-rendering-a-prompt) @@ -50,11 +50,11 @@ lifecycle: first-class citizen. - :file_cabinet: **Management**: Banks provides ways to store prompts on disk along with their metadata. -## Cookbooks +## Cookbook -- :blue_book: [In-prompt chat completion](https://github.com/masci/banks/blob/main/cookbooks/in_prompt_completion.ipynb) -- :blue_book: [Prompt caching with Anthropic](./cookbooks/Prompt_Caching_with_Anthropic.ipynb) -- :blue_book: [Prompt versioning](./cookbooks/Prompt_Versioning.ipynb) +- :blue_book: [In-prompt chat completion](./cookbook/in_prompt_completion.ipynb) +- :blue_book: [Prompt caching with Anthropic](./cookbook/Prompt_Caching_with_Anthropic.ipynb) +- :blue_book: [Prompt versioning](./cookbook/Prompt_Versioning.ipynb) ## Examples diff --git a/cookbooks/Prompt_Caching_with_Anthropic.ipynb b/cookbook/Prompt_Caching_with_Anthropic.ipynb similarity index 98% rename from cookbooks/Prompt_Caching_with_Anthropic.ipynb rename to cookbook/Prompt_Caching_with_Anthropic.ipynb index 674ae55..779ba8b 100644 --- a/cookbooks/Prompt_Caching_with_Anthropic.ipynb +++ b/cookbook/Prompt_Caching_with_Anthropic.ipynb @@ -8,7 +8,7 @@ "source": [ "# Use banks to cache prompts with Anthropic API\n", "\n", - "\n", + "\n", " \"Open\n", "\n", "\n", diff --git a/cookbooks/Prompt_Versioning.ipynb b/cookbook/Prompt_Versioning.ipynb similarity index 98% rename from cookbooks/Prompt_Versioning.ipynb rename to cookbook/Prompt_Versioning.ipynb index c6d4fd9..06798bb 100644 --- a/cookbooks/Prompt_Versioning.ipynb +++ b/cookbook/Prompt_Versioning.ipynb @@ -6,7 +6,7 @@ "source": [ "# Prompt versioning\n", "\n", - "\n", + "\n", " \"Open\n", "\n", "\n", diff --git a/cookbooks/in_prompt_completion.ipynb b/cookbook/in_prompt_completion.ipynb similarity index 98% rename from cookbooks/in_prompt_completion.ipynb rename to cookbook/in_prompt_completion.ipynb index 9c5e442..4b0d63d 100644 --- a/cookbooks/in_prompt_completion.ipynb +++ b/cookbook/in_prompt_completion.ipynb @@ -8,7 +8,7 @@ "source": [ "# In-prompt chat completion\n", "\n", - "\n", + "\n", " \"Open\n", "\n", "\n", diff --git a/docs/index.md b/docs/index.md index 22e83d1..26d884e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -48,10 +48,10 @@ Some functionalities require additional dependencies that need to be installed m If you like to jump straight to the code: - See a showcase of basic examples [here](examples.md). -- Check out the Cookbooks: - - :blue_book: [In-prompt chat completion](https://github.com/masci/banks/blob/main/cookbooks/in_prompt_completion.ipynb) - - :blue_book: [Prompt caching with Anthropic](https://github.com/masci/banks/blob/main/cookbooks/Prompt_Caching_with_Anthropic.ipynb) - - :blue_book: [Prompt versioning](https://github.com/masci/banks/blob/main/cookbooks/Prompt_Versioning.ipynb) +- Check out the Cookbook: + - :blue_book: [In-prompt chat completion](https://github.com/masci/banks/blob/main/cookbook/in_prompt_completion.ipynb) + - :blue_book: [Prompt caching with Anthropic](https://github.com/masci/banks/blob/main/cookbook/Prompt_Caching_with_Anthropic.ipynb) + - :blue_book: [Prompt versioning](https://github.com/masci/banks/blob/main/cookbook/Prompt_Versioning.ipynb) ## License diff --git a/pyproject.toml b/pyproject.toml index cca1ce3..5341974 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -79,7 +79,7 @@ only-include = ["src/banks", "src/templates"] [tool.ruff] target-version = "py39" line-length = 120 -exclude = ["cookbooks"] +exclude = ["cookbook"] [tool.ruff.lint] select = [ "A",