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

[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

73. AI-Powered Personal Shopping Assistant Description: Helps users find products based on preferences, compares prices, and notifies about deals. Features: Tools: web_search, finance, sendgrid Step Types: Tool Call, Evaluate, Conditional Logic, Compare Prices (Evaluate), Send Deals, Log
74. Automated Environmental Monitoring and Reporting Description: Monitors environmental data, detects anomalies, and generates reports for stakeholders. Features: Tools: weather, api_call, sendgrid Step Types: Tool Call, Evaluate, Conditional Logic, Generate Report (Prompt), Send Reports, Log
75. Intelligent Appointment Booking and Management Description: Automates the process of booking appointments, managing schedules, and sending reminders. Features: Tools: google_calendar, sendgrid, slack Step Types: Tool Call, Evaluate, Conditional Logic, Create Appointment (Set), Send Reminders, Log
76. Automated Data Sync and Integration Workflow Description: Syncs data between different platforms, ensures data consistency, and handles conflicts. Features: Tools: api_call, airtable, slack Step Types: Tool Call, Evaluate, Conditional Logic, Sync Data (Set), Handle Conflicts, Log
77. AI-Driven Competitive Pricing Strategy Description: Analyzes competitor pricing, adjusts prices dynamically, and notifies sales teams of changes. Features: Tools: finance, web_search, sendgrid Step Types: Tool Call, Evaluate, Conditional Logic, Adjust Prices (Set), Send Notifications, Log
78. Intelligent Document Translation and Distribution Description: Translates documents into multiple languages, ensures accuracy, and distributes them to relevant parties. Features: Tools: huggingface, sendgrid Step Types: Tool Call, Evaluate, Conditional Logic, Translate Documents (Prompt), Send Translations, Log
79. Automated User Onboarding Workflow Description: Manages the user onboarding process by collecting information, setting up accounts, and sending welcome emails. Features: Tools: sendgrid, slack Step Types: Tool Call, Evaluate, Conditional Logic, Create Account (Set), Send Welcome Email, Log
80. AI-Powered Content Curation and Distribution Description: Curates relevant content based on user interests, schedules distribution, and tracks engagement metrics. Features: Tools: web_search, sendgrid, slack Step Types: Tool Call, Evaluate, Conditional Logic, Curate Content (Set), Schedule Distribution, Send Content, Log

[prathamesh424]

@ijindal1 can you assign this issue to me

[ijindal1]

@PRIYANKjakharia @prathamesh424

• Can you please specify which idea you want to work on?

I can create a separate issue and assign to you guys.

[logan-e-dutton]

Can I be assigned to create a cookbook for the Automated Research Assistant Example?