Skip to content

Commit

Permalink
doc: Added Readme for cookbooks and updated the Colab links (#550)
Browse files Browse the repository at this point in the history
<!-- ELLIPSIS_HIDDEN -->



> [!IMPORTANT]
> Add `README.md` to `cookbooks` with Jupyter notebook overview and
Colab links.
> 
>   - **Documentation**:
>     - Adds `README.md` to `cookbooks` directory.
>     - Provides an overview of Jupyter notebooks for AI tasks.
> - Includes Colab links for each notebook:
`01-Website_Crawler_using_Spider.ipynb`,
`02-Sarcastic_News_Headline_Generator.ipynb`,
`03-SmartResearcher_With_WebSearch.ipynb`,
`04-TripPlanner_With_Weather_And_WikiInfo.ipynb`.
>     - Contact information and contribution guidelines included.
> 
> <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 a1ad58e. It will automatically
update as commits are pushed.</sup>

<!-- ELLIPSIS_HIDDEN -->

---------

Signed-off-by: Diwank Singh Tomer <[email protected]>
Co-authored-by: Diwank Singh Tomer <[email protected]>
  • Loading branch information
Vedantsahai18 and creatorrr authored Oct 2, 2024
1 parent e97ca4e commit 9c38645
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 5 deletions.
4 changes: 2 additions & 2 deletions cookbooks/01-Website_Crawler_using_Spider.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"### Implementation\n",
"## Implementation\n",
"\n",
"To recreate the notebook and see the code implementation for this task, you can access the Google Colab notebook using the link below:\n",
"\n",
"<a target=\"_blank\" href=\"https://colab.research.google.com/github/julep-ai/julep/blob/f/dev/cookbooks/01_Cookbook.ipynb\">\n",
"<a target=\"_blank\" href=\"https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/01-Website_Crawler_using_Spider.ipynb\">\n",
" <img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/>\n",
"</a>\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion cookbooks/02-Sarcastic_News_Headline_Generator.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
"\n",
"To recreate the notebook and see the code implementation for this task, you can access the Google Colab notebook using the link below:\n",
"\n",
"<a target=\"_blank\" href=\"https://colab.research.google.com/github/julep-ai/julep/blob/f/dev/cookbooks/02-Sarcastic_News_Headline_Generator.ipynb\">\n",
"<a target=\"_blank\" href=\"https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/02-Sarcastic_News_Headline_Generator.ipynb\">\n",
" <img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/>\n",
"</a>\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion cookbooks/03-SmartResearcher_With_WebSearch.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
"\n",
"To recreate the notebook and see the code implementation for this task, you can access the Google Colab notebook using the link below:\n",
"\n",
"<a target=\"_blank\" href=\"https://colab.research.google.com/github/julep-ai/julep/blob/f/dev/cookbooks/03-SmartResearcher_With_WebSearch.ipynb\">\n",
"<a target=\"_blank\" href=\"https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/03-SmartResearcher_With_WebSearch.ipynb\">\n",
" <img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/>\n",
"</a>\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion cookbooks/04-TripPlanner_With_Weather_And_WikiInfo.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
"\n",
"To recreate the notebook and see the code implementation for this task, you can access the Google Colab notebook using the link below:\n",
"\n",
"<a target=\"_blank\" href=\"https://colab.research.google.com/github/julep-ai/julep/blob/f/dev/cookbooks/04_04-TripPlanner_With_Weather_And_WikiInfo.ipynb\">\n",
"<a target=\"_blank\" href=\"https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/04-TripPlanner_With_Weather_And_WikiInfo.ipynb\">\n",
" <img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/>\n",
"</a>\n",
"\n",
Expand Down
29 changes: 29 additions & 0 deletions cookbooks/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<div align="center">
<img src="https://socialify.git.ci/julep-ai/julep/image?description=1&descriptionEditable=Build%20AI%20agents%20and%20workflows%20with%20a%20simple%20API&font=Source%20Code%20Pro&logo=https%3A%2F%2Fraw.githubusercontent.com%2Fjulep-ai%2Fjulep%2Fdev%2F.github%2Fjulep-logo.svg&owner=1&pattern=Solid&stargazers=1&theme=Auto" alt="julep" width="640" height="320" />
</div>

# Julep AI - Notebook Overview

Welcome to the **Julep AI Notebook Collection**! This directory contains a set of Jupyter notebooks designed for a variety of AI and automation tasks.

Each notebook explores a unique use case, ranging from web crawling to running complex workflows using AI Agents.

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** |
|------------------------------------------------- |---------------------------------------------------------------------------- |--------------------------------------------------------------------|
| `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. |
| `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. |
| `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. |
| `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. |

### Additional Information

For more details about the task or if you have any questions, please don't hesitate to contact the author:

**Author:** Julep AI
**Contact:** [[email protected]](mailto:[email protected]) or <a href="https://discord.com/invite/JTSBGRZrzj" rel="dofollow">Discord</a>

---

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 9c38645

Please sign in to comment.