[Good First Issue]: Replicate Existing Cookbooks and Create New Examples - Batch 1

[ijindal1]

For context, see: CONTRIBUTING.md and cookbooks/README.md

Overview

We're looking for contributors to help expand our collection of Jupyter notebooks (cookbooks) that demonstrate various AI and automation tasks using Julep's features. This is a great opportunity for newcomers to get familiar with Julep and contribute to the project!

Objectives

1. Replicate existing cookbooks to ensure they're up-to-date and functioning correctly.
2. Create new cookbooks based on the ideas listed in the cookbooks/README.md file.

Tasks

1. Replicating Existing Cookbooks

• Choose one or more of the existing cookbooks from the list in cookbooks/README.md.
• Follow the instructions in the notebook to run it in Google Colab.
• Verify that all cells execute without errors and produce the expected outputs.
• If you encounter any issues or outdated information, document them for updating.

2. Creating New Cookbooks

• Select an idea from the "Potential Cookbooks for Contributors" section in cookbooks/README.md.
• Create a new Jupyter notebook following the structure of existing cookbooks.
• Implement the chosen use case using Julep's features.
• Ensure your notebook includes:
  • A clear introduction and overview of the task
  • Step-by-step implementation with explanations
  • Proper error handling and user guidance
  • A conclusion summarizing the key learnings

Guidelines for Creating New Cookbooks

1. Naming Convention: Name your notebook following the pattern XX-Descriptive_Name.ipynb, where XX is the next available number in the sequence.

2. Structure:

   • Start with an introduction explaining the purpose of the cookbook.
   • Include a cell for installing the Julep client.
   • Create sections for each major step (e.g., Creating an Agent, Defining a Task, Creating an Execution).
   • Add markdown cells to explain concepts and code.

3. Code Quality:

   • Ensure your code is well-commented and follows PEP 8 style guidelines.
   • Use meaningful variable names.
   • Handle potential errors gracefully.

4. Documentation:

   • Explain each step clearly, assuming the reader is new to Julep.
   • Include links to relevant Julep documentation where appropriate.

5. Testing:

   • Test your notebook thoroughly in Google Colab to ensure it runs without errors.
   • Include sample outputs where relevant.

6. Update README.md:

   • Add your new cookbook to the table in cookbooks/README.md.
   • Include a brief description and mark it as implemented.

How to Contribute

1. Fork the repository.
2. Create a new branch for your cookbook (e.g., cookbook/weather-notification-service).
3. Develop your cookbook following the guidelines above.
4. Test your notebook thoroughly.
5. Commit your changes and push to your fork.
6. Open a pull request with a clear description of your contribution.

Resources

• Julep Documentation
• Existing Cookbooks
• CONTRIBUTING.md

Need Help?

If you have any questions or need assistance, please don't hesitate to ask in the comments of this issue or reach out on our Discord channel.

We're excited to see your contributions and help grow the Julep cookbook collection!

---

Long-ass list of ideas

1. Automated Research Assistant Description: An agent that conducts research on a given topic by searching the web, summarizing findings, and storing results for future reference. Features: Tools: web_search, wikipedia Step Types: Prompt, Tool Call, Evaluate, Set, Get, Return
2. Customer Support Chatbot with Sentiment Analysis Description: A chatbot that interacts with users, analyzes their sentiment, and routes complex issues to human agents. Features: Tools: slack, huggingface Step Types: Chat, Tool Call, Evaluate, Conditional Logic (If-Else), Log
3. Daily News Aggregator and Summarizer Description: Collects news articles daily, categorizes them, summarizes key points, and emails summaries to subscribers. Features: Tools: news, sendgrid Step Types: Tool Call, Loop (Foreach), Prompt, Send Email, Schedule (Sleep)
4. Social Media Monitoring and Alert System Description: Monitors specified social media platforms for keywords, analyzes trends, and sends alerts based on predefined criteria. Features: Tools: twitter, slack Step Types: Tool Call, Evaluate, Conditional Logic, Send Alert, Loop
5. Weather-Based Notification Service Description: Checks the weather forecast daily and notifies users about severe weather conditions in their area. Features: Tools: weather, sendgrid Step Types: Tool Call, Conditional Logic, Send Email, Schedule (Sleep)
6. Automated Financial Report Generator Description: Gathers financial data from various sources, generates reports, and updates stakeholders. Features: Tools: finance, google_calendar Step Types: Tool Call, Evaluate, Generate Report (Prompt), Schedule (Sleep), Send Reports
7. Task Management and Reminder System Description: Manages user tasks by adding new tasks, setting reminders, and sending notifications when deadlines approach. Features: Tools: google_calendar, slack Step Types: Create Task, Set Reminder (Schedule), Send Notification, Loop, Conditional Logic
8. Interactive Story Generator with Image Integration Description: Generates interactive stories based on user input and creates corresponding images for each chapter. Features: Tools: huggingface, dalle Step Types: Prompt, Tool Call, Loop (Foreach), Generate Image, Return

[PRIYANKjakharia]

i can work on this

[naaa760]

Hello @ijindal1 :) I want to work on this issue, please assign me.

[JanumalaAkhilendra]

I would like to work on this issue. please assign it to me.

[CGaneshKumar2002]

Hi @ijindal1 I would like to work on the issue #5 Weather-Based Notification Service Description: Checks the weather forecast daily and notifies users about severe weather conditions in their area. Features: Tools: weather, sendgrid Step Types: Tool Call, Conditional Logic, Send Email, Schedule (Sleep)

[AMANCHAUBEY8822]

Hi my name is aman i want to work on it

[ijindal1]

Hi @naaa760 @JanumalaAkhilendra @AMANCHAUBEY8822 - which issue # would you like to work on from this list?

[ijindal1]

Hi @ijindal1 I would like to work on the issue #5 Weather-Based Notification Service Description: Checks the weather forecast daily and notifies users about severe weather conditions in their area. Features: Tools: weather, sendgrid Step Types: Tool Call, Conditional Logic, Send Email, Schedule (Sleep)

https://github.com/julep-ai/julep/issues/609

I will assign you to this issue @CGaneshKumar2002

[JanumalaAkhilendra]

Task Management and Reminder System Description: Manages user tasks by adding new tasks, setting reminders, and sending notifications when deadlines approach. Features: Tools: google_calendar, slack Step Types: Create Task, Set Reminder (Schedule), Send Notification, Loop, Conditional Logic

I want to work on this

[ijindal1]

Guys, just comment what issue you want to work on, and there is no need for us to assign it to you. We'll merge it after you finish working on it.

[naaa760]

@ijindal1 where is the list of issues?