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

update root README with absolute path to fix https://pypi.org/project/llama-cookbook/ broken links #880

Merged
Merged
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
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
# Llama Cookbook: The Official Guide to building with Llama Models

Welcome to the official repository for helping you get started with [inference](./getting-started/inference/), [fine-tuning](./getting-started/finetuning) and [end-to-end use-cases](./end-to-end-use-cases) of building with the Llama Model family.
Welcome to the official repository for helping you get started with [inference](https://github.com/meta-llama/llama-cookbook/tree/main/getting-started/inference/), [fine-tuning](https://github.com/meta-llama/llama-cookbook/tree/main/getting-started/finetuning) and [end-to-end use-cases](https://github.com/meta-llama/llama-cookbook/tree/main/end-to-end-use-cases) of building with the Llama Model family.

This repository covers the most popular community approaches, use-cases and the latest recipes for Llama Text and Vision models.

> [!TIP]
> Popular getting started links:
> * [Build with Llama Tutorial](./getting-started/build_with_Llama_3_2.ipynb)
> * [Multimodal Inference with Llama 3.2 Vision](./getting-started/inference/local_inference/README.md#multimodal-inference)
> * [Inferencing using Llama Guard (Safety Model)](./getting-started/responsible_ai/llama_guard/)
> * [Build with Llama Tutorial](https://github.com/meta-llama/llama-cookbook/tree/main/getting-started/build_with_Llama_3_2.ipynb)
> * [Multimodal Inference with Llama 3.2 Vision](https://github.com/meta-llama/llama-cookbook/tree/main/getting-started/inference/local_inference/README.md#multimodal-inference)
> * [Inferencing using Llama Guard (Safety Model)](https://github.com/meta-llama/llama-cookbook/tree/main/getting-started/responsible_ai/llama_guard/)

> [!TIP]
> Popular end to end recipes:
> * [Email Agent](./end-to-end-use-cases/email_agent/)
> * [NotebookLlama](./end-to-end-use-cases/NotebookLlama/)
> * [Text to SQL](./end-to-end-use-cases/coding/text2sql/)
> * [Email Agent](https://github.com/meta-llama/llama-cookbook/tree/main/end-to-end-use-cases/email_agent/)
> * [NotebookLlama](https://github.com/meta-llama/llama-cookbook/tree/main/end-to-end-use-cases/NotebookLlama/)
> * [Text to SQL](https://github.com/meta-llama/llama-cookbook/tree/main/end-to-end-use-cases/coding/text2sql/)


> Note: We recently did a refactor of the repo, [archive-main](https://github.com/meta-llama/llama-cookbook/tree/archive-main) is a snapshot branch from before the refactor

## Repository Structure:

- [3P Integrations](./3p-integrations): Getting Started Recipes and End to End Use-Cases from various Llama providers
- [End to End Use Cases](./end-to-end-use-cases): As the name suggests, spanning various domains and applications
- [Getting Started](./getting-started/): Reference for inferencing, fine-tuning and RAG examples
- [src](./src/): Contains the src for the original llama-recipes library along with some FAQs for fine-tuning.
- [3P Integrations](https://github.com/meta-llama/llama-cookbook/tree/main/3p-integrations): Getting Started Recipes and End to End Use-Cases from various Llama providers
- [End to End Use Cases](https://github.com/meta-llama/llama-cookbook/tree/main/end-to-end-use-cases): As the name suggests, spanning various domains and applications
- [Getting Started](https://github.com/meta-llama/llama-cookbook/tree/main/getting-started/): Reference for inferencing, fine-tuning and RAG examples
- [src](https://github.com/meta-llama/llama-cookbook/tree/main/src/): Contains the src for the original llama-recipes library along with some FAQs for fine-tuning.

## FAQ:

Expand All @@ -40,7 +40,7 @@ More details on the prompt templates for image reasoning, tool-calling and code

- Q: I have some questions for Fine-Tuning, is there a section to address these?

A: Checkout the Fine-Tuning FAQ [here](./src/docs/)
A: Checkout the Fine-Tuning FAQ [here](https://github.com/meta-llama/llama-cookbook/tree/main/src/docs/)

- Q: Some links are broken/folders are missing:

Expand Down