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

[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

9. Automated Meeting Scheduler Description: Schedules meetings by checking participants' availability, sending invites, and managing calendar entries. Features: Tools: google_calendar, slack Step Types: Tool Call, Conditional Logic, Create Event, Send Invitation, Log
10. Email Categorization and Response Automation Description: Categorizes incoming emails, prioritizes them, and sends automated responses based on predefined templates. Features: Tools: sendgrid, slack Step Types: Receive Email, Evaluate, Categorize (Conditional Logic), Send Response, Log
11. E-commerce Order Processing Workflow Description: Automates the order processing system by handling order placements, inventory checks, payment processing, and shipment tracking. Features: Tools: finance, slack, sendgrid Step Types: Tool Call, Evaluate, Conditional Logic, Update Inventory (Set), Send Confirmation, Track Shipment
12. Content Moderation and Classification Description: Reviews user-generated content, classifies it based on predefined categories, and takes appropriate actions. Features: Tools: huggingface, wikipedia Step Types: Tool Call, Evaluate, Conditional Logic, Log, Take Action (Delete, Notify)
13. Personalized Learning Assistant Description: Provides personalized learning materials based on user progress, quizzes their knowledge, and tracks improvement. Features: Tools: wikipedia, slack Step Types: Tool Call, Evaluate, Conditional Logic, Create Quiz (Prompt), Track Progress (KV Storage), Loop
14. Automated Backup and Recovery System Description: Regularly backs up critical data, monitors backup status, and initiates recovery procedures in case of failures. Features: Tools: api_call, slack Step Types: Schedule (Sleep), Tool Call, Evaluate, Conditional Logic, Initiate Recovery
15. Smart Home Automation Workflow Description: Manages smart home devices by responding to user commands, monitoring environmental conditions, and adjusting settings accordingly. Features: Tools: slack, weather, dalle Step Types: Tool Call, Conditional Logic, Update Settings (Set), Loop, Log
16. Inventory Management and Reordering System Description: Tracks inventory levels, predicts shortages, and automatically places reorder requests when thresholds are met. Features: Tools: airtable, sendgrid, finance Step Types: Tool Call, Evaluate, Conditional Logic, Create Reorder (Set), Send Notification, Log

[PRIYANKjakharia]

i can work on this