Skip to content

Commit

Permalink
update cookbooks readme (#861)
Browse files Browse the repository at this point in the history 
<!-- ELLIPSIS_HIDDEN -->



> [!IMPORTANT]
> Update `cookbooks/README.md` to add new notebooks and remove outdated
ones, with updated descriptions and links.
> 
>   - **Notebook Updates**:
> - Added `00-Devfest-Email-Assistant.ipynb`,
`04-Hook_Generator_Trending_Reels.ipynb`,
`05-Video_Processing_With_Natural_Language.ipynb`,
`06-Browser_Use.ipynb`.
> - Removed `03-SmartResearcher_With_WebSearch.ipynb`,
`04-TripPlanner_With_Weather_And_WikiInfo.ipynb`,
`05-Basic_Agent_Creation_and_Interaction.ipynb`,
`06-Designing_Multi-Step_Tasks.ipynb`,
`07-Integrating_External_Tools_and_APIs.ipynb`,
`08-Managing_Persistent_Sessions.ipynb`,
`09-User_Management_and_Personalization.ipynb`,
`10-Document_Management_and_Search.ipynb`,
`11-Advanced_Chat_Interactions.ipynb`,
`12-Monitoring_Task_Executions.ipynb`,
`13-Error_Handling_and_Recovery.ipynb`.
>   - **Misc**:
>     - Fixed table formatting in `cookbooks/README.md`.
>     - Removed trailing newline in `cookbooks/README.md`.
> 
> <sup>This description was created by </sup>[<img alt="Ellipsis"
src="https://img.shields.io/badge/Ellipsis-blue?color=175173">](https://www.ellipsis.dev?ref=julep-ai%2Fjulep&utm_source=github&utm_medium=referral)<sup>
for 5ec16c4. It will automatically
update as commits are pushed.</sup>

<!-- ELLIPSIS_HIDDEN -->
  • Loading branch information
@Vedantsahai18
Vedantsahai18 authored Nov 22, 2024
1 parent 3485a32 commit 7ba8fd3
Showing 1 changed file with 11 additions and 16 deletions.
27 changes: 11 additions & 16 deletions cookbooks/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,16 @@ Welcome to the **Julep AI Notebook Collection**! This directory contains a set o

Each notebook explores a unique use case, demonstrating different aspects of Julep's capabilities. Below is a quick overview of the notebooks, their purpose, and a link to run each of them on Google Colab.

| **Notebook Name** | **Colab Link** | **Description** | **Implemented** |
|------------------------------------------------- |---------------------------------------------------------------------------- |--------------------------------------------------------------------|-----------------|
| `01-Website_Crawler_using_Spider.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/01-Website_Crawler_using_Spider.ipynb) | Implements a web crawler using a spider to extract website content. | Yes |
| `02-Sarcastic_News_Headline_Generator.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/02-Sarcastic_News_Headline_Generator.ipynb) | Generates sarcastic news headlines using a Brave Search Tool. | Yes |
| `03-SmartResearcher_With_WebSearch.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/03-SmartResearcher_With_WebSearch.ipynb) | Searches and aggregates web information for research purposes using Brave Search. | Yes |
| `04-TripPlanner_With_Weather_And_WikiInfo.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/04-TripPlanner_With_Weather_And_WikiInfo.ipynb) | Plans trips using weather data and Wikipedia information. | Yes |
| `05-Basic_Agent_Creation_and_Interaction.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/05-Basic_Agent_Creation_and_Interaction.ipynb) | Demonstrates how to create a basic agent and interact with it. | No |
| `06-Designing_Multi-Step_Tasks.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/06-Designing_Multi-Step_Tasks.ipynb) | Explores creating tasks with various step types. | No |
| `07-Integrating_External_Tools_and_APIs.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/07-Integrating_External_Tools_and_APIs.ipynb) | Shows how to integrate and use external tools and APIs. | No |
| `08-Managing_Persistent_Sessions.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/08-Managing_Persistent_Sessions.ipynb) | Covers creating and managing persistent sessions with context. | No |
| `09-User_Management_and_Personalization.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/09-User_Management_and_Personalization.ipynb) | Demonstrates user management and personalized interactions. | No |
| `10-Document_Management_and_Search.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/10-Document_Management_and_Search.ipynb) | Explores document upload, management, and search capabilities. | No |
| `11-Advanced_Chat_Interactions.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/11-Advanced_Chat_Interactions.ipynb) | Covers advanced chat features and context handling. | No |
| `12-Monitoring_Task_Executions.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/12-Monitoring_Task_Executions.ipynb) | Shows how to monitor and manage task executions. | No |
| `13-Error_Handling_and_Recovery.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/13-Error_Handling_and_Recovery.ipynb) | Demonstrates implementing error handling and recovery in tasks. | No |
| **Notebook Name** | **Colab Link** | **Description** | **Implemented** |
|------------------ |--------------- |----------------- |----------------- |
| `00-Devfest-Email-Assistant.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/00-Devfest-Email-Assistant.ipynb) | Email assistant for managing DevFest communications | Yes |
| `01-Website_Crawler_using_Spider.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/01-Website_Crawler_using_Spider.ipynb) | Implements a web crawler using a spider to extract website content | Yes |
| `02-Sarcastic_News_Headline_Generator.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/02-Sarcastic_News_Headline_Generator.ipynb) | Generates sarcastic news headlines using a Brave Search Tool | Yes |
| `03-Trip_Planning_Assistant.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/03-Trip_Planning_Assistant.ipynb) | Plans trips using weather data and location information | Yes |
| `04-Hook_Generator_Trending_Reels.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/04-Hook_Generator_Trending_Reels.ipynb) | Generates engaging hooks for trending social media reels | Yes |
| `05-Video_Processing_With_Natural_Language.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/05-Video_Processing_With_Natural_Language.ipynb) | Processes videos using natural language commands | Yes |
| `06-Browser_Use.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/06-Browser_Use.ipynb) | Demonstrates browser automation capabilities | Yes |


## Potential Cookbooks for Contributors

Expand Down Expand Up @@ -147,4 +142,4 @@ For more details about the tasks or if you have any questions, please don't hesi

---

If you have feedback or would like to contribute to the notebooks, feel free to open an issue(s) in the [repository](https://github.com/julep-ai/julep).
If you have feedback or would like to contribute to the notebooks, feel free to open an issue(s) in the [repository](https://github.com/julep-ai/julep).

0 comments on commit 7ba8fd3

Please sign in to comment.