Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

reorg directory to make examples top-level #52

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
8 changes: 8 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -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.
8 changes: 0 additions & 8 deletions recipes/examples/README.md

This file was deleted.