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

[ijindal1]

trafficstars

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

33. Smart Content Filtering and Recommendation Description: Filters content based on user preferences and recommends personalized content. Features: Tools: web_search, huggingface Step Types: Tool Call, Evaluate, Conditional Logic, Set Recommendations (Set), Log
34. Automated Translation and Localization Workflow Description: Translates content into multiple languages, localizes it based on regional settings, and publishes it. Features: Tools: huggingface, sendgrid Step Types: Tool Call, Evaluate, Conditional Logic, Translate Content (Prompt), Send Translations, Log
35. AI-Driven Survey Analysis and Reporting Description: Collects survey responses, analyzes sentiment and trends, and generates comprehensive reports. Features: Tools: sendgrid, huggingface Step Types: Tool Call, Evaluate, Conditional Logic, Generate Report (Prompt), Send Reports, Log
36. Automated Compliance Documentation Generator Description: Generates compliance documents based on input data and ensures they meet regulatory standards. Features: Tools: wikipedia, api_call Step Types: Tool Call, Evaluate, Conditional Logic, Generate Document (Prompt), Log, Return
37. Intelligent Task Prioritization and Allocation Description: Prioritizes tasks based on urgency and importance, allocates them to appropriate team members, and tracks progress. Features: Tools: slack, google_calendar Step Types: Tool Call, Evaluate, Conditional Logic, Assign Tasks (Set), Send Notifications, Log
38. Automated Webinar Feedback Collection and Analysis Description: Collects feedback from webinar participants, analyzes sentiments, and generates improvement reports. Features: Tools: sendgrid, huggingface Step Types: Tool Call, Evaluate, Conditional Logic, Generate Report (Prompt), Send Feedback Summary, Log
39. Personalized Health and Fitness Tracker Description: Tracks user health metrics, provides personalized fitness recommendations, and sends progress updates. Features: Tools: slack, sendgrid, weather Step Types: Tool Call, Evaluate, Conditional Logic, Set Goals (Set), Send Updates, Log
40. Automated Incident Response System Description: Detects incidents, categorizes them, initiates response workflows, and notifies relevant personnel. Features: Tools: api_call, slack, sendgrid Step Types: Tool Call, Evaluate, Conditional Logic, Initiate Response (Set), Send Notifications, Log