From 51e2ccedf7dd6266bb597728c238436b3087f222 Mon Sep 17 00:00:00 2001 From: Devashish Tyagi Date: Tue, 16 Jan 2024 22:33:22 +0000 Subject: [PATCH] reorg directory to make examples top-level --- README.md | 3 +++ examples/README.md | 8 ++++++++ .../fireworks_functions_information_extraction.ipynb | 0 .../function_calling/fireworks_functions_qa.ipynb | 0 recipes/examples/README.md | 8 -------- 5 files changed, 11 insertions(+), 8 deletions(-) create mode 100644 examples/README.md rename {recipes/examples => examples}/function_calling/fireworks_functions_information_extraction.ipynb (100%) rename {recipes/examples => examples}/function_calling/fireworks_functions_qa.ipynb (100%) delete mode 100644 recipes/examples/README.md diff --git a/README.md b/README.md index 143ff6a..24151a2 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,9 @@ Recipes are categorized according to their respective use-cases. Here is the lis * [Inference with a LoRA adapter](https://github.com/fw-ai/cookbook/tree/main/recipes/generate/instruct_lora), * [Constrained output generation in json format](https://github.com/fw-ai/cookbook/tree/main/recipes/generate/jsonformer). +### Examples +In order to facilitate users to build GenAI applications using fireworks offerings, we present example applications. Please see documentation inside the directory for more info. + ## Example Workflow To illustrate how to leverage the recipes for an end-to-end usecase, lets walk through the process of fine tuning a model, inspecting the results visually, and deploying the model to the Fireworks platform for inference. The instructions assume that the source code of the cookbook was checked out under `/workspace/cookbook`. diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..ac74144 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,8 @@ +# Fireworks Cookbook + +This directory contains example applications built using fireworks offerings. Examples utilizing each major feature is organized into it's own folder. For official documentation of all the features & functionality please see [documentation page](https://readme.fireworks.ai/docs/quickstart). + +Notebook | Description +:- | :- +[function_calling/fireworks_functions_information_extraction.ipynb](https://github.com/fw-ai/cookbook/tree/master/examples/function_calling/fireworks_functions_information_extraction.ipynb) | Build an application that extracts structured information from given url. The demo uses Fireworks function calling model. +[function_calling/fireworks_functions_qa.ipynb](https://github.com/fw-ai/cookbook/tree/master/examples/function_calling/fireworks_functions_information_extraction.ipynb) | Build an application that will answer questions from an unstructured text provided by the user. It can cite sources from which the answer was obtained. diff --git a/recipes/examples/function_calling/fireworks_functions_information_extraction.ipynb b/examples/function_calling/fireworks_functions_information_extraction.ipynb similarity index 100% rename from recipes/examples/function_calling/fireworks_functions_information_extraction.ipynb rename to examples/function_calling/fireworks_functions_information_extraction.ipynb diff --git a/recipes/examples/function_calling/fireworks_functions_qa.ipynb b/examples/function_calling/fireworks_functions_qa.ipynb similarity index 100% rename from recipes/examples/function_calling/fireworks_functions_qa.ipynb rename to examples/function_calling/fireworks_functions_qa.ipynb diff --git a/recipes/examples/README.md b/recipes/examples/README.md deleted file mode 100644 index 4116945..0000000 --- a/recipes/examples/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Fireworks Cookbook - -This directory contains example applications built using fireworks offerings. Examples utilizing each major feature is organized into it's own folder. For official documentation of all the features & functionality please see [documentation page](https://readme.fireworks.ai/docs/quickstart). - -Notebook | Description -:- | :- -[function_calling/fireworks_functions_information_extraction.ipynb](https://github.com/fw-ai/cookbook/tree/master/recipes/examples/function_calling/fireworks_functions_information_extraction.ipynb) | Build an application that extracts structured information from given url. The demo uses Fireworks function calling model. -[function_calling/fireworks_functions_qa.ipynb](https://github.com/fw-ai/cookbook/tree/master/recipes/examples/function_calling/fireworks_functions_information_extraction.ipynb) | Build an application that will answer questions from an unstructured text provided by the user. It can cite sources from which the answer was obtained.